index

Iron Vault is organized around campaigns. A single vault can have many campaigns, and, even if you only plan to run a single campaign in your vault, you'll still create a single root campaign.

A campaign is a folder (called the campaign root folder) with a campaign index file in its root. All files (including those within subfolders) within the campaign root folder are considered part of the campaign. In particular, all Tracked Entities for a campaign, such as Characters, Progress Tracks, and Clocks, must exist somewhere within the campaign root folder tree.

Campaigns cannot be nested

Because campaigns include all files underneath them, one campaign cannot be nested within another. If Iron Vault detects this situation, you will see an error message when you attempt to use most Iron Vault features.

To create a new campaign, use the Creating a campaign command. This will create a campaign index file in a new or existing folder you designate. You can also edit a campaign to change its properties later.

Campaign file frontmatter

Your campaign file contains a frontmatter property called ironvault. This contains important data about your campaign configuration that is not intended for manual editing. Use caution when editing the frontmatter of your campaign file.

Playset

The most important property of a campaign is its Playset. The playset defines which Rulesets and Homebrew content is available in your campaign. Whenever your campaign is active, your playset determines what moves, oracles, and assets are available within the various commands, sidebars, and views.

Active campaign and active character

When you are viewing a file that is within a campaign, that campaign becomes the active campaign. The active campaign provides a context for many operations within Iron Vault, such as which progress tracks to list and what moves/oracles are available.

Active character is tracked per campaign, so when the active campaign switches, the active character will switch to the most recent active character within that campaign.

Organizing your vault

If you only plan to use this vault for a single campaign, you can create a campaign in the root folder. This is the simplest setup, as it means that everything in the vault will be part of that one campaign.

If you plan to use this vault for multiple campaigns, you need to give each campaign its own separate folder. There are a variety of ways to organize this:

  • Make each campaign a subfolder of the root folder: this is the default setup for the plugin and avoids excessive nesting.
  • Make each campaign a subfolder of a "Campaigns" folder: use this if you'd like to keep your top-level folder more organized.
  • Group your campaigns in some more complicated way: you're free to organize your campaign folders however you wish, as long as you follow the rule that each campaign gets its own folder.
Table Of Contents
index
Playset
Active campaign and active character
Organizing your vault