@archivist-gg/core

The framework layer for Archivist — a small, game-system- and platform-agnostic TypeScript kernel that the game packs and renderers build on. It contains no game rules and no UI/platform code.

What's inside

• Container format (parseContainer) — parse an Archivist .md file (YAML frontmatter + 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.
• YAML utilities (parseYaml, toStringSafe).

Everything is re-exported from the package root.

Usage

@archivist-gg/core is distributed as TypeScript source (no build step). Consume it as a path/sibling dependency; its only runtime dependency is js-yaml.

// package.json
"dependencies": { "@archivist-gg/core": "file:../archivist-core" }

import { createArchivist, EntityRegistry, parseContainer } from "@archivist-gg/core";

Scripts

• npm run typecheck — tsc -b --force
• npm test — run the test suite with vitest

License

MIT — see LICENSE.