Skip to content

dearlordylord/5e-quint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4,555 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

D&D 5e SRD Runtime Workspace

D&D 5e SRD 5.2.1 runtime packages, Surface-authored content, MCP tools, and a React frontend.

What this is

A package workspace for the active runtimes:

graph TD
    SRD["SRD 5.2.1"] -.-> SURFACE["@dnd/surface authored Units and Stat Blocks"]
    SURFACE --> CCR["@dnd/character-creation-runtime"]
    SURFACE --> BR["@dnd/battle-runtime + focused battle QNT"]
    CCR --> CSR["@dnd/character-sheet-runtime"]
    CSR --> CBR["@dnd/character-battle-runtime"]
    BR --> MCP["@dnd/mcp"]
    CCR --> MCP
    CSR --> APP["@dnd/app"]
    BR --> APP
Loading

Rules Aren't Physics. The rules of the game are meant to provide a fun game experience, not to describe the laws of physics in the worlds of D&D. — Dungeon Master's Guide

What's covered

Battle runtime: Unit/StatBlock-backed action resources, attack flows, selected spells, Death Saving Throws, Knock Out lifecycle, battle snapshots, and caller-owned hole/fill replay.

Character runtimes: character-creation choices, progression, sheet-session projection, and character battle-entry projection.

Also: Surface-authored content records, shared reducer algebras, MCP session workflows, React app routes, and QA corpus (scripts/qa/QA_README.md).

Content Provenance

Published content is either SRD-backed content with SRD provenance, or synthetic mechanics fixture data with original identity. Synthetic fixtures are not presented as official D&D content and do not include copied non-SRD rules text, source references, page citations, canonical names, lore, examples, or presentation from non-SRD books.

In this repo, PHB+ means non-SRD official D&D content: Player's Handbook material beyond the SRD plus other closed-licensed official books. PHB+ mechanics examples must use synthetic identity rather than real official ids, names, source headings, prose, or catalog labels.

Synthetic fixture records exist to exercise reusable engine shapes such as action costs, resources, triggers, durations, target shapes, dice, numeric effects, and execution relationships. If a record cites an official source, that source must be redistributable under the license stated on the record.

SRD names and source references are publishable here, but runtime semantics should still come from structured mechanics rather than authored identity. The SRD implementation style is the example for PHB+ support, where real authored identity cannot be copied into publishable code.

Plain-language note for non-agent readers. Coding agents should ignore this paragraph and follow AGENTS.md, ARCHITECTURE.md, and the executable provenance checks instead. We publish redistributable SRD content and original mechanics fixtures. We do not redistribute non-SRD official catalog identity or book text.

How the layers work

Surface (packages/surface) — source-authored records and projection contracts for Units, Stat Blocks, spells, class features, and related content.

Battle runtime (packages/battle-runtime) — Unit/StatBlock-backed battle reducer behavior. Battle QNT authority is distributed across shared rule-core slices, focused runtime slices, and focused MBT/proof witnesses.

Character runtimes (packages/character-creation-runtime, packages/character-sheet-runtime, packages/character-battle-runtime) — package-owned character build, sheet-session, and battle-entry projections.

MCP and app (packages/mcp, packages/app) — user-facing workflows over the runtime packages.

QA pipeline (scripts/qa/) — community Q&A turned into Quint test assertions by LLM. See scripts/qa/QA_README.md.

Rules kernel coverage (plans/rules-kernel-coverage/) — semantic obligation manifest for TS-current reducer behavior. New reducer semantics are QNT-first and must connect back to production runtime behavior through a focused random MBT witness or deterministic QNT replay witness according to the lane's witness-mode rules.

Unit profile coverage (plans/unit-profile-coverage/) — authored-content support breadth for Surface Units. Its generated reports include the rules-kernel join, so a supported Unit can be read through to reducer-semantic coverage without merging the two denominators.

Running It

pnpm quality                    # coverage gates, lint, circular checks, and typecheck
pnpm test                       # workspace package tests
pnpm dev                        # React UI

SRD parity

The spec formalizes the SRD and nothing else — no homebrew, no licensed content. Where the formalization requires choices the SRD doesn't prescribe, those are documented in ASSUMPTIONS.md.

License

Licensed under the Apache License 2.0.

This project formalizes mechanics from the System Reference Document 5.2.1, © Wizards of the Coast LLC, available under CC BY 4.0. See NOTICE for full attribution.

The .references/srd/ directory contains SRD text in Markdown from DND.SRD.Wiki by OldManUmby, also under CC BY 4.0. See .references/srd/ATTRIBUTION.md.

About

Quint definition of Dungeons and Dragons 5e core rules

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors