https://github.com/name/obsidian-rpg

RPG-like stat tracker for Obsidian.
https://github.com/name/obsidian-rpg

obsidian-md obsidian-md-plugin

Last synced: 2 months ago
JSON representation

RPG-like stat tracker for Obsidian.

• Host: GitHub
• URL: https://github.com/name/obsidian-rpg
• Owner: name
• License: mit
• Created: 2024-06-18T20:10:53.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-09-14T20:17:13.000Z (3 months ago)
• Last Synced: 2024-09-30T09:40:50.650Z (3 months ago)
• Topics: obsidian-md, obsidian-md-plugin
• Language: TypeScript
• Homepage:
• Size: 45.9 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian RPG Plugin

This plugin is a work in progress. It is designed to gameify the process of writing and organizing notes in Obsidian. The plugin tracks time spent with your vault open and rewards you with experience points. You gain extra experience points for the amount of notes you have in your vault. Your experience points are tracked directly and under a level system.

![Status](./images/status.png)

![New File](./images/new_file.png)

![Level Up](./images/level_up.png)

I want to eventually replicate something like [vscode-pets](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets) but for Obsidian. You'll be able to upgrade your pet and unlock new pets as you level up.

## Installation

1. Open your Obsidian vault folder in a terminal and navigate to `.obsidian/plugins`.

2. Clone this repository into the plugins folder: `git clone [email protected]:name/obsidian-rpg.git`.

3. Reload Obsidian and enable the plugin in the settings.

4. The plugin will start tracking your time and experience points immediately.

## Settings

1. Open your Obsidian settings and navigate to the "Obsidian RPG" tab.

- **XP gained per second**: The amount of experience points you gain per second with your vault open.

- **XP gained per file**: The amount of experience points you gain per note in your vault.

- **Reset XP and level**: Resets your experience points and level to 1. (This does not delete/modify your notes.)