ravenous_typst/Readme.md

1.8 KiB

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, clone the repository with its submodules, then compile the main document:

git clone --recurse-submodules <repository-url>
cd ravenous_typst
typst compile main.typ main.pdf
typst compile balance_report.typ balance_report.pdf

For live rebuilding while editing, use:

typst watch main.typ main.pdf

The CI build also generates Git metadata before compiling. To reproduce that locally:

./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:

#import "/setup/prelude.typ": *

See the Typst usage guide 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.