mini_arcade_core
================

.. py:module:: mini_arcade_core

.. autoapi-nested-parse::

   Entry point for the mini_arcade_core package.
   Provides access to core classes and a convenience function to run a game.

   get_version method needs to be removed



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/mini_arcade_core/backend/index
   /autoapi/mini_arcade_core/bus/index
   /autoapi/mini_arcade_core/engine/index
   /autoapi/mini_arcade_core/runtime/index
   /autoapi/mini_arcade_core/scenes/index
   /autoapi/mini_arcade_core/spaces/index
   /autoapi/mini_arcade_core/ui/index
   /autoapi/mini_arcade_core/utils/index


Classes
-------

.. autoapisummary::

   mini_arcade_core.Game
   mini_arcade_core.GameConfig


Functions
---------

.. autoapisummary::

   mini_arcade_core.run_game


Package Contents
----------------

.. py:class:: Game(config: mini_arcade_core.engine.game_config.GameConfig, scene_registry: mini_arcade_core.scenes.registry.SceneRegistry | None = None)

   Core game object responsible for managing the main loop and active scene.


   .. py:attribute:: config


   .. py:attribute:: backend
      :type:  mini_arcade_core.backend.Backend


   .. py:attribute:: settings


   .. py:attribute:: managers


   .. py:attribute:: services


   .. py:property:: running
      :type: bool


      Check if the game is currently running.


   .. py:method:: quit()

      Request that the main loop stops.



   .. py:method:: run()

      Run the main loop starting with the given scene.

      This is intentionally left abstract so you can plug pygame, pyglet,
      or another backend.

      :param initial_scene_id: The scene id to start the game with (must be registered).
      :type initial_scene_id: str



   .. py:method:: resolve_world() -> object | None

      Resolve and return the current gameplay world.

      :return: The current gameplay world, or None if not found.
      :rtype: object | None



.. py:class:: GameConfig

   Configuration options for the Game.

   :ivar initial_scene (str): Identifier of the initial scene to load.
   :ivar fps (int): Target frames per second.
   :ivar backend (Backend | None): Optional Backend instance to use for rendering and input.
   :ivar virtual_resolution (tuple[int, int]): Virtual render resolution.
   :ivar postfx (PostFXConfig): Configuration for post-processing effects.


   .. py:attribute:: initial_scene
      :type:  str
      :value: 'main'



   .. py:attribute:: fps
      :type:  int
      :value: 60



   .. py:attribute:: backend
      :type:  mini_arcade_core.backend.Backend | None
      :value: None



   .. py:attribute:: virtual_resolution
      :type:  tuple[int, int]
      :value: (800, 600)



   .. py:attribute:: postfx
      :type:  PostFXConfig


   .. py:attribute:: enable_profiler
      :type:  bool
      :value: False



.. py:function:: run_game(game_config: engine.game_config.GameConfig | None = None, scene_registry: scenes.registry.SceneRegistry | None = None)

   Convenience helper to bootstrap and run a game with a single scene.

   :param game_config: Optional GameConfig to customize game settings.
   :type game_config: GameConfig | None

   :param scene_registry: Optional SceneRegistry for scene management.
   :type scene_registry: SceneRegistry | None

   :raises ValueError: If the provided game_config does not have a valid Backend.