# Ravenous Ravenous is a French-language tabletop role-playing game about Hunters: mortals marked by the blood of Calamities who stand between humanity and monstrous threats. This repository contains the Typst sources and assets used to produce its rulebook. ## Build the book Install [Typst](https://typst.app/docs/reference/), clone the repository with its submodules, then compile the main document: ```sh git clone --recurse-submodules cd ravenous_typst typst compile main.typ main.pdf typst compile balance_report.typ balance_report.pdf ``` All shared build settings live in `data/config/build.yaml`. To build the player-facing edition with the predefined chapter exclusions, use one override: ```sh typst compile --input preset=player-handbook main.typ player-handbook.pdf ``` The preset can be combined with independent origin and school selectors: ```sh typst compile \ --input preset=player-handbook \ --input origin=dragon_1 \ --input school=artilleur \ main.typ dragon-1-artilleur-handbook.pdf ``` `origin` and `school` default to an empty string, which includes every entry. Origins identify individual YAML variants such as `dragon_1`, `dragon_2`, or `guivre_1`, rather than an entire origin family. They can also be set persistently under `build` in the YAML. Invalid identifiers fail compilation with an explicit error instead of producing an incomplete book. Edit `build.disabled_chapters` for permanent project-specific exclusions, or add another entry under `presets` for a reusable edition. Chapter IDs are the names passed to `chapter-enabled` in `main.typ`. For live rebuilding while editing, use: ```sh typst watch main.typ main.pdf ``` The CI build also generates Git metadata before compiling. To reproduce that locally: ```sh ./tools/pseudo_toolchain.sh typst compile main.typ main.pdf ``` ## Project layout - `main.typ` is the rulebook entry point. - `balance_report.typ` is the automatically generated balance-analysis report. - `chapters/` contains the book's content. - `setup/` contains shared styles, models, and macros. - `images/` and `data/` contain supporting assets and game data. ## Writing chapters Import the chapter-authoring prelude to access the shared macros and styles: ```typst #import "/setup/prelude.typ": * ``` See [the Typst usage guide](docs/usage.md) for the available helpers, section references, examples, and guidance on when to use a more specific import. ## Contributing and conduct Contributions, corrections, and suggestions are welcome. Keep changes focused, make sure the book still compiles, and explain non-obvious decisions in your pull request or commit message. Be respectful and constructive. Harassment, discrimination, personal attacks, and other hostile behaviour are not acceptable in project discussions or contributions.