Merge pull request #3146 from SillyTavern/persona-lorebook Persona lorebook

3698f407094ec4af75c277a3d6c0f7db200b7017

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

Parents: 00006aa072b9cf3bd53e5253419c876a7274102d 16c2183fd083767d88b8c9130440066cedcacb5d

public/index.html+3 -21 Viewed

                                 </div>
                                 <div id="sync_name_button" class="menu_button fa-solid fa-sync" title="Click to set user name for all messages" data-i18n="[title]Click to set user name for all messages">
                                 </div>
+                                <div id="persona_lore_button" class="menu_button fa-solid fa-globe" title="Persona Lore&#10;Alt+Click to open the lorebook" data-i18n="[title]Persona Lore Alt+Click to open the lorebook">
+                                </div>
                             </div>
                             <div>
                                 <h4 data-i18n="Persona Description">Persona Description</h4>

                                             <input type="hidden" id="fav_checkbox" name="fav" />
                                             <div id="advanced_div" class="menu_button fa-solid fa-book " title="Advanced Definitions" data-i18n="[title]Advanced Definition"></div>
                                             <div id="world_button" class="menu_button fa-solid fa-globe" title="Character Lore&#10;&#10;Click to load&#10;Shift-click to open 'Link to World Info' popup" data-i18n="[title]world_button_title"></div>
-                                            <div class="chat_lorebook_button menu_button fa-solid fa-passport" title="Chat Lore" data-i18n="[title]Chat Lore"></div>
+                                            <div class="chat_lorebook_button menu_button fa-solid fa-passport" title="Chat Lore&#10;Alt+Click to open the lorebook" data-i18n="[title]Chat Lore Alt+Click to open the lorebook"></div>
                                             <div id="export_button" class="menu_button fa-solid fa-file-export " title="Export and Download" data-i18n="[title]Export and Download"></div>
                                             <!-- <div id="set_chat_scenario" class="menu_button fa-solid fa-scroll" title="Set a chat scenario override"></div> -->
                                             <!-- <div id="set_character_world" class="menu_button fa-solid fa-globe" title="Set a character World Info / Lorebook"></div> -->

             </div>
         </div>
         <!-- templates for JS to reuse when needed -->
-        <div id="chat_world_template" class="template_element">
-            <div class="chat_world range-block flexFlowColumn flex-container">
-                <div class="range-block-title">
-                    <h4 data-i18n="Chat Lorebook"><!-- This data-i18n attribute is kept for backward compatibility, use the ones below when translating -->
-                        <span data-i18n="Chat Lorebook for">Chat Lorebook for</span> <span class="chat_name"></span>
-                    </h4>
-                </div>
-                <div class="range-block-counter justifyLeft flex-container flexFlowColumn margin-bot-10px">
-                    <span data-i18n="chat_world_template_txt">
-                        A selected World Info will be bound to this chat. When generating an AI reply,
-                        it will be combined with the entries from global and character lorebooks.
-                    </span>
-                </div>
-                <div class="range-block-range wide100p">
-                    <select class="chat_world_info_selector wide100p">
-                        <option value="">--- None ---</option>
-                    </select>
-                </div>
-            </div>
-        </div>
         <div id="character_world_template" class="template_element">
             <div class="character_world range-block flexFlowColumn flex-container">
                 <div class="range-block-title">

public/scripts/personas.js+68 -2 Viewed

 import { debounce_timeout } from './constants.js';
 import { FILTER_TYPES, FilterHelper } from './filters.js';
 import { selected_group } from './group-chats.js';
-import { POPUP_RESULT, POPUP_TYPE, Popup } from './popup.js';
+import { POPUP_RESULT, POPUP_TYPE, Popup, callGenericPopup } from './popup.js';
 import { t } from './i18n.js';
+import { openWorldInfoEditor, world_names } from './world-info.js';
+import { renderTemplateAsync } from './templates.js';
 let savePersonasPage = 0;
 const GRID_STORAGE_KEY = 'Personas_GridView';

         position: persona_description_positions.IN_PROMPT,
         depth: DEFAULT_DEPTH,
         role: DEFAULT_ROLE,
+        lorebook: '',
     };
     saveSettingsDebounced();

         position: persona_description_positions.IN_PROMPT,
         depth: DEFAULT_DEPTH,
         role: DEFAULT_ROLE,
+        lorebook: '',
     };
     // If the user is currently using this persona, update the description

         .val(power_user.persona_description_role)
         .find(`option[value="${power_user.persona_description_role}"]`)
         .prop('selected', String(true));
+    $('#persona_lore_button').toggleClass('world_set', !!power_user.persona_description_lorebook);
     countPersonaDescriptionTokens();
+}

             position: persona_description_positions.IN_PROMPT,
             depth: DEFAULT_DEPTH,
             role: DEFAULT_ROLE,
+            lorebook: '',
         };
         console.log(`Created persona name for ${avatarId} as ${newName}`);
+    }

                 position: isCurrentPersona ? power_user.persona_description_position : persona_description_positions.IN_PROMPT,
                 depth: isCurrentPersona ? power_user.persona_description_depth : DEFAULT_DEPTH,
                 role: isCurrentPersona ? power_user.persona_description_role : DEFAULT_ROLE,
+                lorebook: isCurrentPersona ? power_user.persona_description_lorebook : '',
             };
+        }

             power_user.persona_description_position = descriptor.position ?? persona_description_positions.IN_PROMPT;
             power_user.persona_description_depth = descriptor.depth ?? DEFAULT_DEPTH;
             power_user.persona_description_role = descriptor.role ?? DEFAULT_ROLE;
+            power_user.persona_description_lorebook = descriptor.lorebook ?? '';
         } else {
             power_user.persona_description = '';
             power_user.persona_description_position = persona_description_positions.IN_PROMPT;
             power_user.persona_description_depth = DEFAULT_DEPTH;
             power_user.persona_description_role = DEFAULT_ROLE;
-            power_user.persona_descriptions[user_avatar] = { description: '', position: persona_description_positions.IN_PROMPT, depth: DEFAULT_DEPTH, role: DEFAULT_ROLE };
+            power_user.persona_description_lorebook = '';
+            power_user.persona_descriptions[user_avatar] = {
+                description: '',
+                position: persona_description_positions.IN_PROMPT,
+                depth: DEFAULT_DEPTH,
+                role: DEFAULT_ROLE,
+                lorebook: '',
+            };
+        }
         setPersonaDescription();

             position: persona_description_positions.IN_PROMPT,
             depth: DEFAULT_DEPTH,
             role: DEFAULT_ROLE,
+            lorebook: '',
         };
+    }

                 position: Number($('#persona_description_position').find(':selected').val()),
                 depth: Number($('#persona_depth_value').val()),
                 role: Number($('#persona_depth_role').find(':selected').val()),
+                lorebook: '',
             };
             power_user.persona_descriptions[user_avatar] = object;
+        }

     saveSettingsDebounced();
+}
+/**
+ * Opens a popup to set the lorebook for the current persona.
+ * @param {PointerEvent} event Click event
+ */
+async function onPersonaLoreButtonClick(event) {
+    const personaName = power_user.personas[user_avatar];
+    const selectedLorebook = power_user.persona_description_lorebook;
+    if (!personaName) {
+        toastr.warning(t`You must bind a name to this persona before you can set a lorebook.`, t`Persona name not set`);
+        return;
+    }
+    if (event.altKey && selectedLorebook) {
+        openWorldInfoEditor(selectedLorebook);
+        return;
+    }
+    const template = $(await renderTemplateAsync('personaLorebook'));
+    const worldSelect = template.find('select');
+    template.find('.persona_name').text(personaName);
+    for (const worldName of world_names) {
+        const option = document.createElement('option');
+        option.value = worldName;
+        option.innerText = worldName;
+        option.selected = selectedLorebook === worldName;
+        worldSelect.append(option);
+    }
+    worldSelect.on('change', function () {
+        power_user.persona_description_lorebook = String($(this).val());
+        if (power_user.personas[user_avatar]) {
+            const object = getOrCreatePersonaDescriptor();
+            object.lorebook = power_user.persona_description_lorebook;
+        }
+        $('#persona_lore_button').toggleClass('world_set', !!power_user.persona_description_lorebook);
+        saveSettingsDebounced();
+    });
+    await callGenericPopup(template, POPUP_TYPE.TEXT);
+}
 function onPersonaDescriptionPositionInput() {
     power_user.persona_description_position = Number(
         $('#persona_description_position').find(':selected').val(),

             position: power_user.persona_description_position,
             depth: power_user.persona_description_depth,
             role: power_user.persona_description_role,
+            lorebook: power_user.persona_description_lorebook,
         };
         power_user.persona_descriptions[user_avatar] = object;
+    }

         position: descriptor?.position ?? persona_description_positions.IN_PROMPT,
         depth: descriptor?.depth ?? DEFAULT_DEPTH,
         role: descriptor?.role ?? DEFAULT_ROLE,
+        lorebook: descriptor?.lorebook ?? '',
     };
     await uploadUserAvatar(getUserAvatar(avatarId), newAvatarId);

     $('#persona_description_position').on('input', onPersonaDescriptionPositionInput);
     $('#persona_depth_value').on('input', onPersonaDescriptionDepthValueInput);
     $('#persona_depth_role').on('input', onPersonaDescriptionDepthRoleInput);
+    $('#persona_lore_button').on('click', onPersonaLoreButtonClick);
     $('#personas_backup').on('click', onBackupPersonas);
     $('#personas_restore').on('click', () => $('#personas_restore_input').trigger('click'));
     $('#personas_restore_input').on('change', onPersonasRestoreInput);

public/scripts/power-user.js+1 -0 Viewed

     persona_description_position: persona_description_positions.IN_PROMPT,
     persona_description_role: 0,
     persona_description_depth: 2,
+    persona_description_lorebook: '',
     persona_show_notifications: true,
     persona_sort_order: 'asc',

public/scripts/templates/chatLorebook.html+18 -0 Viewed

+<div class="chat_world range-block flexFlowColumn flex-container">
+    <div class="range-block-title">
+        <h4 data-i18n="Chat Lorebook"><!-- This data-i18n attribute is kept for backward compatibility, use the ones below when translating -->
+            <span data-i18n="Chat Lorebook for">Chat Lorebook for</span> <span class="chat_name"></span>
+        </h4>
+    </div>
+    <div class="range-block-counter justifyLeft flex-container flexFlowColumn margin-bot-10px">
+        <span data-i18n="chat_world_template_txt">
+            A selected World Info will be bound to this chat. When generating an AI reply,
+            it will be combined with the entries from global and character lorebooks.
+        </span>
+    </div>
+    <div class="range-block-range wide100p">
+        <select class="chat_world_info_selector wide100p">
+            <option value="">--- None ---</option>
+        </select>
+    </div>
+</div>

public/scripts/templates/personaLorebook.html+18 -0 Viewed

+<div class="persona_world range-block flexFlowColumn flex-container">
+    <div class="range-block-title">
+        <h4>
+            <span data-i18n="PErsona Lorebook for">Persona Lorebook for</span> <span class="persona_name"></span>
+        </h4>
+    </div>
+    <div class="range-block-counter justifyLeft flex-container flexFlowColumn margin-bot-10px">
+        <span data-i18n="persona_world_template_txt">
+            A selected World Info will be bound to this persona. When generating an AI reply,
+            it will be combined with the entries from global, character and chat lorebooks.
+        </span>
+    </div>
+    <div class="range-block-range wide100p">
+        <select class="persona_world_info_selector wide100p">
+            <option value="">--- None ---</option>
+        </select>
+    </div>
+</div>

public/scripts/world-info.js+72 -13 Viewed

             continue;
+        }
+        if (power_user.persona_description_lorebook === worldName) {
+            console.debug(`[WI] Character ${name}'s world ${worldName} is already activated in persona lore! Skipping...`);
+            continue;
+        }
         const data = await loadWorldInfo(worldName);
         const newEntries = data ? Object.keys(data.entries).map((x) => data.entries[x]).map(({ uid, ...rest }) => ({ uid, world: worldName, ...rest })) : [];
         entries = entries.concat(newEntries);

     return entries;
+}
+async function getPersonaLore() {
+    const chatWorld = chat_metadata[METADATA_KEY];
+    const personaWorld = power_user.persona_description_lorebook;
+    if (!personaWorld) {
+        return [];
+    }
+    if (chatWorld === personaWorld) {
+        console.debug(`[WI] Persona world ${personaWorld} is already activated in chat world! Skipping...`);
+        return [];
+    }
+    if (selected_world_info.includes(personaWorld)) {
+        console.debug(`[WI] Persona world ${personaWorld} is already activated in global world info! Skipping...`);
+        return [];
+    }
+    const data = await loadWorldInfo(personaWorld);
+    const entries = data ? Object.keys(data.entries).map((x) => data.entries[x]).map(({ uid, ...rest }) => ({ uid, world: personaWorld, ...rest })) : [];
+    console.debug(`[WI] Persona lore has ${entries.length} entries`, [personaWorld]);
+    return entries;
+}
 export async function getSortedEntries() {
     try {
-        const globalLore = await getGlobalLore();
+        const [
-        const characterLore = await getCharacterLore();
+            globalLore,
-        const chatLore = await getChatLore();
+            characterLore,
+            chatLore,
+            personaLore,
+        ] = await Promise.all([
+            getGlobalLore(),
+            getCharacterLore(),
+            getChatLore(),
+            getPersonaLore(),
+        ]);
         let entries;

                 break;
+        }
-        // Chat lore always goes first
+        // Chat lore always goes first, then persona lore, then the rest
-        entries = [...chatLore.sort(sortFn), ...entries];
+        entries = [...chatLore.sort(sortFn), ...personaLore.sort(sortFn), ...entries];
         // Calculate hash and parse decorators. Split maps to preserve old hashes.
         entries = entries.map((entry) => {

     });
+}
-export function assignLorebookToChat() {
+/**
+ * Forces the world info editor to open on a specific world.
+ * @param {string} worldName The name of the world to open
+ */
+export function openWorldInfoEditor(worldName) {
+    console.log(`Opening lorebook for ${worldName}`);
+    if (!$('#WorldInfo').is(':visible')) {
+        $('#WIDrawerIcon').trigger('click');
+    }
+    const index = world_names.indexOf(worldName);
+    $('#world_editor_select').val(index).trigger('change');
+}
+/**
+ * Assigns a lorebook to the current chat.
+ * @param {PointerEvent} event Pointer event
+ * @returns {Promise<void>}
+ */
+export async function assignLorebookToChat(event) {
     const selectedName = chat_metadata[METADATA_KEY];
-    const template = $('#chat_world_template .chat_world').clone();
+    if (selectedName && event.altKey) {
+        openWorldInfoEditor(selectedName);
+        return;
+    }
+    const template = $(await renderTemplateAsync('chatLorebook'));
     const worldSelect = template.find('select');
     const chatName = template.find('.chat_name');

         saveMetadata();
     });
-    callPopup(template, 'text');
+    return callGenericPopup(template, POPUP_TYPE.TEXT);
+}
 jQuery(() => {

             const worldName = characters[chid]?.data?.extensions?.world;
             const hasEmbed = checkEmbeddedWorld(chid);
             if (worldName && world_names.includes(worldName) && !event.shiftKey) {
-                if (!$('#WorldInfo').is(':visible')) {
+                openWorldInfoEditor(worldName);
-                    $('#WIDrawerIcon').trigger('click');
-                }
-                const index = world_names.indexOf(worldName);
-                $('#world_editor_select').val(index).trigger('change');
             } else if (hasEmbed && !event.shiftKey) {
                 await importEmbeddedWorldInfo();
                 saveCharacterDebounced();

public/style.css+4 -0 Viewed

     width: max-content;
+}
+#persona-management-block .menu_button {
+    filter: grayscale(0.5);
+}
 input[type=search]::-webkit-search-cancel-button {
     -webkit-appearance: none;
     height: 1em;