First commit of Objective extension

public/script.js

@@ -419,6 +419,7 @@ export const event_types = {
     MESSAGE_RECEIVED: 'message_received',
     MESSAGE_EDITED: 'message_edited',
     IMPERSONATE_READY: 'impersonate_ready',
+    CHAT_CHANGED: 'chat_id_changed',
 }
 
 export const eventSource = new EventEmitter();
@@ -3613,6 +3614,7 @@ async function getChatResult() {
     if (chat.length === 1) {
         await eventSource.emit(event_types.MESSAGE_RECEIVED, (chat.length - 1));
     }
+    await eventSource.emit(event_types.CHAT_CHANGED, (getCurrentChatId()));
 }
 
 async function openCharacterChat(file_name) {

public/scripts/extensions.js

@@ -29,6 +29,7 @@ const extension_settings = {
     sd: {},
     chromadb: {},
     translate: {},
+    objective: {},
 };
 
 let modules = [];

public/scripts/extensions/objective/index.js

@@ -0,0 +1,302 @@
+import { callPopup, extension_prompt_types } from "../../../script.js";
+import { getContext, extension_settings } from "../../extensions.js";
+import {
+    substituteParams,
+    eventSource,
+    event_types,
+    saveSettingsDebounced
+} from "../../../script.js";
+
+const MODULE_NAME = "Objective"
+const UPDATE_INTERVAL = 1000;
+let globalObjective = ""
+let globalTasks = []
+let currentChatId = ""
+let currentTask = {}
+let checkCounter = 0
+
+
+const objectivePrompts = {
+    "createTask": `Pause your roleplay and generate a list of tasks to complete an objective. Your next response must be formatted as a numbered list of plain text entries. Do not include anything but the numbered list. The list must be prioritized in the order that tasks must be completed.
+
+    The objective that you must make a numbered task list for is: {{objective}}.
+    The tasks created should take into account the character traits of {{char}}. These tasks may or may not involve {{user}}
+
+    Given an example objective of 'Make me a four course dinner', here is an example output:
+    1. Determine what the courses will be
+    2. Find recipes for each course
+    3. Go shopping for supplies with {{user}}
+    4. Cook the food
+    5. Get {{user}} to set the table
+    6. Serve the food
+    7. Enjoy eating the meal with {{user}}
+    `,
+    "checkTaskCompleted": `Pause your roleplay. Determine if this task is completed: {{task}}. 
+    To do this, examine the most recent messages. Your response must only contain either true or false, nothing other words.
+    Example output:
+    true
+    `
+}
+
+const injectPrompts = {
+    "task": "Your current task is {{task}}. Balance existing roleplay with completing this task."
+}
+
+// Background prompt generation
+async function generateQuietPrompt(quiet_prompt) {
+    return await new Promise(
+        async function promptPromise(resolve, reject) {
+            try {
+                await getContext().generate('quiet', { resolve, reject, quiet_prompt, force_name2: true, });
+            }
+            catch {
+                reject();
+            }
+        });
+}
+
+//###############################//
+//#       Task Management       #//
+//###############################//
+
+// Accepts optional position. Defaults to adding to end of list.
+function addTask(description, position=null) {
+    position = position ? position != null : position = globalTasks.length
+    globalTasks.splice(position, 0, {
+        "description": description,
+        "completed": false
+    })
+}
+
+// Get a task either by index or task description. Return current task if none specified
+function getTask(index=null, taskDescription=null){
+    let task = {}
+    if (index == null && taskDescription==null) {
+        task = currentTask
+    } else if (index != null){
+        task = globalObjective[index]
+    } else if (taskDescription != null){
+        task = globalTasks.find(task => {
+            return true ? task.description == description : false
+        })
+    }
+    return task
+}
+
+// Complete the current task, setting next task to next incomplete task
+function completeTask(task) {
+    task.completed = true
+    console.info(`Task successfully completed: ${JSON.stringify(task)}`)
+    setCurrentTask()
+    updateUiTaskList()
+}
+
+// Call Quiet Generate to create task list using character context, then convert to tasks. Should not be called much.
+async function generateTasks() {
+    const prompt = substituteParams(objectivePrompts["createTask"].replace(/{{objective}}/gi, globalObjective));
+    console.log(`Generating tasks for objective with prompt`)
+    const taskResponse = await generateQuietPrompt(prompt)
+    globalTasks = []
+    const numberedListPattern = /^\d+\./
+
+    // Add numbered tasks, store them without the numbers.
+    for (const task of taskResponse.split('\n')) {
+        if (task.match(numberedListPattern) != null) {
+            addTask(task.replace(numberedListPattern,'').trim())
+        }
+    }
+    updateUiTaskList()
+    console.info(`Response for Objective: '${globalObjective}' was \n'${taskResponse}', \nwhich created tasks \n${JSON.stringify(globalTasks, null, 2)} `)
+}
+
+// Call Quiet Generate to check if a task is completed 
+async function checkTaskCompleted() {
+    // Make sure there are tasks
+    if (globalObjective == "" || globalTasks.length == 0){
+        return
+    }
+
+    // Check only at specified interval
+    if (checkCounter <= $('#objective-check-frequency').val()){
+        return
+    }
+    checkCounter = 0
+
+    const prompt = substituteParams(objectivePrompts["checkTaskCompleted"].replace(/{{task}}/gi, currentTask.description));
+    const taskResponse = (await generateQuietPrompt(prompt)).toLowerCase()
+
+    // Check response if task complete
+    if (taskResponse.includes("true")){
+        console.info(`Character determined task '${JSON.stringify(currentTask)} is completed.`)
+        completeTask(getTask())
+    } else if (!(taskResponse.includes("false"))) {
+        console.warn(`checkTaskCompleted response did not contain true or false. taskResponse: ${taskResponse}`)
+    } else {
+        console.debug(`taskResponse: ${taskResponse}`)
+    }
+ }
+
+
+// Set a task in extensionPrompt context. Defaults to first incomplete
+function setCurrentTask(index=null) {
+    const context = getContext();
+    currentTask = {}
+
+    // Default to selecting first incomplete task if not given index, else no task
+    if (index==null){
+        currentTask = globalTasks.find(task=>{return true? !task.completed: false})
+    } else if (index < globalTasks.length && index > 0){
+        currentTask = globalTasks[index]
+    }
+    
+    // Inject task into extension prompt context
+    if (Object.keys(currentTask).length > 0){
+        context.setExtensionPrompt(
+            MODULE_NAME, injectPrompts["task"].replace(/{{task}}/gi, currentTask.description), 1, $('#objective-chat-depth').val()
+        );
+        console.info(`Current task in context.extensionPrompts.Objective is ${JSON.stringify(context.extensionPrompts.Objective)}`)
+    } else {
+        context.setExtensionPrompt(MODULE_NAME,'')
+        console.info(`No current task`)
+    }
+}
+
+//###############################//
+//#       UI AND Settings       #//
+//###############################//
+
+
+const defaultSettings = {
+    objective: "",
+    tasks: [],
+    chatDepth: 2,
+    checkFrequency:3,
+}
+
+// Convenient single call
+function resetState(){
+    checkCounter = 0
+    loadSettings();
+}
+
+function debugObjectiveFunction(){
+    console.log({
+        "globalObjective": globalObjective,
+        "globalTasks": globalTasks,
+        "currentChatId": currentChatId,
+        "currentTask": currentTask,
+        "checkCounter": checkCounter,
+        "currentChatId": currentChatId,
+        "extension_settings": extension_settings.objective[currentChatId],
+    })
+}
+
+window.debugObjectiveFunction = debugObjectiveFunction
+
+// Create user-friendly task string
+function updateUiTaskList() {
+    let taskPrettyString = ""
+    for (const index in globalTasks) {
+        if (globalTasks[index].completed == true){
+            taskPrettyString += '[*] '
+        } else {
+            taskPrettyString += '[ ] '
+        }
+        taskPrettyString += `${Number(index) + 1}. `
+        taskPrettyString += globalTasks[index].description
+        if (index != globalTasks.length-1) {
+            taskPrettyString += '\n'
+        }
+    }
+    $('#objective-tasks').text(taskPrettyString)
+}
+
+// Trigger creation of new tasks with given objective.
+async function onGenerateObjectiveClick() {
+    globalObjective = $('#objective-text').val()
+    await generateTasks()
+    extension_settings.objective[currentChatId].objective = globalObjective
+    extension_settings.objective[currentChatId].tasks = globalTasks
+    saveSettingsDebounced()
+}
+
+// Update extension prompts
+function onChatDepthInput() {
+    if (currentChatId == ""){
+        currentChatId = getContext().chatId
+    }
+    extension_settings.objective[currentChatId].chatDepth = $('#objective-chat-depth').val()
+    setCurrentTask() // Ensure extension prompt is updated
+    saveSettingsDebounced()
+}
+
+function onCheckFrequencyInput() {
+    if (currentChatId == ""){
+        currentChatId = getContext().chatId
+    }
+    extension_settings.objective[currentChatId].checkFrequency = $('#objective-check-frequency').val()
+    saveSettingsDebounced()
+}
+
+function loadSettings() {
+    // Load/Init settings for chatId
+    currentChatId = getContext().chatId
+
+    // Bail on home screen
+    if (currentChatId == undefined) {
+        return
+    }
+    if (!(currentChatId in extension_settings.objective)) {
+        extension_settings.objective[currentChatId] = {}
+        Object.assign(extension_settings.objective[currentChatId], defaultSettings)
+    }
+
+    // Update globals
+    globalObjective = extension_settings.objective[currentChatId].objective
+    globalTasks = extension_settings.objective[currentChatId].tasks
+
+    // Update UI elements
+    $("#objective-text").text(globalObjective)
+    updateUiTaskList()
+    $('#objective-chat-depth').val(extension_settings.objective[currentChatId].chatDepth)
+    $('#objective-check-frequency').val(extension_settings.objective[currentChatId].checkFrequency)
+}
+
+jQuery(() => {
+    const settingsHtml = `
+    <div class="objective-settings">
+        <div class="inline-drawer">
+            <div class="inline-drawer-toggle inline-drawer-header">
+            <b>Objective</b>
+            <div class="inline-drawer-icon fa-solid fa-circle-chevron-down down"></div>
+        </div>
+        <div class="inline-drawer-content">
+            <label for="objective-text">Objective</label>
+            <textarea id="objective-text" type="text" class="text_pole textarea_compact" rows="4"></textarea>
+            <input id="objective-generate" class="menu_button" type="submit" value="Generate Tasks" />
+            <label for="objective-tasks">Objective Tasks</label>
+            <textarea id="objective-tasks" class="text_pole" rows="8" placeholder="Objective tasks will be generated here..."></textarea>
+            <label for="objective-chat-depth">In-chat @ Depth</label>
+            <input id="objective-chat-depth" class="text_pole widthUnset" type="number" min="0" max="99" />
+            <label for="objective-check-frequency">Task Check Frequency</label>
+            <input id="objective-check-frequency" class="text_pole widthUnset" type="number" min="1" max="99" />
+            
+        </div>
+    </div>`;
+    
+    $('#extensions_settings').append(settingsHtml);
+    $('#objective-generate').on('click', onGenerateObjectiveClick)
+    $('#objective-chat-depth').on('input',onChatDepthInput)
+    $("#objective-check-frequency").on('input',onCheckFrequencyInput)
+    loadSettings()
+    
+    eventSource.on(event_types.CHAT_CHANGED, () => {
+        resetState()
+    });
+
+    eventSource.on(event_types.MESSAGE_RECEIVED, () => {
+        checkTaskCompleted();
+        checkCounter += 1
+        setCurrentTask();
+    });
+});

public/scripts/extensions/objective/manifest.json

@@ -0,0 +1,11 @@
+{
+    "display_name": "Objective",
+    "loading_order": 5,
+    "requires": [],
+    "optional": [],
+    "js": "index.js",
+    "css": "style.css",
+    "author": "Ouoertheo",
+    "version": "0.0.1",
+    "homePage": ""
+}

readme.md

@@ -299,3 +299,4 @@ GNU Affero General Public License for more details.**
 * AI Horde client library by ZeldaFan0225: https://github.com/ZeldaFan0225/ai_horde
 * Linux startup script by AlpinDale
 * Thanks paniphons for providing a FAQ document
+* TTS and Objective extensions by Ouoertheo