Skip to content

Commit

Permalink
update and rerender docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@zkat
zkat committed Jul 16, 2024
1 parent a14d056 commit 7e5aea4
Show file tree
Hide file tree
Showing 43 changed files with 3,678 additions and 1,380 deletions.
71 changes: 17 additions & 54 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,79 +2,42 @@

![Iron Vault](./docs/Support/img/iron-vault-screenshot.png)

Obsidian plugin to play Ironsworn/Starforged system games, using the data in
[datasworn](https://github.com/rsek/datasworn) format.
Obsidian plugin to play Ironsworn/Starforged system games, using the data in [datasworn](https://github.com/rsek/datasworn) format.

This owes a lot to [Eric Bright's
Forged_in_Obsidian](https://github.com/ericbright2002/Forged_in_Obsidian)
template vault. I started with that vault and then gradually replaced
functionality with this plugin.
This owes a lot to [Eric Bright's Forged_in_Obsidian](https://github.com/ericbright2002/Forged_in_Obsidian) template vault. I started with that vault and then gradually replaced functionality with this plugin.

## Documentation

The full documentation is available on the docs site at
https://ironvault.quest/. It covers all current (and some
future!) features of the plugin, how to use them, and even lets you search to
find what you're looking for.
The full documentation is available on the docs site at https://ironvault.quest/. It covers all current (and some future!) features of the plugin, how to use them, and even lets you search to find what you're looking for.

## Features

You can start reading about the various Iron Vault features here:

* [Built-in Official Rulesets](https://ironvault.quest/other-features/rulesets-and-homebrew.html#Built-in_Rulesets) - Includes support for Ironsworn Classic, Ironsworn: Delve, Ironsworn: Starforged, and Sundered Isles.
* [Blocks](https://ironvault.quest/blocks/about-blocks.html) -
Special blocks used throughout the tool to render things nicely and give you
handy interactive widgets for editing game data.
* [Commands](https://ironvault.quest/commands/about-commands.html) -
Various Obsidian commands, all of which can be bound to hotkeys or the
quick access bar, for performing all sorts of game actions, like making
moves, creating progress tracks, etc.
* [Entities](https://ironvault.quest/entities/about-entities.html) -
How Iron Vault represents all sorts of different game concepts, or some
ways that you might choose to represent them yourself.
* [Blocks](https://ironvault.quest/blocks/about-blocks.html) - Special blocks used throughout the tool to render things nicely and give you handy interactive widgets for editing game data.
* [Commands](https://ironvault.quest/commands/about-commands.html) - Various Obsidian commands, all of which can be bound to hotkeys or the quick access bar, for performing all sorts of game actions, like making moves, creating progress tracks, etc.
* [Entities](https://ironvault.quest/entities/about-entities.html) - How Iron Vault represents all sorts of different game concepts, or some ways that you might choose to represent them yourself.
* [Multiple Campaigns](https://ironvault.quest/other-features/campaigns.html) - You can have one or more campaigns in a single vault!
* [Multiplayer](https://ironvault.quest/other-features/multiplayer.html) - Play online or locally with other players!
* [Sidebar](https://ironvault.quest/other-features/sidebar.html) -
A handy right-panel sidebar for quick access to Moves, Oracles, and your
Character Sheet, all in one, easy-access place. Particularly useful on
mobile.
* [Special
Links](https://ironvault.quest/other-features/special-links.html) -
There are special external links that, instead of trying to open a web
page, will open a modal window with the contents of the thing you're trying
to link to. For example, `[My Move](move:MyMoveName)` will pop up a window
with the description and roll buttons for "My Move".
* [CSS
Tweaks](https://ironvault.quest/other-features/css-tweaks.html) -
Styling tweaks to make some things look nicer or more customized, such as
the `iron-vault-embed` option for inlining embeds.
* [Sidebar](https://ironvault.quest/other-features/sidebar.html) - A handy right-panel sidebar for quick access to Moves, Oracles, and your Character Sheet, all in one, easy-access place. Particularly useful on mobile.
* [Special Links](https://ironvault.quest/other-features/special-links.html) - There are special external links that, instead of trying to open a web page, will open a modal window with the contents of the thing you're trying to link to. For example, `[My Move](move:MyMoveName)` will pop up a window with the description and roll buttons for "My Move".
* [CSS Tweaks](https://ironvault.quest/other-features/css-tweaks.html) - Styling tweaks to make some things look nicer or more customized, such as the `iron-vault-embed` option for inlining embeds.
* [Callouts](https://ironvault.quest/other-features/callouts.html) - Special formatting and generation for game-related callouts.
* [Homebrew](https://ironvault.quest/other-features/rulesets-and-homebrew.html#Homebrew) - BYO Rulesets! Import custom assets, oracles, or even entire rulesets/games that conform to the [Datasworn](https://github.com/rsek/datasworn) data model.
* [Settings](https://ironvault.quest/other-features/settings.html) -
Various configurations available to tweak your Iron Vault experience.
* [API](https://ironvault.quest/other-features/api.html) -
(Coming Soon) Are you a developer? We expose the plugin for easy access, for
folks who want to do fancier things with Iron Vault features.
* [Settings](https://ironvault.quest/other-features/settings.html) - Various configurations available to tweak your Iron Vault experience.
* [API](https://ironvault.quest/other-features/api.html) - (Coming Soon) Are you a developer? We expose the plugin for easy access, for folks who want to do fancier things with Iron Vault features.

## Installing the plugin

For now, the easiest way to install is via
[BRAT](https://tfthacker.com/brat-plugins). You should be able to add this
repo to BRAT, and it will install the latest release of this plugin
For now, the easiest way to install is via [BRAT](https://tfthacker.com/brat-plugins). You should be able to add this repo to BRAT, and it will install the latest release of this plugin

You can also install it manually by downloading the latest files from [Github
Release](https://github.com/iron-vault-plugin/iron-vault/releases/latest). You'll want
to put `main.js`, `manifest.json`, and `styles.css` in
`your-vault/.obsidian/plugins/iron-vault`.
You can also install it manually by downloading the latest files from [Github Release](https://github.com/iron-vault-plugin/iron-vault/releases/latest). You'll want to put `main.js`, `manifest.json`, and `styles.css` in `your-vault/.obsidian/plugins/iron-vault`.

To build the code and copy it to your vault yourself, run `pnpm install` and `pnpm build` to
generate the production files, which will be in the repo root. You can then
copy these to the location above.
To build the code and copy it to your vault yourself, run `pnpm install` and `pnpm build` to generate the production files, which will be in the repo root. You can then copy these to the location above.

You should then be able to enable the plugin in your vault (after
restarting/reloading Obsidian).
You should then be able to enable the plugin in your vault (after restarting/reloading Obsidian).

## Contributing

Iron Vault is a community project built by players, for players, and we
welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for
details.
Iron Vault is a community project built by players, for players, and we welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
63 changes: 32 additions & 31 deletions docs-built/blocks/asset-blocks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@
<header>
<dl>
<dt>Type</dt>
<dd class="category"><!--?lit$460537879$-->Command Vehicle</dd>
<dd class="category"><!--?lit$882568454$-->Command Vehicle</dd>
<dt>Name</dt>
<dd class="name"><!--?lit$460537879$-->Starship</dd>
<!--?lit$460537879$-->
<!--?lit$460537879$-->
<!--?lit$460537879$-->
<dd class="name"><!--?lit$882568454$-->Starship</dd>
<!--?lit$882568454$-->
<!--?lit$882568454$-->
<!--?lit$882568454$-->
<dt>Options</dt>
<dd class="options">
<ul>
<!--?lit$460537879$--><!---->
<!--?lit$882568454$--><!---->
<li>
<dl>
<dt class="option-name"><!--?lit$460537879$-->name</dt>
<dt class="option-name"><!--?lit$882568454$-->name</dt>
<dd>
<label><span><!--?lit$460537879$-->name</span> <!--?lit$460537879$--><input type="text" disabled="" placeholder="name" value=""></label>
<label><span><!--?lit$882568454$-->name</span> <!--?lit$882568454$--><input type="text" disabled="" placeholder="name" value=""></label>
</dd>
</dl>
</li>
Expand All @@ -45,41 +45,41 @@
</header>
<section>
<ul class="abilities">
<!--?lit$460537879$--><!----><li>
<!--?lit$882568454$--><!----><li>
<label>
<input type="checkbox" disabled="" checked="">
<span><!--?lit$460537879$--><!--?lit$460537879$--><div class="markdown-wrapper"><p dir="auto">Your armed, multipurpose starship is suited for interstellar and atmospheric flight. It can comfortably transport several people, has space for cargo, and can carry and launch support vehicles. When you <a data-tooltip-position="top" aria-label="move:starforged/legacy/advance" rel="noopener" class="external-link" href="move:starforged/legacy/advance" target="_blank">Advance</a>, you may spend experience to equip this vehicle with module assets.</p></div><!--?--></span>
<span><!--?lit$882568454$--><!--?lit$882568454$--><div class="markdown-wrapper"><p dir="auto">Your armed, multipurpose starship is suited for interstellar and atmospheric flight. It can comfortably transport several people, has space for cargo, and can carry and launch support vehicles. When you <a data-tooltip-position="top" aria-label="move:starforged/legacy/advance" rel="noopener" class="external-link" href="move:starforged/legacy/advance" target="_blank">Advance</a>, you may spend experience to equip this vehicle with module assets.</p></div><!--?--></span>
</label>
</li><!----><!----><li>
<label>
<input type="checkbox" disabled="">
<span><!--?lit$460537879$--><!--?lit$460537879$--><div class="markdown-wrapper"><p dir="auto">When you <a data-tooltip-position="top" aria-label="move:starforged/exploration/finish_an_expedition" rel="noopener" class="external-link" href="move:starforged/exploration/finish_an_expedition" target="_blank">Finish an Expedition</a> (dangerous or greater) in your starship and score a hit, this journey strengthened your ties to your ship and any fellow travelers. You and your allies may mark 1 tick on your bonds legacy track.</p></div><!--?--></span>
<span><!--?lit$882568454$--><!--?lit$882568454$--><div class="markdown-wrapper"><p dir="auto">When you <a data-tooltip-position="top" aria-label="move:starforged/exploration/finish_an_expedition" rel="noopener" class="external-link" href="move:starforged/exploration/finish_an_expedition" target="_blank">Finish an Expedition</a> (dangerous or greater) in your starship and score a hit, this journey strengthened your ties to your ship and any fellow travelers. You and your allies may mark 1 tick on your bonds legacy track.</p></div><!--?--></span>
</label>
</li><!----><!----><li>
<label>
<input type="checkbox" disabled="">
<span><!--?lit$460537879$--><!--?lit$460537879$--><div class="markdown-wrapper"><p dir="auto">When you <a data-tooltip-position="top" aria-label="move:starforged/suffer/withstand_damage" rel="noopener" class="external-link" href="move:starforged/suffer/withstand_damage" target="_blank">Withstand Damage</a>, you may roll +heart. If you do, <a data-tooltip-position="top" aria-label="move:starforged/suffer/endure_stress" rel="noopener" class="external-link" href="move:starforged/suffer/endure_stress" target="_blank">Endure Stress</a> (-1) on a weak hit or miss.</p></div><!--?--></span>
<span><!--?lit$882568454$--><!--?lit$882568454$--><div class="markdown-wrapper"><p dir="auto">When you <a data-tooltip-position="top" aria-label="move:starforged/suffer/withstand_damage" rel="noopener" class="external-link" href="move:starforged/suffer/withstand_damage" target="_blank">Withstand Damage</a>, you may roll +heart. If you do, <a data-tooltip-position="top" aria-label="move:starforged/suffer/endure_stress" rel="noopener" class="external-link" href="move:starforged/suffer/endure_stress" target="_blank">Endure Stress</a> (-1) on a weak hit or miss.</p></div><!--?--></span>
</label>
</li><!---->
</ul>
</section>
<!--?lit$460537879$--><section class="controls-section">
<!--?lit$460537879$-->
<!--?lit$882568454$--><section class="controls-section">
<!--?lit$882568454$-->
<ul class="controls">
<!--?lit$460537879$--><!---->
<!--?lit$882568454$--><!---->
<li><div class="list-collapse-indicator collapse-indicator collapse-icon"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="svg-icon right-triangle"><path d="M3 8L12 17L21 8"></path></svg></div>
<dl>
<dt><!--?lit$460537879$-->integrity</dt>
<dt><!--?lit$882568454$-->integrity</dt>
<dd class="control">
<!--?lit$460537879$--><form class="condition-meter">
<!--?lit$460537879$-->
<!--?lit$882568454$--><form class="condition-meter">
<!--?lit$882568454$-->
<ul class="controls">
<!--?lit$460537879$--><!---->
<!--?lit$882568454$--><!---->
<li>
<dl>
<dt><!--?lit$460537879$-->battered</dt>
<dt><!--?lit$882568454$-->battered</dt>
<dd class="control">
<!--?lit$460537879$--><label class="checkbox"><span><!--?lit$460537879$-->battered</span>
<!--?lit$882568454$--><label class="checkbox"><span><!--?lit$882568454$-->battered</span>
<input type="checkbox" disabled="">
</label>
</dd>
Expand All @@ -88,9 +88,9 @@
<!----><!---->
<li>
<dl>
<dt><!--?lit$460537879$-->cursed</dt>
<dt><!--?lit$882568454$-->cursed</dt>
<dd class="control">
<!--?lit$460537879$--><label class="checkbox"><span><!--?lit$460537879$-->cursed</span>
<!--?lit$882568454$--><label class="checkbox"><span><!--?lit$882568454$-->cursed</span>
<input type="checkbox" disabled="">
</label>
</dd>
Expand All @@ -100,24 +100,24 @@
</ul>

<ul class="meter">
<li><span><!--?lit$460537879$-->integrity</span></li>
<!--?lit$460537879$--><!----><li>
<label><span><!--?lit$460537879$-->0</span><input type="radio" disabled="" value="0" name="integrity">
<li><span><!--?lit$882568454$-->integrity</span></li>
<!--?lit$882568454$--><!----><li>
<label><span><!--?lit$882568454$-->0</span><input type="radio" disabled="" value="0" name="integrity">
</label>
</li> <!----><!----><li>
<label><span><!--?lit$460537879$-->1</span><input type="radio" disabled="" value="1" name="integrity">
<label><span><!--?lit$882568454$-->1</span><input type="radio" disabled="" value="1" name="integrity">
</label>
</li> <!----><!----><li>
<label><span><!--?lit$460537879$-->2</span><input type="radio" disabled="" value="2" name="integrity">
<label><span><!--?lit$882568454$-->2</span><input type="radio" disabled="" value="2" name="integrity">
</label>
</li> <!----><!----><li>
<label><span><!--?lit$460537879$-->3</span><input type="radio" disabled="" value="3" name="integrity">
<label><span><!--?lit$882568454$-->3</span><input type="radio" disabled="" value="3" name="integrity">
</label>
</li> <!----><!----><li>
<label><span><!--?lit$460537879$-->4</span><input type="radio" disabled="" value="4" name="integrity">
<label><span><!--?lit$882568454$-->4</span><input type="radio" disabled="" value="4" name="integrity">
</label>
</li> <!----><!----><li>
<label><span><!--?lit$460537879$-->5</span><input type="radio" checked="" disabled="" value="5" name="integrity">
<label><span><!--?lit$882568454$-->5</span><input type="radio" checked="" disabled="" value="5" name="integrity">
</label>
</li> <!---->
</ul>
Expand All @@ -129,5 +129,6 @@
</ul>

</section>
<footer><!--?lit$882568454$-->Ironsworn: Starforged Assets</footer>
</article>
</div></div><div class="mod-footer"></div></div></div></div></div></div><div class="sidebar-right sidebar"><div class="sidebar-handle"></div><div class="sidebar-topbar"><div class="topbar-content"></div><div class="clickable-icon sidebar-collapse-icon"><svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" class="svg-icon"><path d="M21 3H3C1.89543 3 1 3.89543 1 5V19C1 20.1046 1.89543 21 3 21H21C22.1046 21 23 20.1046 23 19V5C23 3.89543 22.1046 3 21 3Z"></path><path d="M10 4V20"></path><path d="M4 7H7"></path><path d="M4 10H7"></path><path d="M4 13H7"></path></svg></div></div><div class="sidebar-content"><div class="tree-container mod-root nav-folder tree-item outline-tree" data-depth="0"><div class="tree-header"><span class="sidebar-section-header">Table Of Contents</span><button class="clickable-icon collapse-tree-button" aria-label="Collapse All"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></svg></button></div><div class="tree-scroll-area tree-item-children nav-folder-children"><div class="tree-item mod-tree-folder nav-folder mod-collapsible is-collapsed" style="display: none;"></div><div class="tree-item" data-depth="1"><a class="tree-link" href="blocks/asset-blocks.html#Asset Blocks"><div class="tree-item-contents heading-link" heading-name="Asset Blocks"><span class="tree-item-title">Asset Blocks</span></div></a><div class="tree-item-children nav-folder-children"><div class="tree-item" data-depth="4"><a class="tree-link" href="blocks/asset-blocks.html#Example"><div class="tree-item-contents heading-link" heading-name="Example"><span class="tree-item-title">Example</span></div></a><div class="tree-item-children nav-folder-children"></div></div></div></div></div></div></div><script defer="">let rs = document.querySelector(".sidebar-right"); rs.classList.add("is-collapsed"); if (window.innerWidth > 768) rs.classList.remove("is-collapsed"); rs.style.setProperty("--sidebar-width", localStorage.getItem("sidebar-right-width"));</script></div></div></body></html>
Loading

0 comments on commit 7e5aea4

Please sign in to comment.