|
|
||
|---|---|---|
| .. | ||
| schemas | ||
| src | ||
| tests | ||
| tools | ||
| AGENT.md | ||
| AGENTS.md | ||
| README.md | ||
| TASKS.md | ||
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
/mnt/assets/ravenous_roll20/; - 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.
Current application
The deployable application includes the complete generated catalogue, all book themes, responsive filtering and sorting, a single-discipline component workspace, player limits and warnings, persistent personal ingredients, a searchable local recipe library, editable recipe import/export, whole-library backup/restore, print output, and Roll20 JSON download or clipboard export.
Recipes and custom ingredients live only in the current browser profile. Clear site data only after downloading a library backup. Forge compatibility and statistics, trap adjudication, and repeated-effect edge cases remain visibly marked for manual book/GM review until the reference rules model is complete.
uv run python craft_web/tools/build.py
uv run python -m unittest discover -s craft_web/tests -v
uv run python craft_web/tools/build.py --check
Jenkins publishes production at
/mnt/assets/ravenous_roll20/ravenous_craft/, with _candlelight and
_lighthouse siblings for development and review branches.
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-craftversion 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-reciperecords selected source components, user inputs, and source-data version so the recipe can be reopened and recalculated;ravenous-roll20-craftrecords 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.