|
|
||
|---|---|---|
| .helix | ||
| chapters | ||
| character_sheets | ||
| data | ||
| docs | ||
| images | ||
| setup | ||
| test | ||
| tools | ||
| .gitignore | ||
| .gitmodules | ||
| .ignore | ||
| Jenkinsfile | ||
| LICENCE | ||
| LICENCE-ORC.md | ||
| README.md | ||
| balance_report.typ | ||
| balance_report_master.typ | ||
| changelog.typ | ||
| cookbook.typ | ||
| csheet.typ | ||
| main.typ | ||
| master_handbook.typ | ||
| master_screen.typ | ||
| player_handbook.typ | ||
| skill_summary.typ | ||
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.
Installing Typst
If you have a Rust toolchain installed, you can install:
-
The latest released Typst version with:
cargo install --locked typst-cli -
A development version with:
cargo install --git https://github.com/typst/typst --locked typst-cli
Editor tooling
Tinymist provides Typst language server features such as diagnostics and completion. Install its latest development version with Cargo:
cargo install --git https://github.com/Myriad-Dreamin/tinymist --locked tinymist-cli
Typstyle formats Typst source files. Install it from crates.io with:
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:
[[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:
git clone --recurse-submodules <repository-url>
cd ravenous_typst
typst compile main.typ main.pdf
Read the advanced main-book build guide for themes, presets, content selection, persistent configuration, live rebuilding, and CI reproduction.
Building other documents
Each standalone document has its own build guide:
Project layout
main.typis the rulebook entry point.balance_report.typis the automatically generated balance-analysis report.chapters/contains the book's content.setup/contains shared styles, models, and macros.images/anddata/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.