mini_arcade.modules.game_scaffold.commands

CLI command for scaffolding a new Mini Arcade game project.

Classes

ScaffoldGameCommand

Base class for all commands.

Module Contents

class mini_arcade.modules.game_scaffold.commands.ScaffoldGameCommand[source]

Bases: mini_arcade.cli.base_command.BaseCommand

Base class for all commands.

Registration is done via the implementation decorator:

@CommandRegistry.implementation(“build”) class Build(BaseCommand): …

or:

from .command_registry import CommandRegistry @CommandRegistry.implementation(“build”) class Build(BaseCommand): …

Subclasses should implement the execute(…) method as the main entrypoint.

Variables:

  • name – Optional[str]: Command name (for registry); defaults to class name lowercased.

  • aliases – Tuple[str, …]: Optional command aliases.

  • summary – Optional[str]: Short description of the command.

  • epilog – Optional[str]: Additional help text for the command.

  • args – Optional[List[ArgumentType]]: List of command arguments.

  • abstract – bool: If True, the command is not registered (base class for shared logic); defaults to False.

  • processor – Optional[BaseCommandProcessor]: The processor associated with this command.

name = 'scaffold-game'
aliases = ('new-game',)
args
__doc__ = Multiline-String
Show Value
"""
    Scaffold a new runnable Mini Arcade game project.

    Usage:
        mini-arcade scaffold-game --game-id my-first-game
        mini-arcade scaffold-game --game-id my-first-game --destination C:\dev\arcade-forge\games
        mini-arcade scaffold-game --game-id my-first-game --package my_first_game --dry-run
    """