init-gba
v0.0.2
Published
A CLI that makes bootstrapping a GBA game with butano a breeze
Readme
init-gba
A CLI that bootstraps a GBA game project with Butano.
Important
This has only been tested on macOS. Windows and Linux support is not guaranteed, but contributions to make it work on those platforms are welcome.
Why
Setting up a GBA project with Butano involves cloning repos, wiring up Makefiles, setting paths, and renaming template files. This tool does all of that in one command.
Install
npm install -g init-gbaUsage
init-gba create
Creates a new GBA project from a Butano template.
init-gba createThis will interactively ask you for a project name, directory, Butano path, and other options.
Non-interactive
init-gba create --name my-game --non-interactiveFlags
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| --name, -n | string | | Game name |
| --dir | string | ./<name> | Target directory for the project |
| --butano-path | string | ~/Documents/butano | Butano installation path |
| --butano-repo | string | https://github.com/GValiente/butano.git | Butano git repository URL |
| --template-path | string | <butano-path>/template | Path to the template folder |
| --template-token | string | template | Template token to replace in files |
| --rom-title | string | derived from name | ROM title (uppercase, max 12 chars) |
| --rom-code | string | derived from name | ROM code (4 uppercase characters) |
| --force | boolean | false | Overwrite target directory if it exists |
| --non-interactive | boolean | false | Fail if required input is missing |
| --yes, -y | boolean | false | Accept defaults and skip prompts |
| --skip-deps | boolean | false | Skip devkitPro dependency checks |
| --skip-git | boolean | false | Skip git init |
| --skip-makefile | boolean | false | Skip Makefile generation |
| --skip-update | boolean | false | Skip checking for Butano updates |
Examples
Create a project with defaults in the current directory:
init-gba create --name my-game --yesSpecify a custom Butano path and skip dependency checks:
init-gba create --name my-game --butano-path ~/butano --skip-depsSet ROM metadata directly:
init-gba create --name my-game --rom-title "COOL GAME" --rom-code COOL --non-interactiveinit-gba doctor
Checks your environment for common Butano/devkitPro issues.
init-gba doctor