mini_arcade.modules.game_runner.commands

Game Runner Command: Implements the “run” command to start a Mini Arcade game or example.

Classes

GameRunnerCommand	Base class for all commands.
TourCommand	Base class for all commands.

Module Contents

class mini_arcade.modules.game_runner.commands.GameRunnerCommand

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 = 'run'

args

__doc__ = Multiline-String

Show Value

"""
    Run a game or an example.

    Usage:
        mini-arcade run --game deja-bounce [--from-source <games_parent>] [--pass-through <args...>]
        mini-arcade run --example config/engine_config_basics [--examples-dir <examples_parent>] [--pass-through <args...>]
        mini-arcade run tour [tour options...]

    Description:
        This command starts a Mini Arcade game or example. You can specify the game/example by its id or folder name. By default, it looks for games in the ./games directory and examples in the ./examples directory (relative to the current working directory). You can override these defaults with the --from-source and --examples-dir options.
        It also supports the compatibility form `mini-arcade run tour`, which
        routes to the tutorial tour command.
    """

class mini_arcade.modules.game_runner.commands.TourCommand

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 = 'tour'

args

__doc__ = Multiline-String

Show Value

"""
    Run catalog examples sequentially.

    Usage:
        mini-arcade run tour
        mini-arcade run tour --group scene
        mini-arcade run tour --from-example scene/minimal_scene --to-example scene/pause_overlay_policy
        mini-arcade run tour --pass-through --backend native

    Description:
        This command orchestrates a full "run-all" tutorial session by launching
        examples one-by-one in subprocesses. When one example window closes, the
        next example starts automatically. Press Ctrl+C to stop the tour at
        any time.
    """