@datasworn-community/elegy

Datasworn JSON data for Elegy 3.5, a solo roleplaying game of vampires.


License
CC-BY-NC-SA-4.0
Install
npm install @datasworn-community/elegy@0.3.1

Documentation

Datasworn Elegy

Datasworn source data and generated package artifacts for Elegy 3.5, a solo roleplaying game of vampires by moro de oliveira.

This repository builds the Elegy 3.5 YAML source data into a publishable npm package with @datasworn-community/build-tools.

The published package provides Datasworn JSON data for Elegy 3.5.

Raw JSON

Generated raw Datasworn JSON is committed in generated-datasworn/ for users who want to download or browse files directly from GitHub.

Use generated-datasworn/manifest.json to see the current generated file, package name, schema line, license, and dependency metadata for each content package.

Quick Start

bun install
bun run build
bun run validate

Generated artifacts are written to:

  • generated-datasworn/elegy.json
  • datasworn/elegy/elegy.json
  • dist/packages/elegy/

The dist/packages/elegy directory is the npm package artifact generated by build-tools. Do not edit generated files by hand; edit source_data/elegy/ and datasworn.config.yaml, then rebuild.

Documentation

Project notes:

Repository Layout

source_data/elegy/     Datasworn source YAML you edit
datasworn.config.yaml  Build and package metadata
generated-datasworn/   Generated raw JSON committed for GitHub users
datasworn/             Generated built JSON, ignored by git
dist/packages/         Generated npm package artifacts, ignored by git
.github/workflows/    Build and release workflow callers

How Publishing Works

The shared release workflows compare generated package artifacts against the latest published version on the same Datasworn schema line. Changed packages are published; unchanged packages are skipped.

Experimental canaries are enabled by applying the release_experimental label to a pull request. Removing the label stops future publishes. The per-PR dist-tags remain after the PR closes as convenience aliases; use the exact canary version from the PR comment for reproducible installs.

Before publishing, read Publishing.

Contributing

Org-wide conventions — where to open PRs, release labels, shared CI — live in the Datasworn Community CONTRIBUTING guide.