The official version of Ravenous, now in Typst
Go to file
vky 15f218d1d3
Lot more work on Tréorst
2026-08-25 03:04:03 +02:00
chapters Lot more work on Tréorst 2026-08-25 03:04:03 +02:00
data Lot more work on Tréorst 2026-08-25 03:04:03 +02:00
docs "Fix" or origins 2026-08-22 04:15:04 +02:00
images Display name & did 2026-08-25 00:56:18 +02:00
setup Changelog 2026-08-25 02:41:43 +02:00
test Display name & did 2026-08-25 00:56:18 +02:00
tools Bestiairy formatting 2026-08-22 18:16:25 +02:00
.gitignore Renames the glossaries 2026-08-24 01:09:44 +02:00
.gitmodules Update .gitmodules 2026-08-19 01:40:18 +02:00
.ignore Master screen, einer & art 2026-08-24 00:27:12 +02:00
Jenkinsfile Master screen 2026-08-23 23:41:46 +02:00
README.md Master screen, einer & art 2026-08-24 00:27:12 +02:00
Readme.md Player handbook 2026-08-23 19:44:49 +02:00
balance_report.typ Creature model 2026-08-22 16:53:14 +02:00
balance_report_master.typ Formatting and balance 2026-08-25 02:30:26 +02:00
changelog.typ Add a changelog & live tests 2026-08-25 01:54:59 +02:00
main.typ FAQ 2026-08-24 22:33:07 +02:00
master_handbook.typ Add a changelog & live tests 2026-08-25 01:54:59 +02:00
master_screen.typ Master screen 2026-08-23 23:41:46 +02:00
player_handbook.typ FAQ 2026-08-24 22:33:07 +02:00

Readme.md

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

All shared build settings live in data/config/build.yaml. Build the dedicated player-facing edition with the predefined chapter exclusions using:

typst compile --input preset=player-handbook player_handbook.typ player-handbook.pdf

Select any theme from setup/theme/themes.typ with the theme input:

typst compile --input preset=player-handbook --input theme=steel \
  player_handbook.typ player-handbook-steel.pdf

Sections can be toggled with comma-separated chapter IDs. chapters is an allow-list; disabled_chapters removes entries from it (or from the default set when no allow-list is supplied):

typst compile --input preset=player-handbook \
  --input chapters=title,origins,schools,rules \
  --input disabled_chapters=rules \
  player_handbook.typ player-handbook-classes.pdf

origin-lore and origin-artwork are content-level switches. They do not create table-of-contents chapters, but control the lore quotations and images inside origins. The player preset hides origin-lore by default. For example:

typst compile --input disabled_chapters=origin-artwork \
  player_handbook.typ player-handbook-without-origin-art.pdf

When using the chapters allow-list, include origin-artwork alongside origins if images should be retained. origin-lore can likewise be selected in the full book or a custom preset; the standard player preset deliberately keeps it disabled.

The preset can be combined with independent origin and school selectors:

typst compile \
  --input preset=player-handbook \
  --input origin=dragon_1 \
  --input school=artilleur \
  player_handbook.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:

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.