Installation

Installation

Step-by-step guide to installing and configuring DeepLore Enhanced.

Prerequisites

Before you begin, make sure you have:

• SillyTavern 1.12.0+
• Obsidian with the Local REST API community plugin installed and enabled
• Server plugins enabled in SillyTavern (enableServerPlugins: true in config.yaml)
• For AI search (one of):
  • A saved Connection Manager profile in SillyTavern (any provider -- Anthropic, OpenAI, OpenRouter, etc.)
  • claude-code-proxy running locally

Do NOT run both DeepLore and DeepLore Enhanced. They will conflict. Pick one.

---

Step 1: Install the Client Extension

Option A: Built-in Installer (Recommended)

1. Open SillyTavern
2. Go to the Extensions panel (puzzle piece icon)
3. Click Install Extension
4. Paste the URL:

   https://github.com/pixelnull/sillytavern-DeepLore-Enhanced
   

5. Click Install

Option B: Manual Git Clone

cd SillyTavern/data/default-user/extensions
git clone https://github.com/pixelnull/sillytavern-DeepLore-Enhanced.git

---

Step 2: Install the Server Plugin

The server plugin is required for Obsidian communication and (optionally) AI search proxying.

Option A: Installer Script (Recommended)

The extension ships with installer scripts. Run the one for your platform from the extension directory:

• Windows: Double-click install-server.bat
• Linux/Mac: Run ./install-server.sh

If the extension is not located inside the SillyTavern directory tree, pass the path to SillyTavern as an argument:

./install-server.sh /path/to/SillyTavern

Option B: Manual Copy

1. Locate the server folder inside the extension directory:

   SillyTavern/data/default-user/extensions/sillytavern-DeepLore-Enhanced/server/
   

2. Copy the entire server folder into SillyTavern/plugins/
3. Rename it to deeplore-enhanced

When done, you should have:

SillyTavern/plugins/deeplore-enhanced/
  index.js
  package.json
  core/
    obsidian.js

---

Step 3: Enable Server Plugins

Open SillyTavern/config.yaml and set:

enableServerPlugins: true

If this line does not exist, add it.

---

Step 4: Restart SillyTavern

Stop and restart SillyTavern. Check the server console -- you should see a line confirming the DeepLore Enhanced plugin loaded.

---

First-Time Setup

Obsidian Connection

1. In Obsidian, open Settings > Community Plugins and install/enable Local REST API
2. Go to Settings > Local REST API and note the API port (default: 27123) and copy the API key
3. In SillyTavern, go to Extensions > DeepLore Enhanced
4. Enter the port and API key in the connection fields
5. Click Test Connection -- you should see a success message
6. Check Enable DeepLore Enhanced
7. Click Refresh Index to pull entries from your vault

At this point, any entries in your vault tagged with #lorebook will be matched by keywords during generation. See Writing Vault Entries for how to create and tag entries.

AI Search Setup (Optional)

AI search adds a second stage to the pipeline: after keyword pre-filtering, an AI model reviews the candidate entries and selects the most contextually relevant ones. See AI Search for a full explanation of how it works.

Option A: Connection Profile (Recommended)

This uses an existing SillyTavern API connection with no extra software.

1. Make sure you have at least one API connection set up in SillyTavern and saved as a Connection Manager profile
2. In DLE settings, scroll down to AI Search
3. Check Enable AI Search
4. Set connection mode to Connection Profile (this is the default)
5. Choose your profile from the dropdown
6. Optionally set a Model Override (e.g., to force a cheaper model like Haiku)
7. Click Test AI Search to verify

Option B: Custom Proxy

This routes AI requests through an external proxy server.

1. Install and start claude-code-proxy (defaults to http://localhost:42069)
2. In DLE settings, scroll down to AI Search
3. Check Enable AI Search
4. Set connection mode to Custom Proxy
5. Set the Proxy URL (e.g., http://localhost:42069)
6. Set the Model Override (e.g., claude-haiku-4-5-20251001)
7. Click Test AI Search to verify

---

Updating

Client Extension

If you installed via the built-in installer, SillyTavern will show an update notification when a new version is available. Click Update in the Extensions panel.

If you installed manually, pull the latest changes:

cd SillyTavern/data/default-user/extensions/sillytavern-DeepLore-Enhanced
git pull

Server Plugin

After updating the client extension, re-run the installer script (Step 2, Option A) or manually copy the server folder again (Step 2, Option B) to ensure the server plugin is also updated.

---

Troubleshooting

Server plugin not loading

• Check config.yaml: enableServerPlugins must be true. This is false by default.
• Check the folder name: The plugin folder must be SillyTavern/plugins/deeplore-enhanced/ with an index.js at the root. A common mistake is having a nested folder like plugins/deeplore-enhanced/server/index.js -- the index.js must be directly inside deeplore-enhanced/.
• Check the server console: Look for errors when SillyTavern starts. The plugin should log a message on successful load.
• Restart SillyTavern: Plugins are only loaded at startup. Any changes to the plugin require a full restart.

Connection refused (Obsidian)

• Is Obsidian open? The Local REST API plugin only serves requests while Obsidian is running.
• Is the Local REST API plugin enabled? Check Obsidian Settings > Community Plugins.
• Check the port: The default is 27123. Make sure the port in DLE settings matches what Local REST API is using.
• Check the API key: Copy it fresh from Obsidian Settings > Local REST API. Keys are regenerated when the plugin is reinstalled.
• Firewall: If SillyTavern and Obsidian are on different machines, ensure the port is open.

AI Search test fails

• Connection Profile mode: Make sure the selected profile still exists and its underlying API connection works. Test the connection in SillyTavern's main API panel first.
• Custom Proxy mode: Verify the proxy is running (curl http://localhost:42069 or equivalent). Check the proxy's console for errors.
• Timeout: AI search has a configurable timeout (default 15 seconds). Slow providers may need a longer timeout in Settings Reference.

No entries found after Refresh Index

• Check your tags: Entries must have the #lorebook tag (or whatever you set as the lorebook tag in settings). The tag must be in the frontmatter tags array.
• Check the vault directory: By default, DLE scans the entire vault. If you have entries in a specific folder, make sure there are no path issues.
• Check frontmatter format: Keys and other fields must be valid YAML. See Writing Vault Entries for the correct format.

Extension not appearing in SillyTavern

• Check the extensions folder: The extension should be at SillyTavern/data/default-user/extensions/sillytavern-DeepLore-Enhanced/ with manifest.json at the root.
• Check SillyTavern version: DeepLore Enhanced requires SillyTavern 1.12.0 or later.
• Clear browser cache: Hard-refresh (Ctrl+Shift+R) or clear cache and reload.