Note Village

A 2D pixel art village where your notes become villagers you can explore and chat with using AI.

Note Village transforms your Obsidian vault into an interactive JRPG-style world. Your notes become villagers that live in themed zones based on your tags, and you can have AI-powered conversations with them using Claude.

Features

• Procedural village generation - Your vault's tags become zones, and notes become villagers placed in their respective zones
• JRPG-style pixel art - Retro 16-bit style graphics with animated characters, buildings, and decorations
• AI conversations - Chat with your notes using Claude (requires Anthropic API key)
• Deterministic world - Same seed generates the same village layout every time
• Customizable - Configure zones, villager limits, graphics quality, and more

How it works

1. Tags become zones - The plugin analyzes your vault and uses your most frequent tags as themed zones in the village
2. Notes become villagers - Notes tagged with those tags appear as villagers in their respective zones
3. Explore your knowledge - Walk around the village with WASD/arrow keys or click to move
4. Talk to your notes - Press C near a villager or right-click to start an AI conversation

Installation

Community plugins (recommended)

1. In Obsidian, go to Settings → Community plugins.
2. Disable Restricted mode if it's enabled.
3. Select Browse, search for Note Village, install it, then enable it.

You can also browse the catalog on the Obsidian Community website.

Manual installation

If the plugin isn't listed in the community catalog yet (or you want a specific version):

1. Download main.js, manifest.json, and styles.css from the latest release.
2. Copy them into <Vault>/.obsidian/plugins/note-village/.
3. Reload Obsidian and enable Note Village in Settings → Community plugins.

BRAT (bleeding edge)

BRAT (Beta Reviewers Auto-update Tool) installs plugins straight from a GitHub repo and keeps them updated automatically. Use this if you want the latest commits — things might break.

1. Install Obsidian42 - BRAT from Settings → Community plugins → Browse and enable it.
2. Run BRAT: Add a beta plugin for testing from the command palette.
3. Paste https://github.com/dsebastien/obsidian-note-village.
4. Select the latest version and confirm.
5. Enable Note Village in Settings → Community plugins.

Configuration

Open Settings > Note Village to configure:

Usage

Opening the village

• Click the village icon in the ribbon (left sidebar)
• Or use the command palette: "Note Village: Open village"

Controls

AI conversations

To chat with your notes:

1. Add your Anthropic API key in settings
2. Approach a villager and press C (or right-click)
3. The villager will respond based on the note's content

Conversations can be saved as markdown files in your vault.

Development

Prerequisites

• Bun (latest version)
• Git

Setup

git clone https://github.com/dsebastien/obsidian-note-village.git
cd obsidian-note-village
bun install

Commands

Tech stack

• TypeScript with strict configuration
• Excalibur.js for game engine
• Anthropic SDK for AI conversations
• Zod for runtime validation
• Tailwind CSS v4 for styling
• Bun for package management and bundling

Support

• Report issues
• Buy me a coffee

License

MIT License - see LICENSE for details.

Author

Sebastien Dubois