Game Engine "Shvatka"

Engine for the night search game Shvatka/Encounter

Allows planning and running games. Consists of a REST interface and a Telegram bot.

Core functionality:

• Game scenario editor,

• Game preparation management,

• Team formation by the captain,

• Assigning deputy captains with different permissions,

• Collecting game applications,

• Running the game,

• Informing organizers about game progress,

• Generating game results,

• Storing statistics of past games

Documentation

How to run without Docker:

1. cp config_dist config

2. Fill in the configs in config

3. Set the database URL in alembic.ini

4. Run and apply migrations python -m alembic upgrade head .

uv pip install .
export BOT_PATH=$PWD
shvatka-tgbot

How to run with Docker

1. cp config_dist config

2. Fill in the configs in config

3. Set the database URL in alembic.ini

4. Run and apply migrations docker-compose run cli -c "python -m alembic upgrade head"

5. docker-compose up -d

How to fix dependencies

uv pip compile pyproject.toml > lock.txt

How to test

pytest tests

or only unit tests (faster):

pytest tests/unit

Linters

Linux:

ruff format . && ruff --fix . && mypy .

Windows:

ruff format . ; ruff --fix . ; mypy .