ravenous_roll20/craft_web
Dandaedre 2d2c7cf501
Roll20 Sheet Build Successful The Ravenous Roll20 sheet was generated and validated successfully.
Ravenous/ravenous_roll20/pipeline/head This commit looks good Details
docs: plan craft workshop subproject
2026-09-19 21:37:39 +02:00
..
AGENT.md docs: plan craft workshop subproject 2026-09-19 21:37:39 +02:00
AGENTS.md docs: plan craft workshop subproject 2026-09-19 21:37:39 +02:00
README.md docs: plan craft workshop subproject 2026-09-19 21:37:39 +02:00
TASKS.md docs: plan craft workshop subproject 2026-09-19 21:37:39 +02:00

README.md

Ravenous Craft Workshop

This subproject will build a static, offline-capable website for composing, checking, saving, sharing, and exporting Ravenous crafts. It is intentionally kept inside this repository so that every published catalog is generated from the exact ravenous_typst revision used by the Roll20 sheet.

The intended implementation is deliberately boring to deploy:

  • Python 3.11 generates normalized JSON and the static bundle;
  • the browser application uses dependency-free HTML, CSS, and JavaScript;
  • no Node.js, application server, database, account, or CDN is required;
  • Jenkins can build it on FreeBSD 13 and publish it below RPG/;
  • recipes work offline and remain on the player's device unless explicitly downloaded, copied, or encoded in a share link/QR code.

The product scope and implementation phases are in TASKS.md. The authoritative development rules and source map are in AGENTS.md.

Proposed user experience

The home screen is a searchable catalog and recipe workspace. A player chooses one of Forge, Restauration, Alchimie, Brasserie, or Pièges, enters their artisan limits, then adds compatible components. Totals, derived output, constraints, and warnings update immediately. Filters include mastery/tier, difficulty, toxicity, cost, finishing budget, equipment category, and discipline-specific values such as satiety, titrage, or preparation time.

Recipes can be named, duplicated, pinned, sorted, and stored locally. They can be exported as:

  • an editable Ravenous Workshop recipe file;
  • finalized ravenous-roll20-craft version 1 JSON;
  • a print-friendly recipe card;
  • a compact link or QR code when the encoded recipe fits safely.

Import accepts Workshop recipes and Roll20 craft JSON. Roll20 imports are treated as finalized items and may not be fully reversible into source ingredients.

Architecture boundary

ravenous_typst remains the rules and content authority. The generator will read its TSV files, data/src/db/weapons.db, glossary YAML, theme definitions, and data/config/recipes.yaml. Browser code consumes only generated normalized data; it must not contain a second hand-maintained copy of ingredients or rules.

The website's editable recipe document and the Roll20 exchange document serve different purposes:

  • ravenous-workshop-recipe records selected source components, user inputs, and source-data version so the recipe can be reopened and recalculated;
  • ravenous-roll20-craft records final sheet rows accepted by the existing Mod importer and JSON Schema.

That separation is a proposed design decision and is called out for approval in Phase 0 of the task list.