mini-arcade-core 0.9.0__tar.gz → 0.9.1__tar.gz

{mini_arcade_core-0.9.0 → mini_arcade_core-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mini-arcade-core
-Version: 0.9.0
+Version: 0.9.1
 Summary: Tiny scene-based game loop core for small arcade games.
 License: Copyright (c) 2025 Santiago Rincón
            

{mini_arcade_core-0.9.0 → mini_arcade_core-0.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "mini-arcade-core"
-version = "0.9.0"
+version = "0.9.1"
 description = "Tiny scene-based game loop core for small arcade games."
 authors = [
     { name = "Santiago Rincon", email = "rincores@gmail.com" },

{mini_arcade_core-0.9.0 → mini_arcade_core-0.9.1}/src/mini_arcade_core/__init__.py

@@ -19,6 +19,7 @@ from .collision2d import RectCollider
 from .entity import Entity, KinematicEntity, SpriteEntity
 from .game import Game, GameConfig
 from .geometry2d import Bounds2D, Position2D, Size2D
+from .keys import Key, keymap
 from .kinematics2d import KinematicData
 from .physics2d import Velocity2D
 from .scene import Scene
@@ -69,6 +70,8 @@ __all__ = [
     "VerticalWrap",
     "RectSprite",
     "RectKinematic",
+    "Key",
+    "keymap",
 ]
 
 PACKAGE_NAME = "mini-arcade-core"  # or whatever is in your pyproject.toml

{mini_arcade_core-0.9.0 → mini_arcade_core-0.9.1}/src/mini_arcade_core/backend.py

@@ -9,6 +9,8 @@ from dataclasses import dataclass
 from enum import Enum, auto
 from typing import Iterable, Optional, Protocol, Tuple, Union
 
+from .keys import Key
+
 Color = Union[Tuple[int, int, int], Tuple[int, int, int, int]]
 
 
@@ -57,7 +59,8 @@ class Event:
     - key: integer key code (e.g. ESC = 27), or None if not applicable
 
     :ivar type (EventType): The type of event.
-    :ivar key (int | None): The key code associated with the event, if any.
+    :ivar key (Key | None): The key associated with the event, if any.
+    :ivar key_code (int | None): The key code associated with the event, if any.
     :ivar scancode (int | None): The hardware scancode of the key, if any.
     :ivar mod (int | None): Modifier keys bitmask, if any.
     :ivar repeat (bool | None): Whether this key event is a repeat, if any.
@@ -72,7 +75,8 @@ class Event:
     """
 
     type: EventType
-    key: Optional[int] = None
+    key: Key | None = None  # Use Key enum for better clarity
+    key_code: Optional[int] = None
 
     # Keyboard extras (optional)
     scancode: Optional[int] = None

mini_arcade_core-0.9.1/src/mini_arcade_core/keymaps/sdl.py

@@ -0,0 +1,98 @@
+"""
+SDL keymap for mini arcade core.
+Maps SDL keycodes to mini arcade core Key enums.
+"""
+
+from __future__ import annotations
+
+from mini_arcade_core.keys import Key
+
+# SDL keycodes you need (minimal set)
+SDLK_ESCAPE = 27
+SDLK_RETURN = 13
+SDLK_SPACE = 32
+SDLK_TAB = 9
+SDLK_BACKSPACE = 8
+
+SDLK_UP = 1073741906
+SDLK_DOWN = 1073741905
+SDLK_LEFT = 1073741904
+SDLK_RIGHT = 1073741903
+
+F1 = 1073741882
+F2 = 1073741883
+F3 = 1073741884
+F4 = 1073741885
+F5 = 1073741886
+F6 = 1073741887
+F7 = 1073741888
+F8 = 1073741889
+F9 = 1073741890
+F10 = 1073741891
+F11 = 1073741892
+F12 = 1073741893
+
+SDL_KEYCODE_TO_KEY: dict[int, Key] = {
+    # Letters
+    ord("a"): Key.A,
+    ord("b"): Key.B,
+    ord("c"): Key.C,
+    ord("d"): Key.D,
+    ord("e"): Key.E,
+    ord("f"): Key.F,
+    ord("g"): Key.G,
+    ord("h"): Key.H,
+    ord("i"): Key.I,
+    ord("j"): Key.J,
+    ord("k"): Key.K,
+    ord("l"): Key.L,
+    ord("m"): Key.M,
+    ord("n"): Key.N,
+    ord("o"): Key.O,
+    ord("p"): Key.P,
+    ord("q"): Key.Q,
+    ord("r"): Key.R,
+    ord("s"): Key.S,
+    ord("t"): Key.T,
+    ord("u"): Key.U,
+    ord("v"): Key.V,
+    ord("w"): Key.W,
+    ord("x"): Key.X,
+    ord("y"): Key.Y,
+    ord("z"): Key.Z,
+    # Arrows
+    SDLK_UP: Key.UP,
+    SDLK_DOWN: Key.DOWN,
+    SDLK_LEFT: Key.LEFT,
+    SDLK_RIGHT: Key.RIGHT,
+    # Common
+    SDLK_ESCAPE: Key.ESCAPE,
+    SDLK_SPACE: Key.SPACE,
+    SDLK_RETURN: Key.ENTER,
+    SDLK_TAB: Key.TAB,
+    SDLK_BACKSPACE: Key.BACKSPACE,
+    # Numbers
+    ord("0"): Key.NUM_0,
+    ord("1"): Key.NUM_1,
+    ord("2"): Key.NUM_2,
+    ord("3"): Key.NUM_3,
+    ord("4"): Key.NUM_4,
+    ord("5"): Key.NUM_5,
+    ord("6"): Key.NUM_6,
+    ord("7"): Key.NUM_7,
+    ord("8"): Key.NUM_8,
+    ord("9"): Key.NUM_9,
+    # Function keys
+    F1: Key.F1,
+    F2: Key.F2,
+    F3: Key.F3,
+    F4: Key.F4,
+    F5: Key.F5,
+    F6: Key.F6,
+    F7: Key.F7,
+    F8: Key.F8,
+    F9: Key.F9,
+    F10: Key.F10,
+    F11: Key.F11,
+    F12: Key.F12,
+}

mini_arcade_core-0.9.1/src/mini_arcade_core/keys.py

@@ -0,0 +1,160 @@
+"""
+Mini Arcade Core key definitions.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import Enum, auto
+
+
+class Key(Enum):
+    """
+    Enumeration of common keyboard keys.
+
+    :ivar A-Z: Letter keys.
+    :ivar arrow_up, arrow_down, arrow_left, arrow_right: Arrow keys.
+    :ivar escape, space, enter, tab, backspace: Common control keys.
+    :ivar num_0 - num_9: Number keys.
+    :ivar f1 - f12: Function keys.
+    """
+
+    # Letters
+    A = auto()
+    B = auto()
+    C = auto()
+    D = auto()
+    E = auto()
+    F = auto()
+    G = auto()
+    H = auto()
+    I = auto()
+    J = auto()
+    K = auto()
+    L = auto()
+    M = auto()
+    N = auto()
+    O = auto()
+    P = auto()
+    Q = auto()
+    R = auto()
+    S = auto()
+    T = auto()
+    U = auto()
+    V = auto()
+    W = auto()
+    X = auto()
+    Y = auto()
+    Z = auto()
+
+    # Arrows
+    UP = auto()
+    DOWN = auto()
+    LEFT = auto()
+    RIGHT = auto()
+
+    # Common
+    ESCAPE = auto()
+    SPACE = auto()
+    ENTER = auto()
+    TAB = auto()
+    BACKSPACE = auto()
+
+    # Numbers
+    NUM_0 = auto()
+    NUM_1 = auto()
+    NUM_2 = auto()
+    NUM_3 = auto()
+    NUM_4 = auto()
+    NUM_5 = auto()
+    NUM_6 = auto()
+    NUM_7 = auto()
+    NUM_8 = auto()
+    NUM_9 = auto()
+
+    # Function keys
+    F1 = auto()
+    F2 = auto()
+    F3 = auto()
+    F4 = auto()
+    F5 = auto()
+    F6 = auto()
+    F7 = auto()
+    F8 = auto()
+    F9 = auto()
+    F10 = auto()
+    F11 = auto()
+    F12 = auto()
+
+
+# Justification: Simple alias object for keys
+# pylint: disable=too-many-instance-attributes
+@dataclass(frozen=True)
+class _Keys:
+    # alias object so user code can do keys.w, keys.arrow_up, etc.
+    a: Key = Key.A
+    b: Key = Key.B
+    c: Key = Key.C
+    d: Key = Key.D
+    e: Key = Key.E
+    f: Key = Key.F
+    g: Key = Key.G
+    h: Key = Key.H
+    i: Key = Key.I
+    j: Key = Key.J
+    k: Key = Key.K
+    l: Key = Key.L
+    m: Key = Key.M
+    n: Key = Key.N
+    o: Key = Key.O
+    p: Key = Key.P
+    q: Key = Key.Q
+    r: Key = Key.R
+    s: Key = Key.S
+    t: Key = Key.T
+    u: Key = Key.U
+    v: Key = Key.V
+    w: Key = Key.W
+    x: Key = Key.X
+    y: Key = Key.Y
+    z: Key = Key.Z
+
+    up: Key = Key.UP
+    down: Key = Key.DOWN
+    left: Key = Key.LEFT
+    right: Key = Key.RIGHT
+
+    escape: Key = Key.ESCAPE
+    space: Key = Key.SPACE
+    enter: Key = Key.ENTER
+    tab: Key = Key.TAB
+    backspace: Key = Key.BACKSPACE
+
+    num_0: Key = Key.NUM_0
+    num_1: Key = Key.NUM_1
+    num_2: Key = Key.NUM_2
+    num_3: Key = Key.NUM_3
+    num_4: Key = Key.NUM_4
+    num_5: Key = Key.NUM_5
+    num_6: Key = Key.NUM_6
+    num_7: Key = Key.NUM_7
+    num_8: Key = Key.NUM_8
+    num_9: Key = Key.NUM_9
+
+    f1: Key = Key.F1
+    f2: Key = Key.F2
+    f3: Key = Key.F3
+    f4: Key = Key.F4
+    f5: Key = Key.F5
+    f6: Key = Key.F6
+    f7: Key = Key.F7
+    f8: Key = Key.F8
+    f9: Key = Key.F9
+    f10: Key = Key.F10
+    f11: Key = Key.F11
+    f12: Key = Key.F12
+
+
+# pylint: enable=too-many-instance-attributes
+
+keymap = _Keys()