From 883aabe0a5eb3ac10047391956fd4a1e023f44f0 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 25 Aug 2026 20:16:02 +0200 Subject: [PATCH] Readme --- README.md | 171 ++++++++++++++++++++++++++++++- Readme.md | 111 -------------------- chapters/rules/regles_combat.typ | 28 +++++ data/config/changelog.yaml | 4 + docs/usage.md | 2 +- 5 files changed, 203 insertions(+), 113 deletions(-) delete mode 100644 Readme.md diff --git a/README.md b/README.md index 1e0b848..77c5dd1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,144 @@ -# Ravenous Typst +# 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 `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 and the +balance report: + +```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`. Build the dedicated +player-facing edition with the predefined chapter exclusions using: + +```sh +typst compile --input preset=player-handbook player_handbook.typ player-handbook.pdf +``` + +Select any theme from `setup/theme/themes.typ` with the `theme` input: + +```sh +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): + +```sh +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` control the lore quotations and images +inside `origins`. The player preset hides `origin-lore` by default. For example: + +```sh +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` to retain images. The preset can also be combined with independent +origin and school selectors: + +```sh +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`. They can also be set persistently under `build` in the YAML. Invalid +identifiers fail compilation with an explicit error. + +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 +``` ## Building the master screen @@ -100,3 +240,32 @@ defensive successes to survive, checks every player stance against an unmitigated hit, and proposes archetypes such as Thrashing, Defense Check, Tank Buster, or Nuke. These inferred labels are shown beside—not substituted for—the attack type declared in the database. + +## 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. diff --git a/Readme.md b/Readme.md deleted file mode 100644 index d1106eb..0000000 --- a/Readme.md +++ /dev/null @@ -1,111 +0,0 @@ -# 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`. Build the dedicated -player-facing edition with the predefined chapter exclusions using: - -```sh -typst compile --input preset=player-handbook player_handbook.typ player-handbook.pdf -``` - -Select any theme from `setup/theme/themes.typ` with the `theme` input: - -```sh -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): - -```sh -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: - -```sh -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: - -```sh -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: - -```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. diff --git a/chapters/rules/regles_combat.typ b/chapters/rules/regles_combat.typ index d45f43e..96fab1e 100644 --- a/chapters/rules/regles_combat.typ +++ b/chapters/rules/regles_combat.typ @@ -739,3 +739,31 @@ Ces notions restent extrêmement subjectives et ne sont jamais une certitude, c' ] Dit autrement la créature peut surprendre les joueurs et le @maitredejeu se devra de tromper les chasseurs en leur attribuant leurs effets, sachant pertinemment que la créature est capable d'attaque ses cibles a tout moment#footnote[Il peut s'agir d'une forme de malice de la créature ou simplement d'une capacité inconnue ou non documentée jusque-là.]. + +=== Destruction du terrain + +La destruction du terrain reste principalement à l'appréciation du @maitredejeu. Les dégâts d'une attaque indiquent ce qu'elle peut briser, son torque estimé ce qu'elle peut déplacer ou faire s'effondrer, et sa zone d'effet l'étendue des destructions. Les seuils suivants servent de repères et non de valeurs absolues : + +#table( + columns: (1.2fr, 0.7fr, 0.7fr, 0.7fr, 2fr), + inset: 4pt, + table.header( + [*Destruction*], + [*Dégâts*], + [*@ca_torque*], + [*Rayon*], + [*Exemples*], + ), + [Mineure], [10+], [20+], [1–2 m], + [Mobilier, porte, cloison légère ou sol meuble.], + [Importante], [20+], [40+], [3–6 m], + [Arbre, mur de pierre ou petite structure.], + [Massive], [35+], [70+], [7 m ou plus], + [Fortification, bâtiment ou déformation majeure du terrain.], +) + +Une attaque n'a pas besoin d'atteindre les trois seuils d'une ligne. Utilisez la valeur la plus pertinente selon sa nature : une lame peut trancher un obstacle grâce à ses dégâts sans le projeter, tandis qu'un impact possédant un torque élevé peut renverser un mur sans le pulvériser. Le rayon ne mesure que l'étendue affectée et ne permet pas, à lui seul, de détruire un matériau trop résistant. + +#ravhelp[ + Adaptez toujours ces indications au matériau, au type de dégâts, à la préparation de l'attaque et aux besoins de la scène. Une attaque de feu embrasera plus facilement une construction en bois, tandis qu'un mur renforcé pourra exiger un seuil supérieur ou plusieurs impacts. Un élément indispensable au scénario ne devrait jamais être détruit automatiquement sans que les joueurs en soient avertis. +] diff --git a/data/config/changelog.yaml b/data/config/changelog.yaml index 1a53d4a..39cf1bf 100644 --- a/data/config/changelog.yaml +++ b/data/config/changelog.yaml @@ -55,6 +55,10 @@ category: misc description: "Ajout du guide de création, de la fiche de personnage, de la FAQ et de l’écran du maître de jeu." +- revision: v0.0.2 + category: misc + description: "Ajout d’un *livre de recettes* destiné aux joueurs, regroupant des créations préfabriquées pour les différents artisanats." + - revision: v0.0.2 category: misc description: "Clarification des *caractéristiques finales* : les bonus et malus s’appliquent aux tests et à la réserve active, sans recalculer les caractéristiques secondaires." diff --git a/docs/usage.md b/docs/usage.md index 888f049..d588e80 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -2,7 +2,7 @@ This guide covers the shared helpers intended for ordinary chapters and rules. For the overall repository structure and build commands, see the -[project README](../Readme.md). +[project README](../README.md). ## Import the prelude