Skip to content

namtrah/obsidian-rpg-manager

 
 

Repository files navigation

Role Playing Game Manager Obsidian Plugin

Obsidian Role Playing Game Manager is an Obsidian plugin that helps you plot and manage your tabletop role playing game campaigns.

The plugin works well in conjunction with a structured plotting style.

The plugin collects data and Frontmatter metadata from the notes and organise them into easy-to access references in form of tables and links.

Update notes

From version 1.0 RPG Manager does not require the Dataview plugin any longer

Data Structure

The plugin organises the notes in Outlines and Elements. Each of them has a structure that helps writing and keeping track of a campaign. The structure is as follow:

  • Campaign (Outline)
    • Adventures (Outline)
      • Sessions (Outline)
        • Scenes (Outline)
    • Player Characters (Element)
    • Non Player Characters (Element)
    • Events (Element)
    • Clues (Element)
    • Factions (Element)
    • Locations (Element)
    • Timelines (Element)
    • Notes (Element)

TL;DR

  1. Use the Rpg Manager commands to create a new outline or element or to fill an existing note with the correct frontmatter and codeblocks.
  2. Add the information in the Frontmatter metadata
  3. See everything linking together
  4. Navigate your campaign easily
  5. Send feedback

Plotting Logic

The plotting style used in this plugin is based on a series of outlines and elements that helps the creation of a storyline.

A plot is the blueprint of how the story should go, but it is never written in stone, as the actions of the player characters define the resulting story.

This style is setting agnostic, which means that can be used with any tabletop role playing game, and rules light, which means that it does not (yet) extend into stats or dice rolling. It is a tool to plot stories.

Outlines

Outlines are the plots of a Campaign, Adventure, Session or Scene. You can read more here.

Element Codeblocks Description
Campaign campaign + campaignNavigation The overarching story plot for a series of Adventures
Adventure adventure + adventureNavigation A single, self contain storyarc divided in Sessions
Session session + sessionNavigation A single session of a role playing game containing a series of Scenes
Scene scene + sceneNavigation A part of a Session in which the player characters are expected to do something

Elements

Elements are other information related to the campaign, which are not in a plot (Player Characters, Non Player Characters, Factions, Locations, Events, Clues)

Element Codeblock Description
Player Character pc The record sheet of a player character
Non Player Character npc The record sheet of a non-playing character
Faction faction A group of player and non-player characters
Location location A physical location in the game
Event event Something that happened in the game. This is something that happened without the player characters and it is used to give more details to the storyteller and to simplify the creation of investigative campaigns
Clue clue An object or a detail the player character can encounter in the game that will help them understand something and advance the game
Note note A note, usually associated to a Session, that helps the storyteller to keep track of the player characters' decisions
Timeline timeline A list of elements organised by dates (if you use dates in your campaign)

Usage

Frontmatter Metadata

A complete readme on the required structure of the Frontmatter metadata is available here.

Frontmatter Examples

For more examples of the Frontmatter metadata to be used in each element, please refer to the Frontmatter Metadata Documentation.

RpgManager Codeblock

RpgManager uses codeblocks to parse information. You can add one or more codeblocks in a page to display the relevant information.

Example of a session codeblock

```RpgManager
session

RpgManager Available Codeblock Functions

RpgManager supports the creation of different views. These views are associated to the page element, and they feed from the Frontmatter metadata in the page. The available functions are:

Function Description
campaignNavigation Displays the banner of the campaign
campaign Lists the adventures, sessions and characters for the campaign
adventureNavigation Displays the breadcrumb and the header
adventure Lists the adventure sessions
sessionNavigation Displays the session navigator
session Lists the session scenes
sessionNavigation Displays the breadcrumb and the header
sceneNavigation Displays the breadcrumb and the header
scene Displays the scene navigator and lists the characters, locations and clues for the scene
npc Displays the non player character information and lists the list of factions, characters, events, clues and locations related to the character
pc Displays the player character information and lists the list of factions, characters and locations related to the character
clue Displays the clue information and lists the characters, locations and events related to the clue
event Displays the event information and lists the characters, clues and locations related to the event
location Displays the location information and lists the characters, clues and events related to the location
faction Displays the faction information and lists the characters and locations related to the faction
timeline Displays a timeline of every event, session and character date in the campaign
notes Currently does not display any specific type of information (under development)

example

```RpgManager
campaign

Images

Rpg Manager automatically includes images in the Attachment folder. To display an image in an element, the image must have the same name of the note. Supported files extensions are .jpg, .jpeg, .png and .webp.

Templates

Using Rpg Manager Create Commands (Create a new...) you have access to pre-designed templates which contains the correct frontmatter and codeblocks for each outline and element. You can also fill an existing note using Rpg Manager Fill Commands (Fill ...)

Contributing

Contributions via bug reports, bug fixes, documentation, and general improvements are always welcome. For more major feature work, make an issue about the feature idea / reach out to me so we can judge feasibility and how best to implement it.

paypal

About

Obsidian RPG Manager

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 55.4%
  • JavaScript 40.7%
  • CSS 2.1%
  • SCSS 1.8%