dataforged
Version:
Official content and rules data for the Ironsworn: Starforged tabletop role-playing game, formatted as JSON for use in community tools. 🚀 Includes JSON schemas and a Javascript/Typescript API.
111 lines (96 loc) • 12.9 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Dataforged API</title><meta name="description" content="Documentation for Dataforged API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Dataforged API</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> Dataforged API </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><!-- ⚠️ This README has been generated from the file(s) "./src/templates/blueprint.md" ⚠️--><h1 align="center">Dataforged v1.5.0</h1>
<p align="center">
<a href="https://www.npmjs.com/package/dataforged"><img alt="undefined" src="https://img.shields.io/npm/v/dataforged?logo=npm" height="20"/></a>
<a href="https://www.npmjs.com/package/dataforged"><img alt="undefined" src="https://img.shields.io/npm/dm/dataforged?logo=npm" height="20"/></a>
<a href="https://discordapp.com/invite/6QMvmJb"><img alt="Join the Ironsworn Discord" src="https://img.shields.io/discord/437120373436186625?color=%235865F2&label=Ironsworn%20Discord&logo=discord&logoColor=white" height="20"/></a>
<a href="https://www.reddit.com/r/Ironsworn/"><img alt="Visit the r/Ironsworn subreddit" src="https://img.shields.io/reddit/subreddit-subscribers/ironsworn?style=social" height="20"/></a>
</p>
<p align="center">
<b>Official content and rules data for the Ironsworn: Starforged tabletop role-playing game, formatted as JSON for use in community tools. 🚀 Includes JSON schemas and a Javascript/Typescript API.</b></br>
<sub><sub>
</p>
<br />
<p><a href="#whats-this-all-about-anyways"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png" alt="-----------------------------------------------------"></a></p>
<a href="#what39s-this-all-about-anyways" id="what39s-this-all-about-anyways" style="color: inherit; text-decoration: none;">
<h2>What's this all about, anyways?</h2>
</a>
<p><em>Ironsworn: Starforged</em> is a tabletop role-playing game that's playable in solo, co-op (GM-less), and guided (GMed) modes.</p>
<blockquote>
<p>In <em>Ironsworn: Starforged</em>, you are a spaceborne hero sworn to undertake perilous quests. You will explore uncharted space, unravel the secrets of a mysterious galaxy, and build bonds with those you meet on your travels. Most importantly, you will swear iron vows and see them fulfilled—no matter the cost.</p>
</blockquote>
<p>For more information on <em>Ironsworn: Starforged</em> itself, check out <a href="https://getstarforged.com/">the website</a>.</p>
<p>The Dataforged repo exists to provide the Creative Commons-licensed text and image content of <em>Ironsworn: Starforged</em>, so that you--an intrepid developer with excellent taste in indie TTRPGs--don't need to do data entry for the game's 200+ oracle tables, 90 asset cards, 56 moves, and 14 setting truth categories, and 24 example encounters.</p>
<p>Use it as source material to build a personal reference wiki, a play aid, a discord bot, or module for your favourite VTT, or something that nobody else has imagined yet. <a href="#projects-that-use-dataforged">Be sure to check out some of the projects that use Dataforged below</a>.</p>
<p>Dataforged may be useful to you even if you aren't developing something for <em>Ironsworn: Starforged</em> specifically: the overwhelming majority of its d% oracle tables are system agnostic, so they might be used for any generator or other TTRPG tool with a sci-fi/space opera flavour.</p>
<p>Now, go forth and make something cool! 🚀 And be sure to tell us about it on the <a href="https://discordapp.com/invite/6QMvmJb"><em>Ironsworn</em> Discord</a> and the <a href="https://www.reddit.com/r/Ironsworn/"><em>Ironsworn</em> subreddit</a> so we can see what you've done with the data!</p>
<p><a href="#projects-that-use-dataforged"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png" alt="-----------------------------------------------------"></a></p>
<a href="#projects-that-use-dataforged" id="projects-that-use-dataforged" style="color: inherit; text-decoration: none;">
<h2>Projects that use Dataforged</h2>
</a>
<ul>
<li><a href="https://nboughton.uk/apps/stargazer/">Stargazer</a>, the official PWA for playing <em>Ironsworn: Starforged</em> solo</li>
<li>The official <a href="https://github.com/aureyia/roll20-character-sheets">Roll20 sheet for <em>Ironsworn: Starforged</em></a></li>
<li>The <a href="https://github.com/ben/foundry-ironsworn"><em>Ironsworn</em> and <em>Ironsworn: Starforged</em> sheet for Foundry VTT</a></li>
<li><a href="https://github.com/XenotropicDev/TheOracle">TheOracle</a>, a general-purpose discord bot for playing <em>Ironsworn</em> and <em>Ironsworn: Starforged</em></li>
<li><a href="https://github.com/Ferretsroq/Starforged-Sectors">Starforged-Sectors</a>, a discord bot for generating <em>Ironsworn: Starforged</em> sectors</li>
<li><a href="https://github.com/grimborg/obsidian-ironsworn"><em>Ironsworn</em> and <em>Ironsworn: Starforged</em> templates for Obsidian</a></li>
<li>...and maybe yours? Tell us about it in the <a href="https://discordapp.com/invite/6QMvmJb"><em>Ironsworn</em> discord</a>!</li>
</ul>
<p><a href="#usage"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png" alt="-----------------------------------------------------"></a></p>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
</a>
<p>Consult the <a href="https://rsek.github.io/dataforged">API Documentation for further information</a>.</p>
<a href="#nodejs" id="nodejs" style="color: inherit; text-decoration: none;">
<h3>NodeJS</h3>
</a>
<p>If you're working in Javascript or Typescript, Dataforged is best consumed as a NodeJS package:</p>
<pre><code class="language-bash"><span class="hl-0">npm i dataforged</span>
</code></pre>
<pre><code class="language-bash"><span class="hl-0">yarn add dataforged</span>
</code></pre>
<p>Typescript typings are included; use of VSCode or an IDE to expose the type annotations in your workspace is highly recommended. See also the <a href="https://rsek.github.io/dataforged">API documentation site</a>.</p>
<p>If you just want the data as-is, import the <code>starforged</code> object to use the pre-loaded, typed JSON.</p>
<a href="#esm" id="esm" style="color: inherit; text-decoration: none;">
<h4>ESM</h4>
</a>
<pre><code class="language-javascript"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">starforged</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">'dataforged'</span>
</code></pre>
<a href="#commonjs" id="commonjs" style="color: inherit; text-decoration: none;">
<h4>CommonJS</h4>
</a>
<pre><code class="language-javascript"><span class="hl-4">const</span><span class="hl-0"> { </span><span class="hl-5">starforged</span><span class="hl-0"> } = </span><span class="hl-6">require</span><span class="hl-0">(</span><span class="hl-3">'dataforged'</span><span class="hl-0">)</span>
</code></pre>
<a href="#other-languages" id="other-languages" style="color: inherit; text-decoration: none;">
<h3>Other Languages</h3>
</a>
<p>Packages for other languages/package managers are a work in progress. For now, you can use the JSON files in <a href="dist/starforged"><code>dist/starforged</code></a>. <code>dataforged.json</code> contains all game data in a single object; <code>schema.json</code> describes its JSON schema.</p>
<p><a href="#current-content-versionsources"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png" alt="-----------------------------------------------------"></a></p>
<a href="#current-content-versionsources" id="current-content-versionsources" style="color: inherit; text-decoration: none;">
<h2>Current Content Version/Sources</h2>
</a>
<ul>
<li><strong><em>Ironsworn: Starforged Reference Guide</em> - 050622</strong><ul>
<li>moves</li>
<li>oracles</li>
<li>setting truths</li>
<li>encounters</li>
</ul>
</li>
<li><strong><em>Ironsworn: Starforged</em> Assets - 050622</strong><ul>
<li>assets</li>
</ul>
</li>
</ul>
<p><a href="#licensing"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png" alt="-----------------------------------------------------"></a></p>
<a href="#licensing" id="licensing" style="color: inherit; text-decoration: none;">
<h2>Licensing</h2>
</a>
<p>Items in this package (and its GitHub source) various fall under the CC BY 4.0, CC BY-NC 4.0, or MIT licenses. See <a href="LICENSE.md">LICENSE.md</a> for details.</p>
<p><a href="#contributors"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/cloudy.png" alt="-----------------------------------------------------"></a></p>
<a href="#contributors" id="contributors" style="color: inherit; text-decoration: none;">
<h2>Contributors</h2>
</a>
<p>Dataforged began as an unofficial personal project of <a href="https://github.com/rsek">rsek</a> and continues to be maintained by them in its official capacity.</p>
<p>Thanks to <a href="https://github.com/XenotropicDev">XenotropicDev</a> for allowing me to use <a href="https://github.com/XenotropicDev/TheOracle">TheOracle</a> (a Discord bot for use with Ironsworn and Starforged) as the nucleus of the original!</p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/Json_Assets.html">Json.<wbr/>Assets</a></li><li class=" tsd-kind-module"><a href="modules/Json_Common.html">Json.<wbr/>Common</a></li><li class=" tsd-kind-module"><a href="modules/Json_Cyclopedia.html">Json.<wbr/>Cyclopedia</a></li><li class=" tsd-kind-module"><a href="modules/Json_GameObjects.html">Json.<wbr/>Game<wbr/>Objects</a></li><li class=" tsd-kind-module"><a href="modules/Json_Meta.html">Json.<wbr/>Meta</a></li><li class=" tsd-kind-module"><a href="modules/Json_Moves.html">Json.<wbr/>Moves</a></li><li class=" tsd-kind-module"><a href="modules/Json_Oracles.html">Json.<wbr/>Oracles</a></li><li class=" tsd-kind-module"><a href="modules/Json_SettingTruths.html">Json.<wbr/>Setting<wbr/>Truths</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>