Roguelike

  |
  |
  + \
  \.G_.*=.
   `(#'/.\ |
    .>' (_--.
 _=/d   ,^\
~~ \)-'   '
   / |   rlc
  '  '

╔═════════════════════════════╗
║    Welcome to Roguelike     ║
╚═════════════════════════════╝

Turn your Obsidian vault into an RPG adventure! Roguelike is a gamified goal tracking plugin that transforms task management into an engaging game with XP, levels, achievements, loot drops, and AI-powered planning.

Features

Gamification System

• XP & Levels — Earn experience points for completing goals, watch your character level up
• Achievements — Unlock 15+ achievements for milestones (first task, streaks, boss defeats, etc.)
• Loot Drops — Find items of various rarities (Common → Legendary) when completing goals
• Boss Goals — Mark important milestones as "bosses" for 3x XP rewards
• Streaks — Track daily completion streaks for bonus motivation

AI-Powered Planning

• Goal Generation — Describe your project, AI creates a structured task breakdown
• Smart Maps — Generate ASCII dungeon maps with labeled rooms showing task names, bosses, deadlines, and blockers
• Charts & Diagrams — Create wide ASCII schemas for any concept
• Content Assistant — AI helps fill notes with relevant content
• Auto Headers — Generate titles and rename files based on content

Visual Task Status

• [DONE] prefix — Completed goals get [DONE] prefix on folder and file names automatically
• [BOSS] prefix — Boss goals get [BOSS] prefix on both folder and file
• Dimmed in explorer — Completed tasks appear faded and struck-through in the file navigator
• Undo-friendly — Reopening a goal removes the [DONE] prefix automatically

Flexible Structure

• Goals are folders with companion .md notes containing metadata
• Works anywhere in your vault — no dedicated folder required
• Inline fields (Dataview-compatible) for status, deadline, boss, XP, blockers
• Hierarchical nesting with parent-child relationships

11 Themes

Choose your adventure style:

• Default (Productivity)
• Fantasy RPG
• Space Opera
• Star Wars
• Cyberpunk
• Pirates
• Wild West
• Warhammer 40K
• Ninja/Samurai
• Crusader
• Dark Souls

Installation

From Community Plugins (Recommended)

1. Open Settings → Community plugins
2. Click Browse and search for "Roguelike"
3. Click Install, then Enable

Manual Installation

1. Download main.js, manifest.json, and styles.css from the latest release
2. Create folder: <vault>/.obsidian/plugins/roguelike/
3. Copy the downloaded files into the folder
4. Enable the plugin in Settings → Community plugins

Hotkeys

The plugin does not set default hotkeys (to avoid conflicts). Assign shortcuts in Settings → Hotkeys (search for "Roguelike"):

Shortcut	Command	Description
Cmd+Shift+G	Create goal with AI	Describe a goal, AI generates task structure
Cmd+Shift+D	Toggle done/undone	Mark goal complete or revert completion
Cmd+Shift+B	Toggle boss	Mark/unmark as boss goal (3x XP)
Cmd+Shift+M	Generate map	AI creates ASCII dungeon map of goal structure
Cmd+Shift+C	Generate chart	AI creates ASCII diagram from prompt
Cmd+Shift+J	Journal	Update welcome note with current stats and task overview
Cmd+Shift+P	Prompt	AI updates/adds content to current note
Cmd+Shift+H	Generate header	AI generates H1 title and renames file

How It Works

Goal Structure

Each goal is a folder with a companion Markdown note:

My Project/
├── My Project.md              # Goal metadata
├── Research Phase/
│   ├── Research Phase.md
│   └── [DONE] Gather Sources/         # Completed goals get [DONE] prefix
│       └── [DONE] Gather Sources.md
└── [BOSS] Launch Day/                 # Boss goals have [BOSS] prefix
    └── [BOSS] Launch Day.md

Goal Note Format

status:: open
boss:: false
xp:: 20
deadline:: 2026-02-15
author:: [[Your Name]]
blocker:: [[Other Task]]
created:: 2026-01-30

Short description of what needs to be done.

XP System

Action	XP
Complete goal	10 base
Nested goal bonus	+5 per depth level
Boss goal	3x multiplier

Achievements

Unlock achievements as you progress:

• First Blood — Complete your first task
• On Fire — 3-day streak
• Boss Slayer — Defeat a boss
• Centurion — Complete 100 tasks
• And 10+ more!

Settings

Setting	Description
Theme	Text style for messages, achievements, and loot names
Provider	AI provider for goals, maps, content, and headers
Model	Model to use (depends on selected provider)
API key	API key for the selected provider (get it from the provider’s console)

AI providers and models

Provider	Models	API key / docs
Anthropic (Claude)	Claude sonnet 4, Claude opus 4, Claude 3.5 sonnet	console.anthropic.com
OpenAI (GPT)	GPT-4o, GPT-4o mini, GPT-4 turbo, GPT-4o (Nov 2024), O1, O1 mini	platform.openai.com
Google (Gemini)	Gemini 1.5 pro, Gemini 1.5 flash, Gemini 1.0 pro	aistudio.google.com
xAI (Grok)	Grok 2, Grok 2 mini	console.x.ai

Welcome Note

On first run, the plugin creates a Welcome to Roguelike.md note in your vault root containing:

• Your profile (level, XP, streak)
• Statistics (tasks completed, bosses defeated)
• Achievements gallery
• Inventory of collected loot
• Journal with task overview (overdue, upcoming, blocked)
• Help and hotkey reference

Assign a hotkey for Journal in Settings → Hotkeys (e.g. Cmd+Shift+J) to update this note anytime.

Development

# Clone the repository
git clone https://github.com/creative-ventures/obsidian-roguelike.git
cd obsidian-roguelike

# Install dependencies
npm install

# Development build (with watch)
npm run dev

# Production build
npm run build

# Lint
npm run lint

Links

• GitHub Repository
• Report Issues
• Roguelike website
• Creative Ventures

License

MIT License — see LICENSE for details.

Credits

Created by Creative Ventures.

Inspired by roguelike games and the desire to make productivity feel like an adventure.