mini_arcade.modules.game_scaffold.processors

Processor for creating starter Mini Arcade game projects.

Classes

ScaffoldSpec	Specification for generating a game scaffold, containing all necessary information
GameScaffoldProcessor	Processor for creating starter Mini Arcade game projects.

Module Contents

class mini_arcade.modules.game_scaffold.processors.ScaffoldSpec

Specification for generating a game scaffold, containing all necessary information about the game and project structure.

Variables:

• game_id – The unique identifier for the game, used for package naming and project structure.

• package – The Python package name for the game’s source code.

• title – The human-readable title for the game.

• target_dir – The target directory where the game scaffold will be created.

• dependency_series – The version series (e.g. “0.1”) of mini-arcade dependencies to use in the generated pyproject.toml.

game_id: str

package: str

title: str

target_dir: pathlib.Path

dependency_series: str

class mini_arcade.modules.game_scaffold.processors.GameScaffoldProcessor(**kwargs)

Bases: mini_arcade.cli.base_command_processor.BaseCommandProcessor

Processor for creating starter Mini Arcade game projects.

Variables:

• (str) (destination) – The unique identifier for the game, used for package naming and project structure.

• None) (title (str |) – Optional custom package name for the game’s source code.

• None) – Optional human-readable title for the game.

• (str) – The parent directory where the game scaffold will be created (default is “games”).

• (bool) (dry_run) – Whether to overwrite existing files if the target directory already exists (default is False).

• (bool) – If True, do not create any files but print the intended actions (default is False).

game_id: str

package: str | None = None

title: str | None = None

destination: str = 'games'

force: bool = False

dry_run: bool = False

run() → int

Run the command processor.

Returns:

Optional result of the command execution.

Return type:

Optional[Any]