ttrpg-campaign-vault

KO | EN

gitlite — search

#javascript #python #typescript #llm #android #rust #linux #docker #macos #nodejs #awesome #awesome-list #mcp #open-source

ttrpg-campaign-vault

(★ 10)

Obsidian vault to manage your TTRPG campaigns for DMs/GMs and Players.

ttrpg-campaign-vault Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TTRPG Campaign Vault
An Obsidian vault to manage your TTRPG campaigns for DMs/GMs and Players.

Live Demo Overview https://youtu.be/ahcoVC5JkB4

## How to Install

1. Download the vault from github by clicking on Releases on the right and downloading the TTRPG-Campaign-Vault-v1.0.0.zip.
2. Unzip the file somewhere on your hard drive.
3. Download Obsidian, if you don't have it already, from [here](https://obsidian.md/).
4. Launch Obsidian.
5. Select "Open folder as vault."
6. Point Obsidian to where you unzipped the folder "TTRPG-Campaign-Vault-v1.0.0."

If this is your first time installing Obsidian, you’ll get a menu like this:

![Obsidian Vault Selection Screen](https://github.com/dclasair/ttrpg-campaign-vault/blob/main/Obsidian%20Vault%20Selection%20Screen.png)

**If you already have Obsidian, you can get to the vault selection by clicking on the up/down arrow in the bottom left corner, and then select “Manage vaults…” This will open the menu posted above.**

For the rest of the set-up, read the INSTRUCTIONS section in the vault:

![Instructions Menu from Vault](https://github.com/dclasair/ttrpg-campaign-vault/blob/main/Instructions%20menu.png)

# Design Intent

-  Build your world through adventure.
	-  Start with the Campaign Outline, break that into Adventures with the Adventure Outline, and use the Session Outline for each game. 
-  Useful for Players and DMs.
	- Copy the Notes of the info the Players discover each Session into the appropriate folder.
-  Use as few folders as possible.
	- Use Obsidian's [properties](https://help.obsidian.md/properties), [tags](https://help.obsidian.md/tags), and [Bases](https://help.obsidian.md/bases) to keep campaign details organized.

# Steps

1. Copy the main "Name of Campaign COPY THIS FOLDER" for each campaign. 
2. Rename the folder with the name of your campaign.
3. Fill out the Campaign Outline in the Campaign Outline folder.
4. Add what you want your Players to know before the first session into the applicable sub-folder under "Player Info."
5. Rename the folder "Adventure Name" to the current adventure.
6. Fill out the Adventure Outline.* 
7. Put everything you need related to the adventure in the newly named adventure folder.
8. Use the **Session 0** and **Session 1** folders to hold info you need to run those. 
9. Fill out the Session Outline and copy it to the appropriate Session folder.
10. After the session is over, move the information the Players discovered from the Session folder into the relevant sub-folder under "Player Info."

\*Skip the "02-Adventures" folder entirely if you're good running the game using only the Session Outline.

# Folders Outline

The Campaign Folder is divided into a number of sub-folders to keep your game organized. Feel free to add or delete sections as you need. See the section later in this document for more info on the Outlines.

- Databases - Use the [Bases](https://help.obsidian.md/bases) feature of Obsidian to get different views of your info. See [[NPC Bases Demo.base|NPC Bases Demo]] for an example.
- DM Info
	- 01-Campaign Outline - Contains the Campaign Outline to contain the core ideas of your story.
	- 02-Adventures - Adventures - Holds the Adventure Outline which gives you a template to create adventures for your story, and easily scan the text to find what you need.
	- 03-Sessions - The Session Outline provides a guide for your time around the table.
	- 04-Secrets - Contains the DM Secrets Master List (Example) so you can keep info hidden until the Players reveal it.
	- 99-Rules References - Any info that you need to refer to regularly.
- Player Info
	- 01-World - A place for all the info of your world; important cities, historical events, transportation lines, etc.
	- 02-Characters - Contains two subfolders. One for your Players and one for your NPCs.
	- 03-Monsters - As your Players encounter various monsters during the campaign, put them here.
	- 04-Magic Items - Keep track of Magic Items you create or who gets certain items.
	- 05-Maps - If you use maps. this folder is for you! 
	- 06-Session Notes - Where Players can store their notes for each session.
	- 99-Rules References - Any info your Players want to keep front and center.

# Templates Outlines

## Campaign Outline

This is for any special rules regarding the campaign, and a place to create a general outline for your story. Share info from this, or the whole thing with your Players during Session 0.

1. Write an Overview - What is the campaign about?
2. Fill out the Three Main Antagonists table. They can be working together or separately.
	1. Name of Antagonist - enclose the name in double square brackets to link it to a Note.
	2. Brief Description - A short sentence of who they are
	3. Their Primary Goal
	4. Forces For - Create a NPC or organization that work for the antagonist.
	5. Forces Against - Create a NPC or organization that work against the antagonist (does not necessarily have to work with the PCs).
3. Six Campaign Truths - What are some unique things that are true to this particular campaign?
4. Inciting Incident - What is the event that causes the PCs to start exploring the campaign?
5. Connection Questions - Questions for the PCs to answer that connect them to some NPC or other part of the campaign.

## Adventure Outline

Follow the Adventure Outline when you create an adventure for a campaign.  It's meant to keep everything text based and future proof, so there's a little more to it than the other sections. See the [[Adventure Outline DEMO]] for an example of how to use the various parts.

1. Fill out the top section of the Adventures outline to list Key Moments of the adventure explain the adventure to the GM, list NPCs, and list Monsters
2. Use the Scene Text Key to help organize the rest of the adventure.
	1. Add the Scene name
	2. List Key Moments of the Scene
	3. When outlining the rest of the scene, use the (pipe)(letter) for various elements
    
		|D = NPC Dialogue
	
		|G = GM info for game prep

|R = Read-aloud text

|T  = Text that explains next steps, mechanics, or other things the GM needs to know for the section. Not to be read aloud.

## Session Outline

Break down your adventures into handy session notes. This is the template I use for all my home game sessions.

1. Recap - What happened last time you played? If this is your first session, feel free to delete this part.
2. Summary - A brief description of what is going to happen this play session.
3. Session Parts - Give yourself a loose outline of what might happen at the beginning, middle, and end of the session.
4. NPCs - List the potential key NPCs for this session. Use the double square brackets to connect the NPC to their Note. Brief description of who the NPC is so you can run them at a glance.
5. Monsters - List of monsters you might be using this session.
6. Treasure - What will the PCs find?
7. Secrets - Potential things the PCs can find out this session.

# Organization

### Create a new [Note](https://help.obsidian.md/create-note) with CTRL+N (Windows) or CMD+N (macOS)

- If you want to use a [Template](https://help.obsidian.md/plugins/templates) open the [Command Palette](https://help.obsidian.md/plugins/command-palette) with CTRL+P (Windows) or CMD+P (macOS), search for "Templates," and select "Templates: Insert Template" from the list.

### Create [Properties](https://help.obsidian.md/properties) for each Note. Properties are always at the top of the Note.

- Type three dashes at the top of each Note, or open the  [Command Palette](https://help.obsidian.md/plugins/command-palette), and search for "Add File Property" from the list.
	 - I'd recommend no more than 3 Properties per Note in World info, Characters, Monsters, and Magic Items (though if you need more, go for it). Put other details in the body of the Note.
 - The Templates have a few suggested properties, or create your own.
 - [Tags](https://help.obsidian.md/tags) also appear in the Properties selection for a Note, if you want to use them.

Use three dashes --- at the top of the Note (below the title of the Note) to create the Properties list.
 - For example, if you wanted to add a Properties list to this note, type the three dashes directly below "02-Using the Vault"

You'll use these Properties to filter the data of each Base you create

### Form connections to other Notes by encapsulating the name of the referred Note in double square brackets `[[]]`.

Connecting to another Note from within a Note:

[[Cheeky McButtz]] saunters into the garden.

The double square brackets around the name form a connection to the Cheeky McButtz Note in the NPCs folder.

### Create a [Base](https://help.obsidian.md/bases) for filtering items by a Property. Bases is the term Obsidian uses for Databases; there's a folder to place them in above the DM Info folder.

- Open the Command Palette.
- Type the word "bases" in the Command Palette search bar and the "Bases: Create new base" option will appear in the drop down.
- Use the Filter and Properties options to curate your view.

Screenshots from the NPC Bases Demo

###### *The Filter option is in the upper right next to Sort.*
<img width="1909" height="184" alt="Bases - The filter option" src="https://github.com/user-attachments/assets/c3b2ce1d-08bd-4353-a90f-79ac81d545e5" />

###### *Select the options "File" "In Folder" and the name of the folder you want to pull info from*
<img width="599" height="244" alt="Bases - Filter by folder" src="https://github.com/user-attachments/assets/7d55b17f-3dce-47dc-a02d-56f9048fc04d" />

###### *Select from the Properties you set-up earlier that  you want displayed in this view*
<img width="424" height="564" alt="Bases - Select Properties to Display" src="https://github.com/user-attachments/assets/2ef46211-daa3-49c6-a723-700ec2f6032c" />

# Sharing the Vault

You can use a sync service like [Syncthing](https://syncthing.net/) (Free),  [Obsidian Sync](https://obsidian.md/sync) (Paid), or [screen.garden](https://screen.garden/) (Paid) to allow the Players to see and add to the Player Info part of the vault. If you don't mind some manual upkeep, copy the Player Info folder to a shared cloud drive (Google Drive, One Drive, iCloud) and have everyone add to it as needed. DMs, keep your version of the vault up-to-date.

The Vault, Folders, and Notes all exist on your computer as Folders with Files in them. The Notes are \*.md (Markdown) files and can be opened in any text editor. You could copy the Player Info folders out to your friends.

# License

The TTRPG Campaign Vault is released under [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0)  (CC-BY-4.0), and developed by DC Lasair https://dclasair.com/.

ttrpg-campaign-vault

ttrpg-campaign-vault Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ttrpg-campaign-vault

ttrpg-campaign-vault Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README