sendamaphp/console

A simple CLI for creating and managing sendama-engine projects.

Maintainers

Details

github.com/atatusoft-ltd/sendama-console

Source

Issues

Installs: 16

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

0.1.15 2024-05-29 18:29 UTC

Requires

Requires (Dev)

MIT 75f836b559ef0dbfd7d551eb8e07c8527ee24c0a

  • Andrew Masiye <amasiye313.woop@gmail.com>

This package is auto-updated.

Last update: 2024-12-16 09:01:59 UTC

README

by amasiye313@gmail.com

What is it?

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.

Screenshot

Requirements

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

Installation

For Linux, BSD etc

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

For Windows

From the WSL terminal follow Linux instructions

OSX

From the OSX terminal follow Linux instructions

Usage

sendama [command] [options] [arguments]

Options

  • --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

Available Commands

Completion

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

sendama completion

Help

Displays help for a command

sendama help

List

Lists commands

sendama list

Create a new project

Create a new Sendama project

sendama new:game mygame

or

sendama new mygame

Arguments

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

Generate a new scene

sendama generate:scene myscene

Generate a new texture

sendama generate:texture mytexture

Generate a new texture with a specific size

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