RPG Engine

unlisted

by Andrew Edwards

Gamifies notes, tasks, stats, achievements, rewards, spellcasting, crafting, and progression.

Updated 1mo agoMIT
View on GitHub

RPG Engine

RPG Engine is an Obsidian plugin that turns notes, tasks, streaks, spellcasting, crafting, loot, and progression into a lightweight personal RPG layer for a single vault.

Core features

  • XP, levels, stats, feats, perks, achievements, and streaks
  • Tagged markdown task rewards such as [d:2] [xp:+20] [gp:+10] [shards:+1]
  • Spell Scrolls, spell slots, active spells, Short Rest, and Long Rest
  • Crafting ingredients, recipes, unlocks, and milestones
  • Equippable loot with live stat and reward modifiers
  • Character profile with portrait editing, race, class, and background
  • Dashboard widgets including current tasks, battle timer, and dice roller

Install

Community Plugins browser

Once the plugin is published:

  1. Open Settings → Community Plugins
  2. Turn off Restricted mode if needed
  3. Click Browse
  4. Search for RPG Engine
  5. Install and enable it

GitHub pre-release / manual install

For pre-release builds:

  1. Download the release zip from GitHub
  2. Extract it into your vault at: .obsidian/plugins/rpg-engine/
  3. Confirm the folder contains at least:
    • manifest.json
    • main.js
    • styles.css
  4. Reload Obsidian
  5. Enable RPG Engine in Community Plugins

Development install

For local development:

  1. Copy the plugin files into: .obsidian/plugins/rpg-engine/
  2. Install dependencies with npm i
  3. Build or watch with npm run dev
  4. Reload Obsidian
  5. Enable RPG Engine

Quick start

  1. Open RPG Dashboard from the ribbon or command palette
  2. Create or edit your character profile
  3. Add tagged tasks to a markdown note, for example:
- [ ] Review plugin notes [d:2] [xp:+20] [gp:+10]
- [ ] Ship a nasty bug fix [d:3] [xp:+40] [gp:+25] [shards:+1]
  1. Tick tasks to earn rewards
  2. Untick tasks to reverse those rewards
  3. Buy Spell Scrolls, cast spells, unlock perks, choose feats, craft items, and equip loot

Main views

  • Dashboard — overview, current tasks from the active note, equipped items, active spell, battle timer, and dice roller
  • Coin Purse — currencies, inventory, shop, crafting, and equipment
  • Profile — character identity, portrait editing, feats, and effective stats
  • Logbook — recent history and progression trail

Modal views

These currently open as modal dialogs rather than persistent side-pane views:

  • Spellbook
  • Perk Trees
  • Character creation / edit

Task tag format

Supported task reward tags:

  • Difficulty: [d:1], [d:2], [d:3]
  • XP: [xp:+20]
  • Gold: [gp:+10] or [gold:+10]
  • Shards: [shards:+1] or [shard:+1]

Known limitations

  • The plugin is designed for one character per vault
  • Spellbook and Perk Trees are modal dialogs, not pinned views
  • The battle timer is not persisted if Obsidian closes mid-timer
  • Very large vaults may take longer on initial task hydration
  • Some UX polish items are still planned, especially around settings organisation and task-tag helpers

Compatibility notes

  • The Current Tasks widget reads from the active markdown note
  • Long Rest is limited to once per day
  • Tasks metadata, Dataview inline fields, and block IDs are parsed defensively
  • Template-heavy vaults should keep template folders in the plugin exclusion list to avoid accidental reward spam from generated notes

See COMPATIBILITY-NOTES.md for more detail.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.