43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# Il Labirinto del Dojo
|
||
|
||
A small tabletop game (1–2 h, 3–8 players, best at 4), plus the tooling used to design and
|
||
balance it.
|
||
|
||
| Document | What it is |
|
||
|---|---|
|
||
| [`RULES.md`](RULES.md) | The rulebook (English working draft). |
|
||
| [`board/FORMAT.md`](board/FORMAT.md) | How the board is written as text. |
|
||
| [`agents/plans/`](agents/plans/) | Active work plan: decisions, phases, open questions. |
|
||
|
||
## Setup
|
||
|
||
Requires [uv](https://docs.astral.sh/uv/). It installs the pinned Python and all tools:
|
||
|
||
```sh
|
||
uv sync
|
||
```
|
||
|
||
## Board
|
||
|
||
The board is authored as one 8x8 quadrant in `board/quadrant.txt` (tunnel links in
|
||
`board/legend.toml`) and rotated into the full 16x16 board.
|
||
|
||
```sh
|
||
uv run dojo board validate # check the board against the rules, print stats
|
||
uv run dojo board render # print the full 16x16 board
|
||
uv run dojo board render -o board/board.txt # regenerate the full board file (never edit it by hand)
|
||
uv run dojo board validate --quadrant other.txt --legend other.toml # check another draft
|
||
```
|
||
|
||
`validate` exits with `0` when the board is fine (warnings allowed), `1` on rule violations,
|
||
`2` when the file is malformed or missing.
|
||
|
||
## Development
|
||
|
||
```sh
|
||
uv run pytest # tests
|
||
uv run ruff check . # lint
|
||
uv run ruff format . # format
|
||
uvx pyright src tests # type check
|
||
```
|