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:

  1. Make sure you have Dart SDK installed on your machine and Flutter.
  2. Once you have the dependencies installed use the next command: dart pub global activate xcream to install the CLI tool
  3. 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
  4. Or you can overwrite the ~/.bashrc file with a file editor and add the previous command.
  5. After editing the ~/.bashrc file use source ~/.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.