-
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
A persistent per-chat scratchpad that is injected into every generation. Use it for author notes, scene direction, tone guidance, or anything you want the writing AI to always see for this specific chat.
How it works:
- Open the notebook via
/dle-notebookor the "Open Notebook" button in settings - Write any text — it's saved per-chat in
chat_metadata - The notebook content is injected into every generation as a separate prompt, independent of the entry pipeline
Setup:
- Enable "Enable AI Notebook" in Settings Reference
- Choose injection position (Before Main Prompt, After Main Prompt, or In-chat @ Depth)
- Open the editor and start writing
Notes:
- Notebook content is stored in
chat_metadata.deeplore_notebook— it persists across sessions for that chat - Injection is independent of the lorebook pipeline — the notebook always injects when enabled, regardless of matching
- Has its own position, depth, and role settings separate from the main lorebook injection
AI analyzes your chat for characters, locations, items, and concepts that are mentioned but don't have an existing lorebook entry, then suggests new entries you can review and accept.
How it works:
- After every N messages (configurable), or on-demand via
/dle-suggest, the AI scans recent chat - It compares against existing entries and identifies gaps
- Suggestions appear in a popup with title, type, keywords, summary, and content
- Accept to write the entry to Obsidian, or reject to skip
Connection options:
- SillyTavern (default): Uses your active AI connection
- Connection Profile: Use any saved Connection Manager profile
- Custom Proxy: Use a separate proxy server
Setup:
- Enable "Enable Auto Lorebook" in Settings Reference
- Set the trigger interval (every N messages)
- Optionally set a target folder for new entries
- Choose a connection mode
Notes:
- Existing entries are filtered out (case-insensitive title match)
- Accepted entries are written with proper frontmatter (type, priority, tags, keys, summary)
- Use
/dle-suggestto trigger on-demand without enabling automatic suggestions
Connect multiple Obsidian vaults simultaneously. Each vault has its own port and API key. Entries from all enabled vaults are merged into a single index.
Setup:
- In the "Vault Connections" section, click "Add Vault" to add multiple vault connections
- Each vault has a name, port, API key, and enable toggle
- Click "Test All" to verify all connections
Notes:
- Entries from all enabled vaults are merged and treated identically
- Each entry tracks its
vaultSourcefor diagnostics - The health check validates multi-vault configuration
Automatically summarizes your roleplay sessions and writes them as timestamped markdown notes to your Obsidian vault.
How it works:
- Tracks actual chat position — after every N new messages (configurable), Scribe generates a summary
- 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
- Each summary builds on the previous one — the prior note is fed as context so the AI doesn't repeat itself
On-demand: Use /dle-scribe to write a summary at any time. Optionally pass a focus topic: /dle-scribe What happened during the trial?
Connection options:
- SillyTavern (default): Uses your active AI connection via generateQuietPrompt
- Connection Profile: Use any saved Connection Manager profile — lets you route summaries through a different model/provider
- Custom Proxy: Use a separate proxy server (claude-code-proxy or compatible Anthropic Messages API endpoint)
Setup:
- Enable "Enable Session Scribe" in Settings Reference
- Set the auto-scribe interval (every N messages)
- Set the Session Folder (default:
Sessions) - Choose a connection mode (SillyTavern, Connection Profile, or Custom Proxy)
- Optionally customize the summary prompt and message window depth
Notes:
- Requires the server plugin to be installed (it handles writing to the vault)
- Default prompt covers events, character dynamics, revelations, and state changes in past tense
- Configurable message window (default: 20 messages) and response token limit (default: 1024)
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)
Global setting that prevents the same entries from being injected in consecutive generations. When enabled, entries that were injected within the last N generations (configurable lookback depth) are skipped.
Setup:
- Check "Strip Duplicate Injections" in Settings Reference
- Set the "Lookback Depth" (default 2 — checks last 2 generations)
Notes:
- Constants (
#lorebook-always) are exempt — they always inject - Injection history is tracked per-chat in
chat_metadata.deeplore_injection_log - Different from Re-injection Cooldown: deduplication checks a sliding window of recent generations, while re-injection cooldown counts generations since last injection
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.
Per-entry refine_keys in frontmatter. Adds a secondary AND filter on top of primary keyword matching. When set, at least one refine key must also appear in the scan text for the entry to trigger.
Use case: Reduce false positives for entries with common primary keywords. For example, a character named "Rose" might have refine_keys requiring mention of their faction or role to avoid triggering on every use of the word "rose."
Example:
keys:
- Rose
- Rose Blackwood
refine_keys:
- guild
- spymaster
- intelligenceSee Writing Vault Entries for a complete template.
Per-entry cascade_links in frontmatter. When an entry matches, all entries listed in its cascade_links are automatically pulled in -- no keyword check needed for the linked entries.
Use case: Ensure related entries always travel together. Unlike wikilink recursion (which requires keyword matches), cascade links are unconditional.
Example:
cascade_links: ["Soulbrand Removal", "Ironveil Guild"]When this entry matches, "Soulbrand Removal" and "Ironveil Guild" are automatically included.
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. Runs 30+ checks across multiple categories.
Check categories:
- Multi-vault: Enabled vaults, API key validation
- Settings: Scan depth disabled, AI mode without profile, proxy URL missing, budget too low, cache TTL, index staleness
- Entry config: Duplicate titles, empty keys, empty content, orphaned requires/excludes/cascade_links, requires + excludes same title, oversized entries (>1500 tokens), missing summary
- Gating: Circular requires, unresolved links, conflicting overrides
- AI Search: Entries without summary fields
- Keywords: Short keywords (2 chars or less), duplicate keywords across entries
- Size: Constants exceeding budget, seed entries >2000 tokens
- Injection: Depth/role override without in_chat position
- Entry behavior: Cooldown on constants, warmup unlikely to trigger, bootstrap with no keywords, probability zero, excluded from recursion with no keywords
Browse all indexed entries in a searchable, filterable popup with /dle-browse or the "Browse" button in settings. Useful for quickly reviewing your vault without switching to Obsidian.
Visualize entry relationships as an interactive force-directed graph with /dle-graph. Shows wikilinks, requires/excludes connections, and cascade links between entries.
Replay your chat history step-by-step with /dle-simulate, showing which entries activate and deactivate at each message. Useful for understanding how your keywords and pipeline behave across a conversation.
Use /dle-optimize-keys <entry name> to have AI analyze an entry and suggest better keywords. The AI considers the entry's content, summary, and current keywords to recommend improvements.
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