Reference

CLI Commands

The Sendama CLI is the main entrypoint for creating, editing, generating, and running projects.

Core Commands

Command Aliases Purpose
sendama new:game <name> sendama new <name> Create a new Sendama project
sendama edit sendama e, sendama edit:game Open the editor for a project
sendama play sendama p Run the game runtime
sendama view:log none View project logs
sendama update none Update the Sendama CLI/tooling

Generator Commands

Command Aliases Purpose
sendama generate:scene <name> none Create a new scene file
sendama generate:prefab <name> none Create a new prefab file
sendama generate:script <name> none Create a new script class
sendama generate:event <name> none Create a new event class
sendama generate:texture <name> none Create a new texture asset
sendama generate:tilemap <name> sendama generate:map <name>, sendama g:map <name> Create a new tile map
sendama generate:tileset <name> none Create a new tileset asset
sendama generate:splash-screen <name> sendama g:splash <name>, sendama splash <name> Create a splash screen asset

Common Usage Patterns

Create A New Project

sendama new:game my-game
cd my-game
composer install

Open The Editor

sendama edit

Or:

sendama edit --directory /path/to/project

Run The Game

sendama play

Or:

sendama play --directory /path/to/project

Generate Content

sendama generate:scene level01
sendama generate:prefab player-bullet
sendama generate:script player-controller
sendama generate:texture player
sendama generate:tilemap level01

Notes

  • The editor can call generator commands for you from the Assets panel.
  • new:game creates the standard project structure, including asset folders and common bootstrap files.
  • play uses the project's configured main entry file from sendama.json.