ravenous_typst/README.md

54 lines
1.3 KiB
Markdown

# Ravenous Typst
## Building the master handbook
Build the complete master handbook:
```sh
typst compile master_handbook.typ master_handbook.pdf
```
To work on one creature without rendering every other bestiary entry, pass its
database ID through `creature_id`:
```sh
typst compile --input creature_id=3 master_handbook.typ creature-3.pdf
```
The master handbook automatically enables its master-only glossary entries, so
no preset argument is required. An unknown ID, or an ID not visible to the
master, produces an explicit error.
For a persistent local selection, set `build.creature_id` in
`data/config/build.yaml`. Keep it as an empty string to render every
master-visible creature:
```yaml
build:
creature_id: "3"
```
To test trusted database markup and glossary evaluation one creature at a time:
```sh
tools/check_creature_eval.sh
```
Pass an ID to check only one entry:
```sh
tools/check_creature_eval.sh 3
```
## Building the master creature balance report
Build the standalone creature analysis report with:
```sh
typst compile balance_report_master.typ balance_report_master.pdf
```
Its sections are enabled in `data/config/balance_report_master.yaml`. The
initial report covers common creature profiles, rewards, and regional
difficulty; later creature-specific analyses can be added independently.