escapy

escapy - A lightweight escape-room game library built on pygame.

This is the main package containing all the core game logic, events, objects, and interaction systems. The PyGameUi implementation is available as a separate submodule in escapy.pygame.

Example usage:

from escapy import Game
from escapy.messages import dict_message_provider
from escapy.pygame import PyGameUi
from escapy.types import Position

# create your game data (objects, rooms, inventory, first_room_id)
# then:
message_provider = dict_message_provider(messages)
ui = PyGameUi(config_ui, message_provider)
ui.init(game)
while ui.is_running:
    ui.tick()
    events = ui.input()
    ui.handle(events)
    ui.render()

The top-level escapy package re-exports the most commonly used classes, functions, and protocols for convenient access. See the individual module pages for full API details.

Subpackages

• escapy.protocols
• escapy.pygame