Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Mini Arcade
Mini Arcade

Start Here

  • README
  • Quickstart
  • Architecture
  • Capabilities
  • Tutorials
    • 001 - Min Scene
    • 002 - Hello Overlay
    • 003 - Simple Shape
    • 004 - Shape Gallery
    • Roadmap
  • Games
    • Asteroids
    • Deja Bounce
    • Space Invaders
  • Contributing
    • Dev setup
    • Repo layout
    • Release process

API Reference

  • API Reference
    • mini_arcade
      • mini_arcade.app
      • mini_arcade.backends
        • mini_arcade.backends.native
        • mini_arcade.backends.pygame
      • mini_arcade.cli
        • mini_arcade.cli.argument_type
        • mini_arcade.cli.base_command
        • mini_arcade.cli.base_command_processor
        • mini_arcade.cli.cli
        • mini_arcade.cli.command_protocol
        • mini_arcade.cli.exceptions
        • mini_arcade.cli.registry
      • mini_arcade.constants
      • mini_arcade.core
      • mini_arcade.main
      • mini_arcade.modules
        • mini_arcade.modules.game_runner
          • mini_arcade.modules.game_runner.commands
          • mini_arcade.modules.game_runner.processors
      • mini_arcade.utils
        • mini_arcade.utils.get_package_version
        • mini_arcade.utils.implementation_registry
        • mini_arcade.utils.logging
        • mini_arcade.utils.module_loader
    • mini_arcade_core
      • mini_arcade_core.backend
        • mini_arcade_core.backend.backend
        • mini_arcade_core.backend.config
        • mini_arcade_core.backend.events
        • mini_arcade_core.backend.keys
        • mini_arcade_core.backend.sdl_map
        • mini_arcade_core.backend.types
        • mini_arcade_core.backend.utils
        • mini_arcade_core.backend.viewport
      • mini_arcade_core.bus
      • mini_arcade_core.engine
        • mini_arcade_core.engine.animation
        • mini_arcade_core.engine.cheats
        • mini_arcade_core.engine.commands
        • mini_arcade_core.engine.components
        • mini_arcade_core.engine.entities
        • mini_arcade_core.engine.game
        • mini_arcade_core.engine.game_config
        • mini_arcade_core.engine.gameplay_settings
        • mini_arcade_core.engine.loop
          • mini_arcade_core.engine.loop.config
          • mini_arcade_core.engine.loop.hooks
          • mini_arcade_core.engine.loop.runner
          • mini_arcade_core.engine.loop.state
        • mini_arcade_core.engine.managers
        • mini_arcade_core.engine.render
          • mini_arcade_core.engine.render.context
          • mini_arcade_core.engine.render.effects
            • mini_arcade_core.engine.render.effects.base
            • mini_arcade_core.engine.render.effects.crt
            • mini_arcade_core.engine.render.effects.registry
            • mini_arcade_core.engine.render.effects.vignette
          • mini_arcade_core.engine.render.frame_packet
          • mini_arcade_core.engine.render.packet
          • mini_arcade_core.engine.render.passes
            • mini_arcade_core.engine.render.passes.base
            • mini_arcade_core.engine.render.passes.begin_frame
            • mini_arcade_core.engine.render.passes.end_frame
            • mini_arcade_core.engine.render.passes.lighting
            • mini_arcade_core.engine.render.passes.postfx
            • mini_arcade_core.engine.render.passes.ui
            • mini_arcade_core.engine.render.passes.world
          • mini_arcade_core.engine.render.pipeline
          • mini_arcade_core.engine.render.render_service
          • mini_arcade_core.engine.render.style
          • mini_arcade_core.engine.render.viewport
        • mini_arcade_core.engine.scenes
          • mini_arcade_core.engine.scenes.models
          • mini_arcade_core.engine.scenes.scene_manager
      • mini_arcade_core.runtime
        • mini_arcade_core.runtime.audio
          • mini_arcade_core.runtime.audio.audio_adapter
          • mini_arcade_core.runtime.audio.audio_port
        • mini_arcade_core.runtime.capture
          • mini_arcade_core.runtime.capture.base_worker
          • mini_arcade_core.runtime.capture.capture_port
          • mini_arcade_core.runtime.capture.capture_service
          • mini_arcade_core.runtime.capture.capture_service_protocol
          • mini_arcade_core.runtime.capture.capture_settings
          • mini_arcade_core.runtime.capture.capture_worker
          • mini_arcade_core.runtime.capture.encode_worker
          • mini_arcade_core.runtime.capture.replay
          • mini_arcade_core.runtime.capture.replay_format
          • mini_arcade_core.runtime.capture.screenshot_capturer
          • mini_arcade_core.runtime.capture.video
          • mini_arcade_core.runtime.capture.video_encoder
          • mini_arcade_core.runtime.capture.video_manifest
        • mini_arcade_core.runtime.context
        • mini_arcade_core.runtime.file
          • mini_arcade_core.runtime.file.file_adapter
          • mini_arcade_core.runtime.file.file_port
        • mini_arcade_core.runtime.input
          • mini_arcade_core.runtime.input.input_adapter
          • mini_arcade_core.runtime.input.input_port
        • mini_arcade_core.runtime.input_frame
        • mini_arcade_core.runtime.render
          • mini_arcade_core.runtime.render.render_port
        • mini_arcade_core.runtime.scene
          • mini_arcade_core.runtime.scene.scene_query_adapter
          • mini_arcade_core.runtime.scene.scene_query_port
        • mini_arcade_core.runtime.services
        • mini_arcade_core.runtime.window
          • mini_arcade_core.runtime.window.window_adapter
          • mini_arcade_core.runtime.window.window_port
      • mini_arcade_core.scenes
        • mini_arcade_core.scenes.autoreg
        • mini_arcade_core.scenes.debug_overlay
        • mini_arcade_core.scenes.registry
        • mini_arcade_core.scenes.sim_scene
        • mini_arcade_core.scenes.systems
          • mini_arcade_core.scenes.systems.base_system
          • mini_arcade_core.scenes.systems.builtins
            • mini_arcade_core.scenes.systems.builtins.actions
            • mini_arcade_core.scenes.systems.builtins.animation
            • mini_arcade_core.scenes.systems.builtins.capture_hotkeys
          • mini_arcade_core.scenes.systems.system_pipeline
      • mini_arcade_core.spaces
        • mini_arcade_core.spaces.behaviors
        • mini_arcade_core.spaces.collision
          • mini_arcade_core.spaces.collision.intersections
          • mini_arcade_core.spaces.collision.rect_collider
          • mini_arcade_core.spaces.collision.specs
        • mini_arcade_core.spaces.d2
          • mini_arcade_core.spaces.d2.boundaries2d
          • mini_arcade_core.spaces.d2.collision2d
          • mini_arcade_core.spaces.d2.kinematics2d
          • mini_arcade_core.spaces.d2.physics2d
        • mini_arcade_core.spaces.geometry
          • mini_arcade_core.spaces.geometry.bounds
          • mini_arcade_core.spaces.geometry.shapes
          • mini_arcade_core.spaces.geometry.size
          • mini_arcade_core.spaces.geometry.transform
        • mini_arcade_core.spaces.math
          • mini_arcade_core.spaces.math.vec2
        • mini_arcade_core.spaces.physics
          • mini_arcade_core.spaces.physics.kinematics2d
      • mini_arcade_core.ui
        • mini_arcade_core.ui.menu
      • mini_arcade_core.utils
        • mini_arcade_core.utils.assets
        • mini_arcade_core.utils.deprecated_decorator
        • mini_arcade_core.utils.logging
        • mini_arcade_core.utils.profiler
    • mini_arcade_pygame_backend
      • mini_arcade_pygame_backend.config
      • mini_arcade_pygame_backend.ports
        • mini_arcade_pygame_backend.ports.audio
        • mini_arcade_pygame_backend.ports.capture
        • mini_arcade_pygame_backend.ports.input
        • mini_arcade_pygame_backend.ports.render
        • mini_arcade_pygame_backend.ports.text
        • mini_arcade_pygame_backend.ports.window
      • mini_arcade_pygame_backend.pygame_backend
    • mini_arcade_native_backend
      • mini_arcade_native_backend.config
      • mini_arcade_native_backend.dlls
      • mini_arcade_native_backend.mapping
        • mini_arcade_native_backend.mapping.events
      • mini_arcade_native_backend.native_backend
      • mini_arcade_native_backend.ports
        • mini_arcade_native_backend.ports.audio
        • mini_arcade_native_backend.ports.capture
        • mini_arcade_native_backend.ports.input
        • mini_arcade_native_backend.ports.render
        • mini_arcade_native_backend.ports.text
        • mini_arcade_native_backend.ports.window
Back to top
View this page

READMEΒΆ

Project-level README lives at repository root:

  • https://github.com/trivox-io/mini-arcade/blob/main/README.md

For docs-first navigation, continue with Quickstart.

Next
Quickstart
Previous
Home
Copyright © 2026, Santiago Rincon
Made with Sphinx and @pradyunsg's Furo