Lorebase

---

✨ What is Lorebase?

Lorebase transforms your Obsidian vault into a full-featured media tracker. Catalog your games, anime, and future media collections with card views, rich metadata, progress tracking, and collection statistics — all while keeping your data portable and private as plain Markdown files.

🔒 Privacy-first — No accounts, no cloud sync, no telemetry. Your data never leaves your vault.

---

📸 Showcase

---

🚀 Features

📚 Dual Libraries

---

🃏 Card Views

• 3 preset sizes: Small · Medium · Large
• Custom dimensions: Fine-tune width, height, and image ratio
• Adaptive grid: Automatically calculates column count based on viewport
• Virtualized rendering: Smooth scrolling for 100+ items

---

🏷️ Badges & Overlays

All badges have customizable positions (X/Y percentage) and can be placed anywhere on the card.

Hover overlay reveals title, year, format, and description — visibility of each element is configurable.

---

🔍 Smart Toolbar

---

📊 Collection Statistics

A beautiful dashboard modal with:

• Key metrics: Total items, completed count, average rating, favorites
• Status distribution: Bar charts with percentages
• Rating distribution: Emoji-based visualization (😍😊😐😕🤢)
• Additional info (games only): Series count, custom posters, completion %

---

✏️ Cinematic Editor

A three-column modal editor inspired by modern CMS design:

Keyboard shortcuts: Ctrl+Enter to save · Escape to close

---

🌸 Visual Effects

Adjustable intensity from 20 to 150 particles with realistic sway, rotation, and random delays.

---

🔗 Integrations

Lorebase can automatically fetch metadata when creating new entries:

Game Providers

Anime Providers

---

📦 Installation

Community Plugin

1. Open Settings → Community plugins
2. Search for Lorebase
3. Install and enable the plugin

Manual Installation

1. Download the latest release from GitHub Releases

2. Copy these files into your vault's plugin folder:

   <Vault>/.obsidian/plugins/lorebase/
   ├── main.js
   ├── manifest.json
   └── styles.css
   

3. Restart Obsidian or reload plugins

4. Open Settings → Community plugins and enable Lorebase

Build from Source

# Install dependencies
npm install

# Build the plugin
npm run build

# Run tests
npm test

# Type checking
npm run typecheck

---

🎯 Getting Started

1. Open Lorebase — Click the Lorebase icon in the ribbon, or use the command palette (Ctrl+P → "Lorebase")
2. Choose your library — Switch between Games and Anime tabs
3. Add your first item — Click the ➕ button to search via configured providers
4. Review & create — Select a result, review the metadata, and create a note
5. Edit details — Right-click any card to edit status, rating, tags, and more

Quick Actions via Context Menu

Right-click any card to:

• 🎯 Change status instantly
• ⭐ Set rating
• ❤️ Toggle favorite
• ✏️ Open full editor
• 🗑️ Delete item

---

⚙️ Settings

General

Library Settings (per media type)

Card Appearance

• Overlay text: Position and visibility of title, year, format, description
• Badges: Position, mode, and style for status, rating, and favorite
• Description lines: Number of visible lines in hover overlay (1–70)
• Anime progress: Toggle season and episode badges

Integrations

• Toggle each provider on/off
• Enter API keys (RAWG)
• Select default provider per media type
• Configure note templates (simple field list or advanced YAML)

---

📝 Data Format

Every library item is a Markdown file with YAML frontmatter. You can edit them directly or through the Lorebase UI.

---
poster: "https://example.com/game-cover.jpg"
gameSeries: "The Witcher"
genres:
  - "RPG"
  - "Action"
plot: "You play as Geralt of Rivia, a monster hunter..."
platforms: "PC, PS4, Xbox One, Nintendo Switch"
year: "2015"
released: "2015-05-19"
developers:
  - "CD Projekt Red"
publishers:
  - "CD Projekt"
rating: "4"
userRating: 5
status: "completed"
favorite: true
url: "https://store.steampowered.com/app/292030"
main: "51 hours"
main_plus_sides: "103 hours"
perfectionist: "173 hours"
---

## My Notes

Amazing open-world RPG with incredible storytelling...

---
name: "Attack on Titan"
image: "https://example.com/anime-cover.jpg"
plot: "In a world where humanity lives within enormous walled cities..."
scoreImdb: "84"
tags: "action, drama, fantasy"
year: "2013"
studios: "Wit Studio, MAPPA"
format: "tv"
rating: 5
status: "completed"
favorite: true
url: "https://anilist.co/anime/16498"
seasonCurrent: 4
seasonTotal: 4
episodeCurrent: 87
episodeTotal: 87
---

## My Notes

One of the greatest anime of all time...

---

⚡ Performance

Lorebase is optimized for large collections:

• Virtualized rendering — Only visible cards are in the DOM
• Batch card rendering — 24 cards per animation frame
• O(1) file lookups — Map-based index for instant access
• Debounced inputs — Search and scroll events are throttled
• SVG template caching — Icons use cloneNode instead of innerHTML
• ResizeObserver — Adaptive layout without polling

---

🌍 Localization

All UI elements, status labels, settings descriptions, and error messages are fully translated.

---

📄 License

MIT © Murch1k

---