Charz Input

Versatile input interfaces, for keyboard and console.

Examples

Defining an Action Enum, with all possible actions as variants:

from enum import Enum, auto


class Action(Enum):
    SWITCH_INPUT = auto()
    MOVE_LEFT = auto()
    MOVE_RIGHT = auto()

Switching between Keyboard and Controller input methods:

# ... defined `Action` enum ...

from charz_input import Input, Keyboard, Controller
import pygame

handler: Input[Action] = Keyboard({
    Action.SWITCH_INPUT: "Space",
    Action.MOVE_LEFT: "A",
    Action.MOVE_RIGHT: "D",
})
player_position_x: int = 0

while True:
    handler.capture_states()

    if handler.is_action_just_pressed(Action.SWITCH_INPUT):
        if isinstance(handler, Keyboard):
            handler = Controller({
                Action.SWITCH_INPUT: pygame.CONTROLLER_BUTTON_A,
                Action.MOVE_LEFT: Controller.Trigger(
                    pygame.CONTROLLER_AXIS_LEFTX,
                    Controller.Trigger.Limit.NEGATIVE,
                ),
                Action.MOVE_RIGHT: Controller.Trigger(
                    pygame.CONTROLLER_AXIS_LEFTX,
                    Controller.Trigger.Limit.POSITIVE,
                    deadzone=35,
                ),
            })
        elif isinstance(handler, Controller):
            handler = Keyboard({
                Action.SWITCH_INPUT: "Space",
                Action.MOVE_LEFT: "A",
                Action.MOVE_RIGHT: "D",
            })
        continue

    if handler.is_action_pressed(Action.MOVE_LEFT):
        player_position_x -= 1
    if handler.is_action_pressed(Action.MOVE_RIGHT):
        player_position_x += 1

    print(f"The player is located at x = {player_position_x}")

Declearing default keybinds:

import charz_input

# ... defined `Action` enum ...


class CustomKeyboard(charz_input.Keyboard):
    default_action_binds = {
        Action.SWITCH_INPUT: "Space",
        Action.MOVE_LEFT: "A",
        Action.MOVE_RIGHT: "D",
    }


handler = CustomKeyboard[Action]()
different_handler = CustomKeyboard({
    Action.MOVE_RIGHT: "Y",  # Overrides keybind
    # NOTE: The rest are set to their defaults,
    # as defined by `default_action_binds`
})

# ... logic to check for action presses ...

You can ensure all actions are mapped at runtime, using a typed class item when instantiating:

                # ┌──────┬─────> Action enum, as class item
handler = Keyboard[Action]({
    Action.SWITCH_INPUT: "Space",
    Action.MOVE_LEFT: "A",
    # Missing `Action.MOVE_RIGHT`
})
handler.capture_states()  # This triggers the check
>> AssertionError: Missing actions

# Annotating the variable, and not the instance, will have different results:
handler: Keyboard[Action] = Keyboard({...})

Checking for keyboard presses with a modifier:

handler = Keyboard[Action](
    # ... keybinds ...
    Action.MOVE_LEFT: "W+{modifier}",  # Dynamic, in the sense of initializing
    Action.MOVE_RIGHT: "W",
    Action.SWITCH_INPUT: "Ctrl+Space"  # Can also be hardcoded
    modifier="Space",  # Default: "Shift"
)

handler.capture_states()
print(handler.is_pressed())
handler.action_binds
handler.capture_states()
print(handler.is_pressed())

Roadmap

• Expose action binds at runtime, so they can be changed
• Figure out whether automatic device detection for controller is ideal

License

MIT