@archivist-gg/dnd5e
v0.3.29
Published
The fifth edition (2014 and 2024) rules pack of Archivist, the fifth edition toolkit for Obsidian: parsers, schemas, codecs and types for every entity type, the dice, formula and tag machinery, the player-character engine, and the bundled SRD content. Bui
Downloads
3,134
Readme
@archivist-gg/dnd5e
The fifth edition (2014 and 2024) rules pack of Archivist, the fifth edition toolkit for Obsidian: parsers,
schemas, codecs and types for every entity type, the dice, formula and tag machinery, the
player-character engine, and the bundled SRD content. Built on @archivist-gg/core.
What's inside
- Entity types: armor, background, class, subclass, race, feat, optional-feature, item,
weapon, monster, npc and spell. Each has a parser, a zod schema, a codec and
TypeScript types, exposed as
@archivist-gg/dnd5e/<entity>/*subpath exports. - Rules engine (
dnd/*): ability math, proficiency and XP, the formula and inline-tag grammar, resource dice, and brace-tag conversion. - Player characters (
pc/*): parse, resolve and recalc a character into derived stats (AC, saves, skills, speeds, attacks, spellcasting, resources, rests), plus the decision engine, equipment and slotting, item benefits and conditions. - SRD data: the System Reference Document 5.1 and 5.2, loadable through
srd-store.
Common entry points are re-exported from the package root; everything else is available through subpath exports.
Install
npm install @archivist-gg/dnd5eIt brings @archivist-gg/core, js-yaml and zod with it.
import { parseMonster, dnd5ePack } from "@archivist-gg/dnd5e";
import { parsePC } from "@archivist-gg/dnd5e/pc/pc.parser";Licence
- The package: from version 0.3.24 on, freeware: copyright Shinoobi, all rights reserved, free to download and use, but you may not modify, sell or redistribute it. See LICENSE. Versions up to 0.3.19 were published under the MIT License. The source code is not public.
- The bundled SRD data: System Reference Document 5.1 and 5.2 by Wizards of the Coast LLC, licensed under CC-BY-4.0. The package's licence does not restrict it. See LICENSES/SRD.md for the attribution.
