Merge pull request #109 from jakstein/omniscience-filter

Implementation of omniscience filter, ability to only reveal what player character can see without confusing the LLM.

index.js

@@ -384,6 +384,11 @@ async function initUI() {
         saveSettings();
     });
 
+    $('#rpg-toggle-omniscience').on('change', function() {
+        extensionSettings.enableOmniscienceFilter = $(this).prop('checked');
+        saveSettings();
+    });
+
     $('#rpg-toggle-cyoa').on('change', function() {
         extensionSettings.enableCYOA = $(this).prop('checked');
         saveSettings();
@@ -572,6 +577,12 @@ async function initUI() {
         updateFeatureTogglesVisibility();
     });
 
+    $('#rpg-toggle-show-omniscience-toggle').on('change', function() {
+        extensionSettings.showOmniscienceToggle = $(this).prop('checked');
+        saveSettings();
+        updateFeatureTogglesVisibility();
+    });
+
     $('#rpg-toggle-show-cyoa-toggle').on('change', function() {
         extensionSettings.showCYOAToggle = $(this).prop('checked');
         saveSettings();
@@ -969,6 +980,7 @@ async function initUI() {
     $('#rpg-toggle-html-prompt').prop('checked', extensionSettings.enableHtmlPrompt);
     $('#rpg-toggle-dialogue-coloring').prop('checked', extensionSettings.enableDialogueColoring);
     $('#rpg-toggle-deception').prop('checked', extensionSettings.enableDeceptionSystem ?? false);
+    $('#rpg-toggle-omniscience').prop('checked', extensionSettings.enableOmniscienceFilter ?? false);
     $('#rpg-toggle-cyoa').prop('checked', extensionSettings.enableCYOA ?? false);
     $('#rpg-toggle-spotify-music').prop('checked', extensionSettings.enableSpotifyMusic);
 
@@ -979,6 +991,7 @@ async function initUI() {
     $('#rpg-toggle-show-html-toggle').prop('checked', extensionSettings.showHtmlToggle ?? true);
     $('#rpg-toggle-show-dialogue-coloring-toggle').prop('checked', extensionSettings.showDialogueColoringToggle ?? true);
     $('#rpg-toggle-show-deception-toggle').prop('checked', extensionSettings.showDeceptionToggle ?? true);
+    $('#rpg-toggle-show-omniscience-toggle').prop('checked', extensionSettings.showOmniscienceToggle ?? true);
     $('#rpg-toggle-show-cyoa-toggle').prop('checked', extensionSettings.showCYOAToggle ?? true);
     $('#rpg-toggle-show-spotify-toggle').prop('checked', extensionSettings.showSpotifyToggle ?? true);
     $('#rpg-toggle-show-dynamic-weather-toggle').prop('checked', extensionSettings.showDynamicWeatherToggle ?? true);

src/core/state.js

@@ -29,6 +29,8 @@ export let extensionSettings = {
     customDialogueColoringPrompt: '', // Custom dialogue coloring prompt text (empty = use default)
     enableDeceptionSystem: false, // Enable deception tracking with <lie> tags
     customDeceptionPrompt: '', // Custom deception prompt text (empty = use default)
+    enableOmniscienceFilter: false, // Enable omniscience filter with <filter> tags
+    customOmnisciencePrompt: '', // Custom omniscience filter prompt text (empty = use default)
     enableCYOA: false, // Enable "Choose Your Own Adventure" formatting with action choices
     customCYOAPrompt: '', // Custom CYOA prompt text (empty = use default)
     enableSpotifyMusic: false, // Enable Spotify music integration (asks AI for Spotify URLs)
@@ -41,6 +43,7 @@ export let extensionSettings = {
     showHtmlToggle: true, // Show Immersive HTML toggle in main panel
     showDialogueColoringToggle: true, // Show Dialogue Coloring toggle in main panel (enabled by default)
     showDeceptionToggle: true, // Show Deception System toggle in main panel
+    showOmniscienceToggle: true, // Show Omniscience Filter toggle in main panel
     showCYOAToggle: true, // Show CYOA toggle in main panel
     showSpotifyToggle: true, // Show Spotify Music toggle in main panel
 

src/i18n/en.json

@@ -52,6 +52,10 @@
     "template.settingsModal.display.showImmersiveHtmlToggleNote": "Display a toggle button to enable/disable HTML formatting in messages.",
     "template.settingsModal.display.showDialogueColoringToggle": "Show Colored Dialogues",
     "template.settingsModal.display.showDialogueColoringToggleNote": "Display a toggle button to enable/disable colored dialogue formatting.",
+    "template.settingsModal.display.showDeceptionToggle": "Show Deception System",
+    "template.settingsModal.display.showDeceptionToggleNote": "Display a toggle button to enable/disable the Deception System for marking lies and deceptions.",
+    "template.settingsModal.display.showOmniscienceToggle": "Show Omniscience Filter",
+    "template.settingsModal.display.showOmniscienceToggleNote": "Display a toggle button to enable/disable the Omniscience Filter for filtering hidden events.",
     "template.settingsModal.display.showSpotifyMusicToggle": "Show Spotify Music",
     "template.settingsModal.display.showSpotifyMusicToggleNote": "Display Spotify music player with AI-suggested scene-appropriate tracks.",
     "template.settingsModal.display.showSnowflakesToggle": "Show Snowflakes Effect",
@@ -162,6 +166,8 @@
     "template.mainPanel.clearLastRoll": "Clear last roll",
     "template.mainPanel.immersiveHtml": "Immersive HTML",
     "template.mainPanel.coloredDialogues": "Colored Dialogues",
+    "template.mainPanel.deceptionSystem": "Deception System",
+    "template.mainPanel.omniscienceFilter": "Omniscience Filter",
     "template.mainPanel.spotifyMusic": "Spotify Music",
     "template.mainPanel.snowflakesEffect": "Snowflakes Effect",
     "template.mainPanel.dynamicWeatherEffects": "Dynamic Weather",

src/systems/generation/injector.js

@@ -22,6 +22,7 @@ import {
     DEFAULT_HTML_PROMPT,
     DEFAULT_DIALOGUE_COLORING_PROMPT,
     DEFAULT_DECEPTION_PROMPT,
+    DEFAULT_OMNISCIENCE_FILTER_PROMPT,
     DEFAULT_CYOA_PROMPT,
     DEFAULT_SPOTIFY_PROMPT,
     SPOTIFY_FORMAT_INSTRUCTION
@@ -792,6 +793,19 @@ export async function onGenerationStarted(type, data, dryRun) {
             setExtensionPrompt('rpg-companion-deception', '', extension_prompt_types.IN_CHAT, 0, false);
         }
 
+        // Inject Omniscience Filter prompt separately at depth 0 if enabled
+        if (extensionSettings.enableOmniscienceFilter && !shouldSuppress) {
+            // Use custom Omniscience Filter prompt if set, otherwise use default
+            const omnisciencePromptText = extensionSettings.customOmnisciencePrompt || DEFAULT_OMNISCIENCE_FILTER_PROMPT;
+            const omnisciencePrompt = `\n${omnisciencePromptText}\n`;
+
+            setExtensionPrompt('rpg-companion-omniscience', omnisciencePrompt, extension_prompt_types.IN_CHAT, 0, false);
+            // console.log('[RPG Companion] Injected Omniscience Filter prompt at depth 0 for together mode');
+        } else {
+            // Clear Omniscience Filter prompt if disabled
+            setExtensionPrompt('rpg-companion-omniscience', '', extension_prompt_types.IN_CHAT, 0, false);
+        }
+
         // Inject Spotify prompt separately at depth 0 if enabled
         if (extensionSettings.enableSpotifyMusic && !shouldSuppress) {
             // Use custom Spotify prompt if set, otherwise use default
@@ -880,6 +894,19 @@ Ensure these details naturally reflect and influence the narrative. Character be
             setExtensionPrompt('rpg-companion-deception', '', extension_prompt_types.IN_CHAT, 0, false);
         }
 
+        // Inject Omniscience Filter prompt separately at depth 0 if enabled
+        if (extensionSettings.enableOmniscienceFilter && !shouldSuppress) {
+            // Use custom Omniscience Filter prompt if set, otherwise use default
+            const omnisciencePromptText = extensionSettings.customOmnisciencePrompt || DEFAULT_OMNISCIENCE_FILTER_PROMPT;
+            const omnisciencePrompt = `\n${omnisciencePromptText}\n`;
+
+            setExtensionPrompt('rpg-companion-omniscience', omnisciencePrompt, extension_prompt_types.IN_CHAT, 0, false);
+            // console.log('[RPG Companion] Injected Omniscience Filter prompt at depth 0 for separate/external mode');
+        } else {
+            // Clear Omniscience Filter prompt if disabled
+            setExtensionPrompt('rpg-companion-omniscience', '', extension_prompt_types.IN_CHAT, 0, false);
+        }
+
         // Inject Spotify prompt separately at depth 0 if enabled
         if (extensionSettings.enableSpotifyMusic && !shouldSuppress) {
             // Use custom Spotify prompt if set, otherwise use default
@@ -917,6 +944,7 @@ Ensure these details naturally reflect and influence the narrative. Character be
         setExtensionPrompt('rpg-companion-html', '', extension_prompt_types.IN_CHAT, 0, false);
         setExtensionPrompt('rpg-companion-dialogue-coloring', '', extension_prompt_types.IN_CHAT, 0, false);
         setExtensionPrompt('rpg-companion-deception', '', extension_prompt_types.IN_CHAT, 0, false);
+        setExtensionPrompt('rpg-companion-omniscience', '', extension_prompt_types.IN_CHAT, 0, false);
         setExtensionPrompt('rpg-companion-zzz-cyoa', '', extension_prompt_types.IN_CHAT, 0, false);
         setExtensionPrompt('rpg-companion-spotify', '', extension_prompt_types.IN_CHAT, 0, false);
     }

src/systems/generation/promptBuilder.js

@@ -33,6 +33,30 @@ export const DEFAULT_DIALOGUE_COLORING_PROMPT = `Wrap all character/NPC "dialogu
  */
 export const DEFAULT_DECEPTION_PROMPT = `When a character is lying or deceiving, you should follow up that line with the <lie> tag, containing a brief description of the truth and the lie's reason, using the template below (replace placeholders in quotation marks). This will be hidden from the user's view, but not to you, making it useful for future consequences: <lie character="name" type="lying/deceiving/omitting" truth="truth" reason="reason"/>.`;
 
+/**
+ * Default Omniscience Filter prompt text
+ * This instructs the AI to separate information the player character cannot perceive
+ */
+export const DEFAULT_OMNISCIENCE_FILTER_PROMPT = `OMNISCIENCE FILTER INSTRUCTIONS:
+You must strictly separate what the player character can directly perceive from what they cannot. The player should only read narrative content that their character can actually see, hear, smell, touch, or otherwise directly sense.
+If the player character cannot directly perceive something, but it is happening, it ABSOLUTELY MUST be placed inside of a <filter> tag.
+BEFORE writing any narrative content that involves events, actions, or details the player character CANNOT directly perceive (because they're not looking, too far away, behind them, in another room, happening silently, etc.), you MUST first output that hidden information inside a <filter> tag using this exact format:
+<filter event="[Brief description of what is happening that the player cannot perceive]" reason="[Why the player character cannot perceive this - e.g., 'behind them', 'in another room', 'too quiet to hear', 'focused elsewhere']"/>
+
+CRITICAL RULES:
+1. The <filter> tag must come BEFORE any sensory hints (sounds, smells, etc.) that the player DOES perceive from that event
+2. Only write narrative that reflects what the player character actually experiences through their senses
+3. Instead of "Jake sweeps the floor behind you", write: <filter event="Jake is sweeping the floor" reason="Jake is behind Michael who is focused on reading"/> followed by narrative like "You hear soft sweeping sounds behind you"
+4. NPCs' internal thoughts, silent actions, and events in other locations MUST go in <filter> tags
+5. The player's narrative should create natural mystery and immersion - they experience the world through limited senses, not omniscient narration
+6. Be liberal and proactive in using <filter> tags to hide information the player cannot perceive directly
+7. Don't forget to properly close the <filter> tag with />.
+
+EXAMPLE:
+Wrong: "As you read the newspaper, Sarah quietly pockets the key from the table behind you and slips out the back door."
+Correct: <filter event="Sarah quietly takes the key from the table and slips out the back door" reason="Sarah is behind Michael who is absorbed in reading, and she moves silently"/>You hear a faint click from somewhere behind you, but when you glance up from your newspaper, the room seems unchanged. The afternoon light streams through the windows as you return to your reading.`;
+
+
 /**
  * Default CYOA prompt text
  */

src/systems/ui/promptsEditor.js

@@ -4,7 +4,7 @@
  */
 import { extensionSettings } from '../../core/state.js';
 import { saveSettings } from '../../core/persistence.js';
-import { DEFAULT_HTML_PROMPT, DEFAULT_DIALOGUE_COLORING_PROMPT, DEFAULT_DECEPTION_PROMPT, DEFAULT_CYOA_PROMPT, DEFAULT_SPOTIFY_PROMPT, DEFAULT_NARRATOR_PROMPT } from '../generation/promptBuilder.js';
+import { DEFAULT_HTML_PROMPT, DEFAULT_DIALOGUE_COLORING_PROMPT, DEFAULT_DECEPTION_PROMPT, DEFAULT_OMNISCIENCE_FILTER_PROMPT, DEFAULT_CYOA_PROMPT, DEFAULT_SPOTIFY_PROMPT, DEFAULT_NARRATOR_PROMPT } from '../generation/promptBuilder.js';
 
 let $editorModal = null;
 let tempPrompts = null; // Temporary prompts for cancel functionality
@@ -14,6 +14,7 @@ const DEFAULT_PROMPTS = {
     html: DEFAULT_HTML_PROMPT,
     dialogueColoring: DEFAULT_DIALOGUE_COLORING_PROMPT,
     deception: DEFAULT_DECEPTION_PROMPT,
+    omniscience: DEFAULT_OMNISCIENCE_FILTER_PROMPT,
     cyoa: DEFAULT_CYOA_PROMPT,
     spotify: DEFAULT_SPOTIFY_PROMPT,
     narrator: DEFAULT_NARRATOR_PROMPT,
@@ -96,6 +97,7 @@ function openPromptsEditor() {
         html: extensionSettings.customHtmlPrompt || '',
         dialogueColoring: extensionSettings.customDialogueColoringPrompt || '',
         deception: extensionSettings.customDeceptionPrompt || '',
+        omniscience: extensionSettings.customOmnisciencePrompt || '',
         cyoa: extensionSettings.customCYOAPrompt || '',
         spotify: extensionSettings.customSpotifyPrompt || '',
         narrator: extensionSettings.customNarratorPrompt || '',
@@ -111,6 +113,7 @@ function openPromptsEditor() {
     $('#rpg-prompt-html').val(extensionSettings.customHtmlPrompt || DEFAULT_PROMPTS.html);
     $('#rpg-prompt-dialogue-coloring').val(extensionSettings.customDialogueColoringPrompt || DEFAULT_PROMPTS.dialogueColoring);
     $('#rpg-prompt-deception').val(extensionSettings.customDeceptionPrompt || DEFAULT_PROMPTS.deception);
+    $('#rpg-prompt-omniscience').val(extensionSettings.customOmnisciencePrompt || DEFAULT_PROMPTS.omniscience);
     $('#rpg-prompt-cyoa').val(extensionSettings.customCYOAPrompt || DEFAULT_PROMPTS.cyoa);
     $('#rpg-prompt-spotify').val(extensionSettings.customSpotifyPrompt || DEFAULT_PROMPTS.spotify);
     $('#rpg-prompt-narrator').val(extensionSettings.customNarratorPrompt || DEFAULT_PROMPTS.narrator);
@@ -150,6 +153,7 @@ function savePrompts() {
     extensionSettings.customHtmlPrompt = $('#rpg-prompt-html').val().trim();
     extensionSettings.customDialogueColoringPrompt = $('#rpg-prompt-dialogue-coloring').val().trim();
     extensionSettings.customDeceptionPrompt = $('#rpg-prompt-deception').val().trim();
+    extensionSettings.customOmnisciencePrompt = $('#rpg-prompt-omniscience').val().trim();
     extensionSettings.customCYOAPrompt = $('#rpg-prompt-cyoa').val().trim();
     extensionSettings.customSpotifyPrompt = $('#rpg-prompt-spotify').val().trim();
     extensionSettings.customNarratorPrompt = $('#rpg-prompt-narrator').val().trim();
@@ -182,6 +186,9 @@ function restorePromptToDefault(promptType) {
         case 'deception':
             extensionSettings.customDeceptionPrompt = '';
             break;
+        case 'omniscience':
+            extensionSettings.customOmnisciencePrompt = '';
+            break;
         case 'cyoa':
             extensionSettings.customCYOAPrompt = '';
             break;
@@ -221,6 +228,7 @@ function restoreAllToDefaults() {
     $('#rpg-prompt-html').val(DEFAULT_PROMPTS.html);
     $('#rpg-prompt-dialogue-coloring').val(DEFAULT_PROMPTS.dialogueColoring);
     $('#rpg-prompt-deception').val(DEFAULT_PROMPTS.deception);
+    $('#rpg-prompt-omniscience').val(DEFAULT_PROMPTS.omniscience);
     $('#rpg-prompt-cyoa').val(DEFAULT_PROMPTS.cyoa);
     $('#rpg-prompt-spotify').val(DEFAULT_PROMPTS.spotify);
     $('#rpg-prompt-narrator').val(DEFAULT_PROMPTS.narrator);
@@ -235,6 +243,7 @@ function restoreAllToDefaults() {
     extensionSettings.customHtmlPrompt = '';
     extensionSettings.customDialogueColoringPrompt = '';
     extensionSettings.customDeceptionPrompt = '';
+    extensionSettings.customOmnisciencePrompt = '';
     extensionSettings.customCYOAPrompt = '';
     extensionSettings.customSpotifyPrompt = '';
     extensionSettings.customNarratorPrompt = '';

src/systems/ui/theme.js

@@ -139,6 +139,7 @@ export function updateFeatureTogglesVisibility() {
     const $htmlToggle = $('#rpg-html-toggle-wrapper');
     const $dialogueColoringToggle = $('#rpg-dialogue-coloring-toggle-wrapper');
     const $deceptionToggle = $('#rpg-deception-toggle-wrapper');
+    const $omniscienceToggle = $('#rpg-omniscience-toggle-wrapper');
     const $cyoaToggle = $('#rpg-cyoa-toggle-wrapper');
     const $spotifyToggle = $('#rpg-spotify-toggle-wrapper');
 
@@ -150,6 +151,7 @@ export function updateFeatureTogglesVisibility() {
     $htmlToggle.toggle(extensionSettings.showHtmlToggle);
     $dialogueColoringToggle.toggle(extensionSettings.showDialogueColoringToggle);
     $deceptionToggle.toggle(extensionSettings.showDeceptionToggle ?? true);
+    $omniscienceToggle.toggle(extensionSettings.showOmniscienceToggle ?? true);
     $cyoaToggle.toggle(extensionSettings.showCYOAToggle ?? true);
     $spotifyToggle.toggle(extensionSettings.showSpotifyToggle);
 
@@ -161,6 +163,7 @@ export function updateFeatureTogglesVisibility() {
     const anyVisible = extensionSettings.showHtmlToggle ||
                       extensionSettings.showDialogueColoringToggle ||
                       (extensionSettings.showDeceptionToggle ?? true) ||
+                      (extensionSettings.showOmniscienceToggle ?? true) ||
                       (extensionSettings.showCYOAToggle ?? true) ||
                       extensionSettings.showSpotifyToggle ||
                       extensionSettings.showDynamicWeatherToggle ||

template.html

@@ -139,6 +139,15 @@
                     </label>
                 </div>
 
+                <!-- Omniscience Filter Toggle -->
+                <div class="rpg-toggle-container rpg-feature-col" id="rpg-omniscience-toggle-wrapper">
+                    <label class="rpg-toggle-label" title="Omniscience Filter">
+                        <input type="checkbox" id="rpg-toggle-omniscience">
+                        <i class="fa-solid fa-eye-slash"></i>
+                        <span class="rpg-toggle-text" data-i18n-key="template.mainPanel.omniscienceFilter">Omniscience Filter</span>
+                    </label>
+                </div>
+
                 <!-- CYOA Toggle -->
                 <div class="rpg-toggle-container rpg-feature-col" id="rpg-cyoa-toggle-wrapper">
                     <label class="rpg-toggle-label" title="CYOA">
@@ -388,6 +397,15 @@
                     Display a toggle button to enable/disable special formatting of lies and deceptions crafted by the model, allowing it to easily track whenever one was committed, without showing it to the user.
                 </small>
 
+                <label class="checkbox_label">
+                    <input type="checkbox" id="rpg-toggle-show-omniscience-toggle" />
+                    <span data-i18n-key="template.settingsModal.display.showOmniscienceToggle">Show Omniscience Filter</span>
+                </label>
+                <small style="display: block; margin-left: 24px; margin-top: -8px; color: #888; font-size: 11px;"
+                    data-i18n-key="template.settingsModal.display.showOmniscienceToggleNote">
+                    Display a toggle button to enable/disable the omniscience filter, which instructs the AI to hide information the player character cannot perceive (events behind them, in other rooms, etc.) in special tags.
+                </small>
+
                 <label class="checkbox_label">
                     <input type="checkbox" id="rpg-toggle-show-cyoa-toggle" />
                     <span data-i18n-key="template.settingsModal.display.showCYOAToggle">Show CYOA</span>
@@ -996,6 +1014,20 @@
                 </button>
             </div>
 
+            <!-- Omniscience Filter Prompt -->
+            <div class="rpg-prompt-editor-section">
+                <label for="rpg-prompt-omniscience" style="display: block; margin-bottom: 8px; font-weight: 600;">
+                    <i class="fa-solid fa-eye-slash"></i> Omniscience Filter Prompt
+                </label>
+                <small style="display: block; margin-bottom: 8px; color: #888; font-size: 11px;">
+                    Injected when "Enable Omniscience Filter" is enabled. Instructs AI to separate information the player character cannot perceive into hidden filter tags.
+                </small>
+                <textarea id="rpg-prompt-omniscience" class="rpg-prompt-textarea" rows="6"></textarea>
+                <button class="menu_button rpg-restore-prompt-btn" data-prompt="omniscience" style="margin-top: 8px;">
+                    <i class="fa-solid fa-rotate-left"></i>&nbsp;Restore Default
+                </button>
+            </div>
+
             <!-- CYOA Prompt -->
             <div class="rpg-prompt-editor-section">
                 <label for="rpg-prompt-cyoa" style="display: block; margin-bottom: 8px; font-weight: 600;">