ignite-cli

Simple CLI interface for Ignite; scaffold and setup your Flame projects with ease.

Usage

Install it via pub (or build from src if you prefer the latest version):

flutter pub global activate ignite_cli

After you have added the bin folder to your path (the previous command will tell you what to add), you can create a new project with Ignite, just run:

ignite create

And follow the instructions (this is called interactive mode - you might need a compatible shell for the interactive pickers to work).

Alternatively, you can set --interactive=false and manually specify all required options (error messages will be your friend):

ignite create --interactive=false --name=my_flame_game --org=org.flame-engine.example --create-folder=true --template=example

Instructions for contributors

Run:

./scripts/test.sh

To run all tests. Always make sure the build is green.

You will need to install the bash testing framework bats.

In order to run the application locally, use:

dart bin/ignite_cli.dart

Managing Templates

This project uses package:mason to manage and generate templates (bricks).

All supported bricks can be found in the bricks directory.

Whenever a new brick is added or an existing brick is modified, make sure to regenerate the corresponding bundles via:

./scripts/build.sh

Credits

This project was created with Dart Stagehand and uses Mason for templating.