Skip to content

Getting Started

Blaze source lives in the Adventure Kit repository. Use Node.js 20.19+ or 22.12+, install the pinned dependencies, then run the compiler against the checked-in example world.

bash
git clone https://github.com/track-forge/adventure-kit.git
cd adventure-kit
npm ci
npx tsx scripts/blaze.ts check examples/blaze/adirondack-mystery/main.blaze

A successful check validates Blaze source and its closed WorldBundle contract. Build only when you want a refreshed JSON bundle:

bash
npx tsx scripts/blaze.ts build examples/blaze/adirondack-mystery/main.blaze \
  --out /tmp/adirondack-mystery.blaze.json

Local documentation

The documentation site is a VitePress app rooted at docs/site.

bash
npm run build:docs
npm run preview:docs

build:docs writes static files to docs/dist-docs. preview:docs serves that production build locally so routing and asset URLs match a deployed static host.

Next reading

  • Language Guide for modules, declarations, lowering, and authoring direction.
  • Reference for coverage, inspect, and source patch commands.
  • Examples for the Adirondack Mystery port and design witnesses.

BARKLINE mark is served from a local, hash-pinned repository asset.