@archivist-gg/core
v0.1.1
Published
The framework layer of Archivist, the D&D toolkit for Obsidian: a small, game-system and platform agnostic TypeScript kernel that the game packs build on. It contains no game rules and no UI or platform code.
Readme
@archivist-gg/core
The framework layer of Archivist, the D&D toolkit for Obsidian: a small, game-system and platform agnostic TypeScript kernel that the game packs build on. It contains no game rules and no UI or platform code.
What's inside
- Container format (
parseContainer): parse an Archivist.mdfile (YAML frontmatter and body) into a typed document. - Contracts: the shared interfaces that a system pack and a renderer implement: entity types, codecs and the registry surface.
- Kernel (
createArchivist): assemble a set of pack contracts into a working instance. - Entity registry (
EntityRegistry): an in-memory store with cross-reference resolution for parsed entities, indexed by type and slug. - YAML utilities (
parseYaml,toStringSafe).
Everything is exported from the package root.
Install
npm install @archivist-gg/coreimport { createArchivist, EntityRegistry, parseContainer } from "@archivist-gg/core";Its only runtime dependency is js-yaml.
Licence
From version 0.1.1 on, this package is freeware: copyright Shinoobi, all rights reserved, free to download and use, but you may not modify, sell or redistribute it. See LICENSE. Version 0.1.0 was published under the MIT License. The source code is not public.
