woggioni
6932a3272c
CI / Build and push docker image (push) Successful in 3m12s
The platform now hosts multiple card games, with scopone scientifico as the first one. Rename the brand wherever it is not a game rule: - move the Python package to server/src/tavolo and update imports - rename the Postgres database/user, OIDC issuer path, client id and Redis key prefixes to tavolo (clean break: existing pgdata volumes and live games are not migrated) - rename the Cargo package to tavolo-web and set the page title to Tavolo - update docs and the Docker image path to woggioni/tavolo The scopa game term (clearing the table) in the engine, state and web UI is intentionally left untouched.
79 lines
2.6 KiB
Markdown
79 lines
2.6 KiB
Markdown
# tavolo
|
|
|
|
A platform for multiplayer card games. The first game is **scopone
|
|
scientifico** — the four-player, fixed-partnership Italian card game:
|
|
|
|
- **`server/`** — backend: Python + [kaya](https://github.com/woggioni/kaya)
|
|
framework, OIDC login, live games in Redis, match statistics in Postgres.
|
|
See [server/README.md](server/README.md).
|
|
- **`web/`** — frontend: Rust + [Sycamore](https://sycamore.dev) compiled to
|
|
WebAssembly, built with [Trunk](https://trunkrs.dev). Card images are the
|
|
CC0 *woodcut napoletane* deck traced from a 1902 Naples print
|
|
([SONDLecT/woodcut-napoletane](https://github.com/SONDLecT/woodcut-napoletane)).
|
|
|
|
## Run the whole stack
|
|
|
|
```sh
|
|
docker compose up --build
|
|
```
|
|
|
|
Postgres, Redis, a mock OIDC provider (test users `alice`, `bob`, `carol`,
|
|
`dave`), the database migrator and the app all come up together. The app —
|
|
frontend and API — listens on `http://127.0.0.1:8080`.
|
|
|
|
Because both the browser and the app talk to the OIDC issuer at
|
|
`http://mockoauth:8180/tavolo`, add a host entry once:
|
|
|
|
```sh
|
|
echo "127.0.0.1 mockoauth" | sudo tee -a /etc/hosts
|
|
```
|
|
|
|
## Between hands
|
|
|
|
When a hand ends but the match is not decided, the game pauses on a
|
|
**scoring summary screen**: every player sees how each category was won
|
|
(carte, denara, settebello, primiera, scope) with the running totals and
|
|
must click "Understood" before the next hand is dealt. If someone is away
|
|
the next hand is dealt automatically after `HAND_ACK_TIMEOUT_SECONDS`
|
|
(default 30s). The match-ending hand is explained on the final screen.
|
|
|
|
## On your turn
|
|
|
|
Every turn shows a countdown (`TURN_TIMEOUT_SECONDS`, default 30s). If a
|
|
player does not move — disconnected or fallen asleep — the server plays a
|
|
random legal card for them (randomizing among the legal captures when the
|
|
rules require a capture), so one absent player cannot stall the table.
|
|
|
|
## Development
|
|
|
|
Backend (from `server/`):
|
|
|
|
```sh
|
|
cd server
|
|
python3 -m venv .venv
|
|
.venv/bin/pip install -r requirements.txt
|
|
.venv/bin/pip install -e '.[dev]'
|
|
.venv/bin/python -m unittest discover -s tests -t .
|
|
.venv/bin/mypy src
|
|
```
|
|
|
|
Frontend (from `web/`), with the backend running on :8080:
|
|
|
|
```sh
|
|
cd web
|
|
trunk serve # SPA on http://localhost:8000, /api /auth /ws proxied
|
|
```
|
|
|
|
Trunk proxies `/api`, `/auth` and `/ws` to `127.0.0.1:8080` (see
|
|
`web/Trunk.toml`). For the login redirect to land back on the dev server,
|
|
run the backend with:
|
|
|
|
```sh
|
|
OIDC_POST_LOGIN_REDIRECT=http://localhost:8000/ \
|
|
OIDC_POST_LOGOUT_REDIRECT=http://localhost:8000/ \
|
|
.venv/bin/granian --host 127.0.0.1 --port 8080 tavolo.app:app
|
|
```
|
|
|
|
Card images are committed under `web/assets/cards/`; `web/fetch-cards.sh`
|
|
re-downloads them if needed.
|