# 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. ## Installing Typst If you have a [Rust](https://rustup.rs/) toolchain installed, you can install: - The latest released Typst version with: ```sh cargo install --locked typst-cli ``` - A development version with: ```sh cargo install --git https://github.com/typst/typst --locked typst-cli ``` ## Editor tooling [Tinymist](https://myriad-dreamin.github.io/tinymist/) provides Typst language server features such as diagnostics and completion. Install its latest development version with Cargo: ```sh cargo install --git https://github.com/Myriad-Dreamin/tinymist --locked tinymist-cli ``` [Typstyle](https://typstyle-rs.github.io/typstyle/) formats Typst source files. Install it from crates.io with: ```sh cargo install typstyle --locked ``` Make sure Cargo's binary directory is available on your `PATH`, so the editor can find the `tinymist` and `typstyle` executables. ### Helix Add the following to your global Helix `~/.config/helix/languages.toml` or to `.helix/languages.toml` inside this repository for a project-local setup: ```toml [[language]] name = "typst" auto-format = true language-servers = ["tinymist"] formatter = { command = "typstyle", args = [] } [language-server.tinymist] command = "tinymist" ``` This enables Tinymist diagnostics and completion, and runs Typstyle whenever Helix formats the document or saves it with automatic formatting enabled. ## Building the book Clone the repository with its submodules, then compile the main book: ```sh git clone --recurse-submodules cd ravenous_typst typst compile main.typ main.pdf ``` [Read the advanced main-book build guide](docs/builds/main/README.md) for themes, presets, content selection, persistent configuration, live rebuilding, and CI reproduction. ## Building other documents Each standalone document has its own build guide: - [Player handbook and cookbook](docs/builds/player/README.md) - [Master handbook and master screen](docs/builds/master/README.md) - [Balance reports](docs/builds/reports/README.md) - [Changelog](docs/builds/changelog/README.md) ## 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.