mtwomey / dataforged

Official Ironsworn: Starforged rules data in JSON, for use in community tools.

Dataforged

Official Ironsworn: Starforged rules data in JSON, for use in community tools.

Intent

This repository is intended to give Starforged's Kickstarter backers access to game data to incorporate into their own Starforged tools; it has been left public in the interest of keeping it easily accessible (and, frankly, will be of limited use without the complete text of the Backer Preview).

Usage

Best consumed as a Node package: npm i dataforged or yarn add dataforged. Typescript typings are included; use of VSCode or an IDE to expose the type annotations in your workspace is highly recommended. See also the documentation site.

If you just want the data as-is, import its starforged object to use the pre-loaded, typed JSON.

ESM

import { starforged } from 'dataforged'

CommonJS

CommonJS support is still experimental.

const { starforged } = require('dataforged')

Licensing

Starforged is currently under development, and this content is not yet licensed for non-personal use without explicit permission of Shawn Tomkin. Once Starforged's development is complete and it is released, a permissive Creative Commons license for non-commercial and commercial projects will be attached to this content.

In other words: for the moment, treat it like you would excerpts from a copyrighted work; please include attribution (e.g. "Copyright ©2021 Shawn Tomkin and Absolute Tabletop, LLC") and a link back to the repository in your project... and drop a link in the Ironsworn discord, because we're excited to see what you make with it!

Current Version/Sources

• Ironsworn: Starforged Rulebook - 043022
  • moves
  • oracles
  • setting truths
  • encounters
• Ironsworn: Starforged Assets - 043022
  • assets

Credits

Dataforged began as an unofficial personal project of rsek and continues to be maintained by them in its official capacity.

Thanks to XenotropicDev for allowing me to use TheOracle (a Discord bot for use with Ironsworn and Starforged) as the nucleus of the original!