added docs
This commit is contained in:
@@ -2,6 +2,8 @@
|
||||
|
||||
An online version of the card game Wizard (rules: `wizard_instructions/`).
|
||||
|
||||
**Detailed documentation of the whole codebase: [`docs/`](docs/README.md).**
|
||||
|
||||
| Component | Path | Tech |
|
||||
|-----------|------|------|
|
||||
| Frontend | `wizard_website/` | React + TypeScript + Vite, CSS modules, served by nginx |
|
||||
@@ -18,7 +20,8 @@ browser ──wss /wizard/api/ws──────▶ Caddy ──/ws──▶ w
|
||||
|
||||
1. A player opens the website, enters a name and creates a lobby (and joins it).
|
||||
2. The lobby shows a code (and an invite link, `?lobby=CODE`) others use to join.
|
||||
3. The host can add AI players, toggle the *not equal* / *hidden bids* rules, and start the game (3–6 players).
|
||||
3. The host can add AI players, toggle the *hidden bids* option, and start the game (3–6 players).
|
||||
The sum of all bids may never equal the number of cards in hand (always on).
|
||||
4. The server runs the game with `wizard_game` and sends every player a personal view
|
||||
(`Observation`) after each move. Reloading the page reconnects to the same seat.
|
||||
A player who leaves a running game is replaced by an AI player.
|
||||
|
||||
Reference in New Issue
Block a user