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.
- 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
- Tags become zones - The plugin analyzes your vault and uses your most frequent tags as themed zones in the village
- Notes become villagers - Notes tagged with those tags appear as villagers in their respective zones
- Explore your knowledge - Walk around the village with WASD/arrow keys or click to move
- Talk to your notes - Press C near a villager or right-click to start an AI conversation
- Open Settings in Obsidian
- Go to Community plugins and disable Restricted mode
- Click Browse and search for "Note Village"
- Click Install, then Enable
- Download
main.js,manifest.json, andstyles.cssfrom the latest release - Create a folder
<vault>/.obsidian/plugins/note-village/ - Copy the downloaded files into that folder
- Reload Obsidian and enable the plugin in Settings > Community plugins
Open Settings > Note Village to configure:
| Setting | Description |
|---|---|
| Village seed | Seed for procedural generation (empty = vault name) |
| Top tag count | Number of tags to use as zones (3-20) |
| Max villagers | Maximum number of villagers to display (10-500) |
| Excluded folders | Folders to exclude from analysis |
| Excluded tags | Tags to exclude from zone generation |
| Render quality | Graphics quality (Low, Medium, High) |
| Anthropic API key | Required for AI conversations |
| AI model | Claude model for conversations |
| Save conversations | Save chat history to vault |
| Conversation folder | Folder for saved conversations |
- Click the village icon in the ribbon (left sidebar)
- Or use the command palette: "Note Village: Open village"
| Action | Control |
|---|---|
| Move | WASD or arrow keys |
| Move to location | Left-click on ground |
| Start conversation | Press C near villager, or right-click villager |
To chat with your notes:
- Add your Anthropic API key in settings
- Approach a villager and press C (or right-click)
- The villager will respond based on the note's content
Conversations can be saved as markdown files in your vault.
git clone https://github.com/dsebastien/obsidian-note-village.git
cd obsidian-note-village
bun install| Command | Description |
|---|---|
bun run dev |
Development build with watch mode |
bun run build |
Production build |
bun run tsc:watch |
Type check in watch mode |
bun run lint |
Run ESLint |
bun run format |
Format with Prettier |
bun test |
Run tests |
- 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
MIT License - see LICENSE for details.
