-
Notifications
You must be signed in to change notification settings - Fork 8
Features
This page covers all of DeepLore Enhanced's features in detail. For the core matching pipeline, see Pipeline. For AI Search specifics, see AI Search.
Adds a book icon button to each AI message's action bar. Click it to see which vault entries were injected for that message, why they matched, and how much context they used.
The popup shows:
- Entry name (clickable link to Obsidian if vault name is configured)
- Match type: keyword, AI (with confidence and reason), or constant
- Priority value
- Estimated token cost
Setup:
- Enable "Show Lore Sources Button" in Settings Reference
- Optionally set your "Obsidian Vault Name" to enable deep links that open entries directly in Obsidian
Notes:
- Source data is saved per-message in
message.extra.deeplore_sources, so it persists across sessions - The book icon only appears on messages that have lore source data
Automatically summarizes your roleplay sessions and writes them as timestamped markdown notes to your Obsidian vault.
How it works:
- After every N AI messages (configurable), Scribe generates a summary using your AI connection
- The summary is written as a markdown file to the configured Session Folder in your vault
- Notes include frontmatter with timestamp, character name, and chat ID
On-demand: Use /dle-scribe to write a summary at any time. Optionally pass a focus topic: /dle-scribe What happened during the trial?
Setup:
- Enable "Enable Session Scribe" in Settings Reference
- Set the auto-scribe interval (every N messages)
- Set the Session Folder (default:
Sessions) - Optionally customize the summary prompt
Notes:
- Requires the server plugin to be installed (it handles writing to the vault)
- Uses your current AI connection (same as AI Search)
- Default prompt summarizes events, character changes, and plot developments as bullet points
When the index rebuilds, DeepLore compares the new index against the previous one and reports changes.
Detects:
- New entries added
- Entries removed
- Modified content
- Changed keywords
Auto-Sync Polling: Set "Auto-Sync Interval" to automatically re-check the vault every N seconds. When changes are detected, toast notifications summarize what changed (if "Show Sync Change Toasts" is enabled).
Manual refresh: Click "Refresh Index" in settings or use /dle-refresh.
Per-entry cooldown: N in frontmatter. After an entry triggers, it's skipped for the next N generations before becoming eligible again.
Use case: Prevent the same lore from being re-injected every single generation. Useful for flavor text or background entries that don't need constant repetition.
Example:
cooldown: 3 # After triggering, skip for 3 generationsNotes:
- Cooldown is tracked per-session (resets on chat change or page refresh)
- Constants (
#lorebook-always) are exempt from cooldown
Per-entry warmup: N in frontmatter. An entry's keywords must appear N or more times in the scan text before it triggers for the first time.
Use case: Prevent entries from triggering on a single casual mention. Ensure a topic is being discussed in depth before injecting detailed lore.
Example:
warmup: 3 # Keyword must appear 3+ times in scan text before first triggerNotes:
- Only affects the first trigger — once an entry has triggered, it matches normally afterward
- Count is based on occurrences in the scan text, not unique messages
Global setting (not per-entry). Skips re-injecting an entry for N generations after it was last injected. Helps save context by avoiding redundant lore repetition.
Setup: Set "Re-injection Cooldown" in Settings Reference (0 = disabled)
Notes:
- Constants (
#lorebook-always) are exempt - Tracked per-session (resets on chat change)
When enabled, automatically matches the active character's vault entry by name or keyword, even if the character isn't mentioned in recent chat messages.
Use case: Ensure the character you're roleplaying with always has their lore available, without relying on their name appearing in the most recent messages.
Setup: Check "Active Character Boost" in Settings Reference
Entries can declare dependencies on other entries using requires and excludes frontmatter fields.
All listed entry titles must be in the matched set for this entry to activate.
requires:
- Eris
- Dark CouncilThis entry only injects when both "Eris" and "Dark Council" are also matched.
If any listed entry title is in the matched set, this entry is blocked.
excludes:
- Draft NotesThis entry is blocked if "Draft Notes" is matched.
Gating resolves iteratively. If Entry A requires Entry B, and Entry B gets removed by its own gating rules, Entry A is also removed. This cascading continues until no more entries are affected.
See Writing Vault Entries for a complete template.
Entries can override the global injection position via frontmatter:
| Field | Values | Description |
|---|---|---|
position |
before, after, in_chat
|
Where to inject |
depth |
number | Chat depth (for in_chat) |
role |
system, user, assistant
|
Message role (for in_chat) |
Entries are grouped by their effective position (global default or override) and each group is injected separately.
Example: You might want most lore injected at depth 4 as system messages, but a character's dialogue hints injected at depth 1 as user messages.
See Writing Vault Entries for templates.
On a brand new chat (below the New Chat Threshold, default 3 messages), two features help bootstrap the conversation:
- Entry content is sent to the AI as additional story context alongside the chat
- Helps the AI understand your setting and make better entry selections from minimal context
- NOT injected into the writing AI's context — only informs AI search
- When seed mode is active, AI is instructed to fill to maxEntries selections (more aggressive)
- Force-injected like constants when chat is short
- Once chat grows past the threshold, they become regular entries managed by normal selection
- Good for writing instructions or foundational lore needed at the start
An entry can have both tags: its content feeds the AI (seed) AND it force-injects (bootstrap).
Track how often each entry is matched and injected across generations. View with /dle-analytics.
Shows:
- Table sorted by injection count
- "Never Injected" section for dead entry detection
Use case: Identify entries with bad keywords that never trigger, or entries that trigger too frequently.
Audit all vault entries for common issues with /dle-health.
Checks:
- Empty keys on non-constant entries
- Orphaned
requires/excludesreferences - Oversized entries (>1500 tokens)
- Duplicate keywords shared across entries
- Missing AI selection summaries
View a detailed trace of the last generation with /dle-inspect.
Shows:
- Pipeline mode (two-stage, ai-only, keywords-only)
- Keyword matches with trigger keywords
- AI selections with confidence and reasons
- Fallback status
- Constants and bootstrap entries
See Slash Commands for all available commands.
DeepLore Wiki
Getting started
Features
Reference
Help