mini_arcade.modules.game_scaffold.commands ========================================== .. py:module:: mini_arcade.modules.game_scaffold.commands .. autoapi-nested-parse:: CLI command for scaffolding a new Mini Arcade game project. Classes ------- .. autoapisummary:: mini_arcade.modules.game_scaffold.commands.ScaffoldGameCommand Module Contents --------------- .. py:class:: ScaffoldGameCommand Bases: :py:obj:`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. :ivar name: Optional[str]: Command name (for registry); defaults to class name lowercased. :ivar aliases: Tuple[str, ...]: Optional command aliases. :ivar summary: Optional[str]: Short description of the command. :ivar epilog: Optional[str]: Additional help text for the command. :ivar args: Optional[List[ArgumentType]]: List of command arguments. :ivar abstract: bool: If True, the command is not registered (base class for shared logic); defaults to False. :ivar processor: Optional[BaseCommandProcessor]: The processor associated with this command. .. py:attribute:: name :value: 'scaffold-game' .. py:attribute:: aliases :value: ('new-game',) .. py:attribute:: args .. py:attribute:: __doc__ :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ 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 """ .. raw:: html