Vault Herald
Command-line tool, tabletop game tools
Coming soon Working name
Publish your Obsidian world to Foundry VTT and a player wiki, minus the GM secrets.
vault-herald check
Vault Herald check: ~/vault-edge
43 notes: 23 public, 5 players, 2 gm, 13 private
Needs attention (8): these notes look meant to publish but were kept private
Classify/Empty Audience.md empty-audience: audience is empty
Classify/Unknown Table.md unknown-table: table "kraken" is not defined in the config
...
SPOILER TRIPWIRE: 1 critical hit. Nothing may be published.
Spoilers/Ungated Reveal.md:5 "the tidecaller" [public, players]
everyone knows the old tales of the tidecaller's fleet.
To fix: wrap the text in %%gm%% ... %%/gm%%, change the note's audience, or, if the mention is
safe, add spoiler_ok: [the term] to that note's frontmatter.
Where it stands
In development, not released. The publishing core, the init, check and build commands, the Foundry VTT module output and the per-table wiki output work today, with property-tested and fuzzed leak checks on every link. Next up: packing Foundry compendiums, handout PDFs and an Obsidian plugin.
Vault Herald turns an Obsidian vault into a Foundry VTT module with player and GM compendiums, plus a player wiki for each table (ready for Quartz), all from the same notes. It fails closed: nothing publishes until a note says who may read it, GM-only text can hide inside a note, and a spoiler tripwire stops the build if a phrase you listed would reach players.
Who it's for
Game masters who keep their world in Obsidian and want to share parts of it with players without hand-copying notes or risking a spoiler.
What it does
- Fail-closed by default: nothing publishes until a note says who may read it. A gate you forget to close hides the rest of the note instead of leaking it, and a link to a hidden note never shows its title.
- Hide part of a note: wrap GM-only or players-only text, and the same rules apply to every output.
- Spoiler tripwire: list the phrases that would spoil your game. If one would reach players, nothing publishes, and you get the file, line and phrase. The built files are checked a second time.
- One vault, every table: a Foundry VTT module with player and GM compendiums, plus a Quartz-ready player wiki for each tier and each table.
- Local and private: no account, no server, no telemetry. It reads your files and writes plain files.
What it keeps, and where
Vault Herald reads your files and writes plain files. No account, no server, no telemetry, and no network use at all.
- Network use
- None of its own.
- What reaches Lanternwright
- Nothing.
The full Vault Herald privacy section
Obsidian and Foundry Virtual Tabletop are trademarks of their respective owners, and Quartz is an independent open source project. Vault Herald is not affiliated with or endorsed by any of them.