mini_arcade.modules.game_runner.commands
========================================

.. py:module:: mini_arcade.modules.game_runner.commands

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   mini_arcade.modules.game_runner.commands.GameRunnerCommand


Module Contents
---------------

.. py:class:: GameRunnerCommand

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



   .. py:attribute:: args


   .. py:attribute:: __doc__
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
             Run a game or an example.
         
             Usage:
                 mini-arcade run --game deja-bounce [--from-source <games_parent>] [--pass-through -- <args...>]
                 mini-arcade run --example 010_entities_showcase [--examples-dir <examples_parent>] [--pass-through -- <args...>]
             
             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.
             """

      .. raw:: html

         </details>