xcream CLI
Description
The xcream CLI is a command-line tool built in Dart that allows you to create a basic structure to develop games for the xcream library.
Installation
To install the xcream CLI, follow these steps:
- Make sure you have Dart SDK installed on your machine and Flutter.
- Once you have the dependencies installed use the next command:
dart pub global activate xcream
to install the CLI tool - If you have a warning message or cannot execute the CLI tool use the next command
export PATH="$PATH":"$HOME/.pub-cache/bin"
before using the tool - Or you can overwrite the
~/.bashrc
file with a file editor and add the previous command. - After editing the
~/.bashrc
file usesource ~/.bashrc
to apply the changes and you will be able to use the CLI tool globally.
Usage
The xcream CLI provides the following commands:
xcream create -t empty -n <project_name>
: Generates an empty project structure.xcream create -t template -n <project_name>
: Generates a project structure based on a specific template.
To scaffold a new project, open your terminal and navigate to the desired directory. Then, run one of the above commands to generate the project structure.
Libraries
- cli/cli
- cli/empty_template
- cli/example_project
- cli/image_downloader/image_downloader
- cli/project_creator
- cli/project_type
- cli/templates/base_template/base_config_file
- cli/templates/base_template/base_game_file
- cli/templates/base_template/components_files
- cli/templates/base_template/src_files_creator
- cli/templates/base_template/widgets_files
- cli/templates/empty_template/base_config_file
- cli/templates/empty_template/base_game_file
- cli/templates/empty_template/components_files
- cli/templates/empty_template/src_files_creator
- cli/templates/empty_template/widgets_files
- cli/templates/folders_creator
- cli/templates/main_file_creator
- cli/templates/profile_creator
- cli/templates/test_file_creator