ravenous_typst/docs/builds/reports/README.md

1.5 KiB

Building the balance reports

Back to the project README

Player-facing report

Build the standard balance-analysis report with:

typst compile balance_report.typ balance_report.pdf

Its enabled sections are configured in data/config/balance_report.yaml.

Master report

Build the standalone master creature-analysis report with:

typst compile balance_report_master.typ balance_report_master.pdf

Its sections are enabled in data/config/balance_report_master.yaml. Configure the advanced creature-by-creature analysis there:

advanced_balance:
  creature_ids: []            # Every master-visible creature
  show_extra: true            # Include alternate player stances
  show_balanced: true         # Keep rows already matching their targets

creature_ids only narrows the master-visible collection. It never overrides show_to_master, so requesting a hidden or unknown ID cannot expose it.

The advanced section reproduces the combat model from rust_base/monsters. It compares success depth and defensive thresholds within each Difficulty, measures one- and two-success damage, estimates defensive survival chances, checks each player stance against an unmitigated hit, and proposes attack archetypes. Inferred labels are shown beside, rather than substituted for, the attack type declared in the database.

In CI, the master report is compiled to a temporary plaintext PDF, protected with qpdf and MASTER_PASSWORD, and published as the encrypted Report/Ravenous_master_balance_report_build.pdf artifact.