diff --git a/Jenkinsfile b/Jenkinsfile index 5553624..e5e9c7e 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -40,6 +40,10 @@ pipeline { PLAYER_SOURCE_FILE = "player_handbook.typ" PLAYER_OUTPUT_FILE = "Ravenous_player_handbook_build.pdf" PLAYER_PUBLISHED_FILE = "Ravenous_player_handbook.pdf" + SCREEN_SOURCE_FILE = "master_screen.typ" + SCREEN_PLAINTEXT_FILE = "Ravenous_master_screen_plaintext.pdf" + SCREEN_OUTPUT_FILE = "Ravenous_master_screen_build.pdf" + SCREEN_PUBLISHED_FILE = "Ravenous_master_screen.pdf" MASTER_PASSWORD = "billy" // Important: published books live under /mnt/books @@ -128,14 +132,23 @@ pipeline { --encrypt "${MASTER_PASSWORD}" "${MASTER_PASSWORD}" 40 -- \ "${MASTER_BALANCE_PLAINTEXT_FILE}" "${MASTER_BALANCE_OUTPUT_FILE}" + echo "Building ${SCREEN_SOURCE_FILE} -> ${SCREEN_PLAINTEXT_FILE}" + typst compile "${SCREEN_SOURCE_FILE}" "${SCREEN_PLAINTEXT_FILE}" + + echo "Protecting the master screen with the master-handbook policy" + qpdf --allow-weak-crypto \ + --encrypt "${MASTER_PASSWORD}" "${MASTER_PASSWORD}" 40 -- \ + "${SCREEN_PLAINTEXT_FILE}" "${SCREEN_OUTPUT_FILE}" + test -f "${OUTPUT_FILE}" test -f "${BALANCE_OUTPUT_FILE}" test -f "${PLAYER_OUTPUT_FILE}" test -f "${MASTER_OUTPUT_FILE}" test -f "${MASTER_BALANCE_OUTPUT_FILE}" + test -f "${SCREEN_OUTPUT_FILE}" # Never archive or publish unprotected master intermediates. - rm "${MASTER_PLAINTEXT_FILE}" "${MASTER_BALANCE_PLAINTEXT_FILE}" + rm "${MASTER_PLAINTEXT_FILE}" "${MASTER_BALANCE_PLAINTEXT_FILE}" "${SCREEN_PLAINTEXT_FILE}" echo "Builds complete:" ls -lh \ @@ -143,7 +156,8 @@ pipeline { "${BALANCE_OUTPUT_FILE}" \ "${PLAYER_OUTPUT_FILE}" \ "${MASTER_OUTPUT_FILE}" \ - "${MASTER_BALANCE_OUTPUT_FILE}" + "${MASTER_BALANCE_OUTPUT_FILE}" \ + "${SCREEN_OUTPUT_FILE}" ''' } } @@ -151,7 +165,7 @@ pipeline { stage('Archive PDFs') { steps { archiveArtifacts( - artifacts: "${OUTPUT_FILE},${PLAYER_OUTPUT_FILE},${BALANCE_OUTPUT_FILE},${MASTER_OUTPUT_FILE},${MASTER_BALANCE_OUTPUT_FILE}", + artifacts: "${OUTPUT_FILE},${PLAYER_OUTPUT_FILE},${BALANCE_OUTPUT_FILE},${MASTER_OUTPUT_FILE},${MASTER_BALANCE_OUTPUT_FILE},${SCREEN_OUTPUT_FILE}", fingerprint: true ) } @@ -200,7 +214,7 @@ pipeline { conclusion: 'SUCCESS', name: 'Build Successful', summary: 'The Ravenous rulebook, player handbook, master handbook, and balance reports were built successfully.', - text: 'All five PDFs were compiled and published successfully.', + text: 'All six PDFs were compiled and published successfully.', title: 'Build Successful' ) @@ -271,12 +285,17 @@ def deployTo(String targetDir) { "${env.MASTER_BALANCE_OUTPUT_FILE}" \ "${targetDir}/${env.MASTER_BALANCE_PUBLISHED_FILE}" + rsync -a \ + "${env.SCREEN_OUTPUT_FILE}" \ + "${targetDir}/${env.SCREEN_PUBLISHED_FILE}" + echo "Published:" ls -lh \ "${targetDir}/${env.PUBLISHED_FILE}" \ "${targetDir}/${env.BALANCE_PUBLISHED_FILE}" \ "${targetDir}/${env.PLAYER_PUBLISHED_FILE}" \ "${targetDir}/${env.MASTER_PUBLISHED_FILE}" \ - "${targetDir}/${env.MASTER_BALANCE_PUBLISHED_FILE}" + "${targetDir}/${env.MASTER_BALANCE_PUBLISHED_FILE}" \ + "${targetDir}/${env.SCREEN_PUBLISHED_FILE}" """ } diff --git a/README.md b/README.md index ba89a0d..dc8c5e9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # Ravenous Typst +## Building the master screen + +Build the four-panel portrait reference screen with: + +```sh +typst compile master_screen.typ master_screen.pdf +``` + +Its summaries are stored once in `data/src/master_screen.yaml` and rendered by +both the standalone PDF and the `master-screen` chapter of the complete book. +Disable that book chapter through the normal `disabled_chapters` configuration. +The player-handbook preset excludes it by default. CI encrypts and publishes the +standalone screen under the same policy as the other master-facing artifacts. + ## Building the master handbook Build the complete master handbook: diff --git a/chapters/master_screen.typ b/chapters/master_screen.typ new file mode 100644 index 0000000..048c8bb --- /dev/null +++ b/chapters/master_screen.typ @@ -0,0 +1,2 @@ +#import "/setup/models/rules_screen.typ": render-screen-chapter +#render-screen-chapter() diff --git a/data/config/build.yaml b/data/config/build.yaml index 638ccf0..5e43cd2 100644 --- a/data/config/build.yaml +++ b/data/config/build.yaml @@ -73,6 +73,7 @@ presets: - rules # Content-level switches (they do not create standalone chapters). - origin-lore + - master-screen # - origin-artwork - races - creation diff --git a/data/src/master_screen.yaml b/data/src/master_screen.yaml new file mode 100644 index 0000000..f581706 --- /dev/null +++ b/data/src/master_screen.yaml @@ -0,0 +1,85 @@ +title: Écran du maître de jeu +subtitle: Référence rapide — Ravenous +panels: + - title: Résoudre une action + accent: blood + sections: + - title: Jet de compétence + source: Règles de base + items: + - Lancez le dé déterminé par la difficulté. Le résultat doit être inférieur ou égal à la caractéristique et à la compétence pertinentes. + - Une spécialité s'ajoute à la compétence et peut réduire le degré de difficulté selon son symbole. + - Sans la compétence requise, appliquez les restrictions prévues par la règle d'absence de compétence. + - title: Lecture rapide + items: + - Fixez l'intention, les conséquences et la difficulté avant le jet. + - Un critique doit modifier sensiblement la situation, pas seulement ajouter un bonus numérique. + - La narration et la préparation peuvent déplacer la difficulté avant que les dés ne soient lancés. + - title: Échelle des personnages + source: Feuille de personnage + items: + - Les caractéristiques humaines se situent généralement entre 1 et 5. + - Les chasseurs dépassent cette échelle grâce à leur origine, leur marque et leur évolution. + + - title: Tour de combat + accent: gold + sections: + - title: Économie d'actions + source: Feuille de personnage — Actions + items: + - Un personnage dispose de quatre actions. + - Il peut effectuer au maximum deux attaques, deux déplacements et deux défenses. + - Sans action restante, il ne peut plus agir ni réagir, mais peut encore se jeter à terre. + - title: Initiative + source: Règles en combat + items: + - Déterminez la préparation et l'ordre interne avant le premier échange. + - Dépensez les actions en tenant compte des réactions, interruptions et fractions d'instant. + - Annoncez clairement les attaques qui laissent une fenêtre d'interruption. + - title: Mouvement + source: Mouvement + items: + - Le déplacement terrestre dépend de l'Agilité; le demi-déplacement en vaut la moitié arrondie au supérieur et la course en vaut le triple. + - Les vitesses aquatique et aérienne valent normalement la moitié de la vitesse terrestre. + + - title: Attaquer et survivre + accent: blood + sections: + - title: Attaque + source: Règles en combat — Attaque + items: + - Identifiez la réserve, le seuil, la localisation visée et le nombre maximal de réussites. + - Résolvez ensuite la défense, les dégâts, les résistances et les altérations dans cet ordre logique. + - Une attaque localisée subit les contraintes de ciblage prévues par son profil. + - title: Défenses + source: Parade, esquive et repositionnement + items: + - La parade bloque ou dévie; l'esquive évite; le repositionnement transforme aussi la position future. + - Vérifiez que la défense choisie est autorisée contre l'attaque et que le personnage possède encore une action défensive. + - title: Dégâts et protection + source: Calcul des dégâts + items: + - Appliquez protection, résistances, faiblesses et encaissement selon la nature de l'attaque. + - La brise-armure crée un point faible localisé; seules les attaques visant ce point en profitent. + - À zéro point de vie, une localisation vitale met le personnage en péril; une localisation non vitale reste limitée par les altérations reçues. + + - title: Feuille du chasseur + accent: gold + sections: + - title: Caractéristiques + source: Feuille de personnage + items: + - Force — puissance physique et armes lourdes. + - Agilité — acrobaties, mouvement et armes légères. + - Perception — sens et armes à distance. + - Intelligence — logique, connaissances et artisanat. + - Volonté — endurance mentale et résistance à la terreur. + - Psy — domaine arcane et pouvoirs élémentaires. + - Chance — événements hors du contrôle du personnage. + - Charisme — éloquence et influence pacifique. + - title: Réserves à surveiller + items: + - Jauge — sangressence disponible pour les techniques; elle revient entre les combats. + - Toxicité — la réserve naturelle est de 8 et augmente de 1 par stade d'évolution de la marque. + - Sang — ressource dépensée pour acquérir des techniques d'école. + - Fatigue — limite les efforts prolongés et l'usage continu des pouvoirs. diff --git a/main.typ b/main.typ index 6e05e89..8c422a2 100644 --- a/main.typ +++ b/main.typ @@ -35,6 +35,7 @@ #if chapter-enabled("character_sheet") { include "chapters/character_sheet.typ" } +#if chapter-enabled("master-screen") { include "chapters/master_screen.typ" } #if chapter-enabled("experience-gains") { include "chapters/experience_gains.typ" diff --git a/master_screen.typ b/master_screen.typ new file mode 100644 index 0000000..2547768 --- /dev/null +++ b/master_screen.typ @@ -0,0 +1,2 @@ +#import "/setup/models/rules_screen.typ": render-printable-screen +#render-printable-screen() diff --git a/setup/build_config.typ b/setup/build_config.typ index 1589593..8625a42 100644 --- a/setup/build_config.typ +++ b/setup/build_config.typ @@ -10,7 +10,7 @@ "title", "acknowledgements", "presentation", "geography", "hunters-and-calamities", "origins", "schools", "crafting", "races", "rules", "creation", "character_sheet", "experience-gains", - "game-master-help", "bestiary", + "game-master-help", "bestiary", "master-screen", // Content-level switches: validated like chapters without creating headings. "origin-lore", "origin-artwork", ) diff --git a/setup/models/rules_screen.typ b/setup/models/rules_screen.typ new file mode 100644 index 0000000..372596f --- /dev/null +++ b/setup/models/rules_screen.typ @@ -0,0 +1,88 @@ +#import "/setup/setup.typ": theme + +#let screen-data = yaml("/data/src/master_screen.yaml") + +#let accent-color(name) = if name == "gold" { theme.dark-gold } else { theme.blood } + +#let screen-section(section, compact: false) = { + let size = if compact { 8.2pt } else { 9.5pt } + block( + width: 100%, + breakable: false, + inset: (x: 0.75em, y: 0.65em), + radius: 0.35em, + fill: theme.parchment-light, + stroke: 0.55pt + theme.border, + )[ + #text(size: size + 1.2pt, weight: "bold", fill: theme.heading)[#section.title] + #if "source" in section [ + #h(0.4em) + #text(size: size - 1.2pt, style: "italic", fill: theme.muted)[#section.source] + ] + #v(0.3em) + #set text(size: size) + #set par(first-line-indent: 0pt, spacing: 0.35em, leading: 0.58em) + #for item in section.items [ + #grid(columns: (0.8em, 1fr), gutter: 0.2em, [#text(fill: theme.gold)[◆]], [#item]) + #v(0.22em) + ] + ] +} + +#let screen-panel(panel, compact: false) = { + let accent = accent-color(panel.accent) + block( + width: 100%, + inset: if compact { 0.7em } else { 1em }, + radius: 0.5em, + fill: theme.parchment, + stroke: 1pt + accent, + )[ + #align(center)[ + #text( + size: if compact { 14pt } else { 18pt }, + weight: "bold", + fill: accent, + )[#panel.title] + ] + #v(0.5em) + #if compact { + for section in panel.sections { + screen-section(section, compact: true) + v(0.45em) + } + } else { + grid( + columns: 1fr, + gutter: 0.65em, + ..panel.sections.map(section => screen-section(section)), + ) + } + ] +} + +#let render-screen-chapter() = [ + = #screen-data.title + #text(style: "italic", fill: theme.muted)[#screen-data.subtitle] + #v(0.8em) + #grid( + columns: (1fr, 1fr), + gutter: 0.8em, + ..screen-data.panels.map(panel => screen-panel(panel, compact: true)), + ) + #pagebreak() +] + +#let render-printable-screen() = { + set page( + paper: "a4", + margin: 10mm, + fill: theme.parchment-light, + ) + set text(font: "Libertinus Serif", lang: "fr", fill: theme.ink) + set par(justify: true) + for (index, panel) in screen-data.panels.enumerate() { + screen-panel(panel) + if index < screen-data.panels.len() - 1 { pagebreak() } + } +}