by amasiye313@gmail.com

Sendama CLI is a console application that provides a command line interface for the Sendama 2D Game Engine. It is used to create, build, run and manage Sendama projects.

For the current editor manual, see Editor.md.

For the modular guide set, see docs/guides/README.md.

• PHP 8.3 or newer
• WSL (For Windows)
• Composer 2.7.1 or later
• Sendama 2D Game Engine

To install Sendama CLI, run the following command in your terminal:

composer global require sendamaphp/console

If you haven't already, add Composer's system-wide vendor bin directory to your $PATH. This directory is at ~/.composer/vendor/bin or ~/.config/composer/vendor/bin.

export PATH="$PATH:$HOME/.composer/vendor/bin"

Alternatively, you can link the sendama executable to a directory that is already in your $PATH. For example, you can link it to /usr/local/bin:

sudo ln -s ~/.composer/vendor/bin/sendama /usr/local/bin/sendama

or

sudo ln -s ~/.config/composer/vendor/bin/sendama /usr/local/bin/sendama

Then, you can run the sendama command in your terminal.

sendama --help

From the WSL terminal follow Linux instructions

From the OSX terminal follow Linux instructions

sendama [command] [options] [arguments]

• --help or -h displays help for the command
• --quiet or -q suppresses output
• --verbose or -v|vv|vvv increases output verbosity
• --version or -V displays the application version
• --ansi or -a forces ANSI output
• --no-ansi or -A disables ANSI output
• --no-interaction or -n disables interaction

Dump shell completion code for the specified shell (bash, fish, zsh, or PowerShell).

sendama completion

Displays help for a command

sendama help

Lists commands

sendama list

Create a new Sendama project

sendama new:game mygame

or

sendama new mygame

• name is the name of the project
• directory is the path to the project directory

sendama generate:scene myscene

sendama generate:prefab enemy

sendama generate:prefab score-label --kind=label

sendama generate:texture mytexture

sendama generate:texture mytexture --width=32 --height=32