From fad4e4e75e074dd99bca3d5adc63b946b3aa7023 Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Mon, 27 Jan 2025 22:30:35 +0200
Subject: [PATCH 01/11] Add command and profile for custom stop strings

---
 .../extensions/connection-manager/index.js    |  4 +++
 public/scripts/power-user.js                  | 30 +++++++++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/public/scripts/extensions/connection-manager/index.js b/public/scripts/extensions/connection-manager/index.js
index e9d0dd2fe..f31e4b495 100644
--- a/public/scripts/extensions/connection-manager/index.js
+++ b/public/scripts/extensions/connection-manager/index.js
@@ -30,6 +30,7 @@ const CC_COMMANDS = [
     'api-url',
     'model',
     'proxy',
+    'stop-strings',
 ];
 
 const TC_COMMANDS = [
@@ -43,6 +44,7 @@ const TC_COMMANDS = [
     'context',
     'instruct-state',
     'tokenizer',
+    'stop-strings',
 ];
 
 const FANCY_NAMES = {
@@ -57,6 +59,7 @@ const FANCY_NAMES = {
     'instruct': 'Instruct Template',
     'context': 'Context Template',
     'tokenizer': 'Tokenizer',
+    'stop-strings': 'Custom Stopping Strings',
 };
 
 /**
@@ -138,6 +141,7 @@ const profilesProvider = () => [
  * @property {string} [context] Context Template
  * @property {string} [instruct-state] Instruct Mode
  * @property {string} [tokenizer] Tokenizer
+ * @property {string} [stop-strings] Custom Stopping Strings
  * @property {string[]} [exclude] Commands to exclude
  */
 
diff --git a/public/scripts/power-user.js b/public/scripts/power-user.js
index 2a74f8722..2c1d5cd4c 100644
--- a/public/scripts/power-user.js
+++ b/public/scripts/power-user.js
@@ -4072,4 +4072,34 @@ $(document).ready(() => {
         ],
         helpString: 'activates a movingUI preset by name',
     }));
+    SlashCommandParser.addCommandObject(SlashCommand.fromProps({
+        name: 'stop-strings',
+        aliases: ['stopping-strings'],
+        helpString: 'Sets a list of custom stopping strings. Gets the list if no value is provided.',
+        returns: ARGUMENT_TYPE.LIST,
+        unnamedArgumentList: [
+            SlashCommandArgument.fromProps({
+                description: 'list of strings',
+                typeList: [ARGUMENT_TYPE.LIST],
+                acceptsMultiple: false,
+                isRequired: false,
+            }),
+        ],
+        callback: (_, value) => {
+            if (String(value ?? '').trim()) {
+                const parsedValue = ((x) => { try { return JSON.parse(x.toString()); } catch { return null; } })(value);
+                if (!parsedValue || !Array.isArray(parsedValue)) {
+                    throw new Error('Invalid list format. The value must be a JSON-serialized array of strings.');
+                }
+                parsedValue.forEach((item, index) => {
+                    parsedValue[index] = String(item);
+                });
+                power_user.custom_stopping_strings = JSON.stringify(parsedValue);
+                $('#custom_stopping_strings').val(power_user.custom_stopping_strings);
+                saveSettingsDebounced();
+            }
+
+            return power_user.custom_stopping_strings;
+        },
+    }));
 });

From 283ceb6bbfff486fdbbc8358c02099a4ff92a24d Mon Sep 17 00:00:00 2001
From: Dzmitry Kazlouski <d.kazlouski@pxlnd.com>
Date: Tue, 28 Jan 2025 02:51:05 +0300
Subject: [PATCH 02/11] Decrease TTS generation delay by splitting a message on
 a new line

---
 public/scripts/extensions/tts/index.js | 33 ++++++++++++++++++++++----
 1 file changed, 29 insertions(+), 4 deletions(-)

diff --git a/public/scripts/extensions/tts/index.js b/public/scripts/extensions/tts/index.js
index 4b8978422..636103f23 100644
--- a/public/scripts/extensions/tts/index.js
+++ b/public/scripts/extensions/tts/index.js
@@ -120,7 +120,7 @@ async function onNarrateOneMessage() {
     }
 
     resetTtsPlayback();
-    ttsJobQueue.push(message);
+    splitMessageAndAddToTtsJobQueue(message);
     moduleWorker();
 }
 
@@ -147,7 +147,7 @@ async function onNarrateText(args, text) {
     }
 
     resetTtsPlayback();
-    ttsJobQueue.push({ mes: text, name: name });
+    splitMessageAndAddToTtsJobQueue({ mes: text, name: name });
     await moduleWorker();
 
     // Return back to the chat voices
@@ -220,6 +220,31 @@ function isTtsProcessing() {
     return processing;
 }
 
+/**
+ * Splits a message into lines and adds each non-empty line to the TTS job queue.
+ * @param {Object} message - The message object to be processed.
+ * @param {string} message.mes - The text of the message to be split into lines.
+ * @param {string} message.name - The name associated with the message.
+ * @returns {void}
+ */
+function splitMessageAndAddToTtsJobQueue(message) {
+    const lines = message.mes.split("\n");
+
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+
+        if (line.length === 0) {
+            continue;
+        }
+
+        ttsJobQueue.push(
+            Object.assign({}, message, {
+                mes: line,
+            })
+        );
+    }
+}
+
 function debugTtsPlayback() {
     console.log(JSON.stringify(
         {
@@ -350,7 +375,7 @@ function onAudioControlClicked() {
         talkingAnimation(false);
     } else {
         // Default play behavior if not processing or playing is to play the last message.
-        ttsJobQueue.push(context.chat[context.chat.length - 1]);
+        splitMessageAndAddToTtsJobQueue(context.chat[context.chat.length - 1]);
     }
     updateUiAudioPlayState();
 }
@@ -816,7 +841,7 @@ async function onMessageEvent(messageId, lastCharIndex) {
     lastChatId = context.chatId;
 
     console.debug(`Adding message from ${message.name} for TTS processing: "${message.mes}"`);
-    ttsJobQueue.push(message);
+    splitMessageAndAddToTtsJobQueue(message);
 }
 
 async function onMessageDeleted() {

From 145136059ea5c293f640cc1c4b2d6cc3017e6283 Mon Sep 17 00:00:00 2001
From: Small Eggs <144642298+small-eggs@users.noreply.github.com>
Date: Mon, 27 Jan 2025 17:43:24 -0800
Subject: [PATCH 03/11] Fix tts.skip_tags's regex to match newlines

The extension_settings.tts.skip_tags setting is meant to skip sending
tags and their content to the TTS API provider. The original regular
expression matched content inside tags with ".*?". Unfortunately,
Javascript's engine does *not* match newlines on the "." without the /s
flag.

The /s flag was added in ES2018. To be more compatible, the regex
has been changed to "[\s\S]+?". This gives similar performance (instead
of using capture groups) and matches all content within a tag, as the
original regex intended.
---
 public/scripts/extensions/tts/index.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/public/scripts/extensions/tts/index.js b/public/scripts/extensions/tts/index.js
index 4b8978422..279737f7a 100644
--- a/public/scripts/extensions/tts/index.js
+++ b/public/scripts/extensions/tts/index.js
@@ -466,7 +466,7 @@ async function processTtsQueue() {
     }
 
     if (extension_settings.tts.skip_tags) {
-        text = text.replace(/<.*?>.*?<\/.*?>/g, '').trim();
+        text = text.replace(/<.*?>[\s\S]*?<\/.*?>/g, '').trim();
     }
 
     if (!extension_settings.tts.pass_asterisks) {

From 63e7acb87bfdd1b10de1a2e669d371ae2ecd90f0 Mon Sep 17 00:00:00 2001
From: Dzmitry Kazlouski <d.kazlouski@pxlnd.com>
Date: Tue, 28 Jan 2025 05:50:25 +0300
Subject: [PATCH 04/11] Make this feature togglable in extensions > "Narrate by
 paragraphs (when not streaming)"

---
 public/scripts/extensions/tts/index.js      | 27 +++++++++++++++++----
 public/scripts/extensions/tts/settings.html |  4 +++
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/public/scripts/extensions/tts/index.js b/public/scripts/extensions/tts/index.js
index 636103f23..1d23807cb 100644
--- a/public/scripts/extensions/tts/index.js
+++ b/public/scripts/extensions/tts/index.js
@@ -120,7 +120,7 @@ async function onNarrateOneMessage() {
     }
 
     resetTtsPlayback();
-    splitMessageAndAddToTtsJobQueue(message);
+    processAndQueueTtsMessage(message);
     moduleWorker();
 }
 
@@ -147,7 +147,7 @@ async function onNarrateText(args, text) {
     }
 
     resetTtsPlayback();
-    splitMessageAndAddToTtsJobQueue({ mes: text, name: name });
+    processAndQueueTtsMessage({ mes: text, name: name });
     await moduleWorker();
 
     // Return back to the chat voices
@@ -227,7 +227,12 @@ function isTtsProcessing() {
  * @param {string} message.name - The name associated with the message.
  * @returns {void}
  */
-function splitMessageAndAddToTtsJobQueue(message) {
+function processAndQueueTtsMessage(message) {
+    if (!extension_settings.tts.narrate_by_paragraphs) {
+        ttsJobQueue.push(message);
+        return;
+    }
+
     const lines = message.mes.split("\n");
 
     for (let i = 0; i < lines.length; i++) {
@@ -375,7 +380,7 @@ function onAudioControlClicked() {
         talkingAnimation(false);
     } else {
         // Default play behavior if not processing or playing is to play the last message.
-        splitMessageAndAddToTtsJobQueue(context.chat[context.chat.length - 1]);
+        processAndQueueTtsMessage(context.chat[context.chat.length - 1]);
     }
     updateUiAudioPlayState();
 }
@@ -594,6 +599,7 @@ function loadSettings() {
     $('#tts_narrate_quoted').prop('checked', extension_settings.tts.narrate_quoted_only);
     $('#tts_auto_generation').prop('checked', extension_settings.tts.auto_generation);
     $('#tts_periodic_auto_generation').prop('checked', extension_settings.tts.periodic_auto_generation);
+    $('#tts_narrate_by_paragraphs').prop('checked', extension_settings.tts.narrate_by_paragraphs);
     $('#tts_narrate_translated_only').prop('checked', extension_settings.tts.narrate_translated_only);
     $('#tts_narrate_user').prop('checked', extension_settings.tts.narrate_user);
     $('#tts_pass_asterisks').prop('checked', extension_settings.tts.pass_asterisks);
@@ -663,6 +669,11 @@ function onPeriodicAutoGenerationClick() {
     saveSettingsDebounced();
 }
 
+function onNarrateByParagraphsClick() {
+    extension_settings.tts.narrate_by_paragraphs = !!$('#tts_narrate_by_paragraphs').prop('checked');
+    saveSettingsDebounced();
+}
+
 
 function onNarrateDialoguesClick() {
     extension_settings.tts.narrate_dialogues_only = !!$('#tts_narrate_dialogues').prop('checked');
@@ -841,7 +852,12 @@ async function onMessageEvent(messageId, lastCharIndex) {
     lastChatId = context.chatId;
 
     console.debug(`Adding message from ${message.name} for TTS processing: "${message.mes}"`);
-    splitMessageAndAddToTtsJobQueue(message);
+
+    if (extension_settings.tts.periodic_auto_generation) {
+        ttsJobQueue.push(message);
+    } else {
+        processAndQueueTtsMessage(message);
+    }
 }
 
 async function onMessageDeleted() {
@@ -1181,6 +1197,7 @@ jQuery(async function () {
         $('#tts_pass_asterisks').on('click', onPassAsterisksClick);
         $('#tts_auto_generation').on('click', onAutoGenerationClick);
         $('#tts_periodic_auto_generation').on('click', onPeriodicAutoGenerationClick);
+        $('#tts_narrate_by_paragraphs').on('click', onNarrateByParagraphsClick);
         $('#tts_narrate_user').on('click', onNarrateUserClick);
 
         $('#playback_rate').on('input', function () {
diff --git a/public/scripts/extensions/tts/settings.html b/public/scripts/extensions/tts/settings.html
index dc005a406..5fb5b6895 100644
--- a/public/scripts/extensions/tts/settings.html
+++ b/public/scripts/extensions/tts/settings.html
@@ -30,6 +30,10 @@
                     <input type="checkbox" id="tts_periodic_auto_generation">
                     <small data-i18n="Narrate by paragraphs (when streaming)">Narrate by paragraphs (when streaming)</small>
                 </label>
+                <label class="checkbox_label" for="tts_narrate_by_paragraphs">
+                    <input type="checkbox" id="tts_narrate_by_paragraphs">
+                    <small data-i18n="Narrate by paragraphs (when not streaming)">Narrate by paragraphs (when not streaming)</small>
+                </label>
                 <label class="checkbox_label" for="tts_narrate_quoted">
                     <input type="checkbox" id="tts_narrate_quoted">
                     <small data-i18n="Only narrate quotes">Only narrate "quotes"</small>

From 0c9b301a57362df7c824cebf99cb3053fd40db85 Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Tue, 28 Jan 2025 15:39:09 +0000
Subject: [PATCH 05/11] Prevent ephemeral message extra changes vanish upon
 swiping

---
 public/script.js                 | 19 +++++++++++++++++++
 public/scripts/slash-commands.js |  4 ++++
 2 files changed, 23 insertions(+)

diff --git a/public/script.js b/public/script.js
index 006f946d7..48bf112a6 100644
--- a/public/script.js
+++ b/public/script.js
@@ -6074,6 +6074,19 @@ export async function saveReply(type, getMessage, fromStreaming, title, swipes,
     return { type, getMessage };
 }
 
+export function syncCurrentSwipeInfoExtras() {
+    if (!chat.length) {
+        return;
+    }
+    const currentMessage = chat[chat.length - 1];
+    if (currentMessage && Array.isArray(currentMessage.swipe_info) && typeof currentMessage.swipe_id === 'number') {
+        const swipeInfo = currentMessage.swipe_info[currentMessage.swipe_id];
+        if (swipeInfo && typeof swipeInfo === 'object') {
+            swipeInfo.extra = structuredClone(currentMessage.extra);
+        }
+    }
+}
+
 function saveImageToMessage(img, mes) {
     if (mes && img.image) {
         if (!mes.extra || typeof mes.extra !== 'object') {
@@ -8501,6 +8514,9 @@ function swipe_left() {      // when we swipe left..but no generation.
         streamingProcessor.onStopStreaming();
     }
 
+    // Make sure ad-hoc changes to extras are saved before swiping away
+    syncCurrentSwipeInfoExtras();
+
     const swipe_duration = 120;
     const swipe_range = '700px';
     chat[chat.length - 1]['swipe_id']--;
@@ -8636,6 +8652,9 @@ const swipe_right = () => {
         return unblockGeneration();
     }
 
+    // Make sure ad-hoc changes to extras are saved before swiping away
+    syncCurrentSwipeInfoExtras();
+
     const swipe_duration = 200;
     const swipe_range = 700;
     //console.log(swipe_range);
diff --git a/public/scripts/slash-commands.js b/public/scripts/slash-commands.js
index 39b3db71e..531a8f51f 100644
--- a/public/scripts/slash-commands.js
+++ b/public/scripts/slash-commands.js
@@ -42,6 +42,7 @@ import {
     showMoreMessages,
     stopGeneration,
     substituteParams,
+    syncCurrentSwipeInfoExtras,
     system_avatar,
     system_message_types,
     this_chid,
@@ -2814,8 +2815,11 @@ async function addSwipeCallback(args, value) {
     const newSwipeId = lastMessage.swipes.length - 1;
 
     if (isTrueBoolean(args.switch)) {
+        // Make sure ad-hoc changes to extras are saved before swiping away
+        syncCurrentSwipeInfoExtras();
         lastMessage.swipe_id = newSwipeId;
         lastMessage.mes = lastMessage.swipes[newSwipeId];
+        lastMessage.extra = structuredClone(lastMessage.swipe_info?.[newSwipeId]?.extra ?? lastMessage.extra ?? {});
     }
 
     await saveChatConditional();

From 35e8561bff72690bb52b78daabed68f8798b0d70 Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Tue, 28 Jan 2025 21:03:44 +0200
Subject: [PATCH 06/11] /reasoning-set: fix at argument

---
 public/scripts/reasoning.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/public/scripts/reasoning.js b/public/scripts/reasoning.js
index c9b0efc3b..19dc024a6 100644
--- a/public/scripts/reasoning.js
+++ b/public/scripts/reasoning.js
@@ -146,7 +146,7 @@ function registerReasoningSlashCommands() {
             }),
         ],
         callback: async (args, value) => {
-            const messageId = !isNaN(Number(args[0])) ? Number(args[0]) : chat.length - 1;
+            const messageId = !isNaN(Number(args.at)) ? Number(args.at) : chat.length - 1;
             const message = chat[messageId];
             if (!message?.extra) {
                 return '';

From bab8a09a80d34b41f7da32f9c5e29ef01607e5e1 Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Tue, 28 Jan 2025 23:00:28 +0200
Subject: [PATCH 07/11] /stop-strings: update help

---
 public/scripts/power-user.js | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/public/scripts/power-user.js b/public/scripts/power-user.js
index 2c1d5cd4c..30378faee 100644
--- a/public/scripts/power-user.js
+++ b/public/scripts/power-user.js
@@ -4075,7 +4075,18 @@ $(document).ready(() => {
     SlashCommandParser.addCommandObject(SlashCommand.fromProps({
         name: 'stop-strings',
         aliases: ['stopping-strings'],
-        helpString: 'Sets a list of custom stopping strings. Gets the list if no value is provided.',
+        helpString: `
+            <div>
+                Sets a list of custom stopping strings. Gets the list if no value is provided.
+            </div>
+            <div>
+                <strong>Examples:</strong>
+            </div>
+            <ul>
+                <li>Value must be a JSON-serialized array: <pre><code class="language-stscript">/stop-strings ["goodbye", "farewell"]</code></pre></li>
+                <li>Pipe characters must be escaped with a backslash: <pre><code class="language-stscript">/stop-strings ["left\\|right"]</code></pre></li>
+            </ul>
+        `,
         returns: ARGUMENT_TYPE.LIST,
         unnamedArgumentList: [
             SlashCommandArgument.fromProps({

From 0c9676e7fce30549b73214247147ec464566aa6f Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Tue, 28 Jan 2025 23:01:58 +0200
Subject: [PATCH 08/11] /stop-strings: add aliases

---
 public/scripts/power-user.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/public/scripts/power-user.js b/public/scripts/power-user.js
index 30378faee..637fdbffb 100644
--- a/public/scripts/power-user.js
+++ b/public/scripts/power-user.js
@@ -4074,7 +4074,7 @@ $(document).ready(() => {
     }));
     SlashCommandParser.addCommandObject(SlashCommand.fromProps({
         name: 'stop-strings',
-        aliases: ['stopping-strings'],
+        aliases: ['stopping-strings', 'custom-stopping-strings', 'custom-stop-strings'],
         helpString: `
             <div>
                 Sets a list of custom stopping strings. Gets the list if no value is provided.

From 2aa1dd41f503d3aee190b7b98637d019843dea38 Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Tue, 28 Jan 2025 23:07:59 +0200
Subject: [PATCH 09/11] eslint

---
 public/scripts/extensions/tts/index.js | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/public/scripts/extensions/tts/index.js b/public/scripts/extensions/tts/index.js
index 1d23807cb..f6ffac2b7 100644
--- a/public/scripts/extensions/tts/index.js
+++ b/public/scripts/extensions/tts/index.js
@@ -233,7 +233,7 @@ function processAndQueueTtsMessage(message) {
         return;
     }
 
-    const lines = message.mes.split("\n");
+    const lines = message.mes.split('\n');
 
     for (let i = 0; i < lines.length; i++) {
         const line = lines[i];
@@ -245,7 +245,7 @@ function processAndQueueTtsMessage(message) {
         ttsJobQueue.push(
             Object.assign({}, message, {
                 mes: line,
-            })
+            }),
         );
     }
 }

From 4f456b2b80b9dc5ddf5c9c9408229137f7d5b562 Mon Sep 17 00:00:00 2001
From: Cohee <18619528+Cohee1207@users.noreply.github.com>
Date: Tue, 28 Jan 2025 23:14:26 +0200
Subject: [PATCH 10/11] TTS: Call module worker when audio stops playing #3371

---
 public/scripts/extensions/tts/index.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/public/scripts/extensions/tts/index.js b/public/scripts/extensions/tts/index.js
index 5bb2a85a1..a01dc5479 100644
--- a/public/scripts/extensions/tts/index.js
+++ b/public/scripts/extensions/tts/index.js
@@ -30,6 +30,7 @@ import { GoogleTranslateTtsProvider } from './google-translate.js';
 export { talkingAnimation };
 
 const UPDATE_INTERVAL = 1000;
+const wrapper = new ModuleWorkerWrapper(moduleWorker);
 
 let voiceMapEntries = [];
 let voiceMap = {}; // {charName:voiceid, charName2:voiceid2}
@@ -406,6 +407,7 @@ function completeCurrentAudioJob() {
     currentAudioJob = null;
     talkingAnimation(false); //stop lip animation
     // updateUiPlayState();
+    wrapper.update();
 }
 
 /**
@@ -1219,7 +1221,6 @@ jQuery(async function () {
     loadSettings(); // Depends on Extension Controls and loadTtsProvider
     loadTtsProvider(extension_settings.tts.currentProvider); // No dependencies
     addAudioControl(); // Depends on Extension Controls
-    const wrapper = new ModuleWorkerWrapper(moduleWorker);
     setInterval(wrapper.update.bind(wrapper), UPDATE_INTERVAL); // Init depends on all the things
     eventSource.on(event_types.MESSAGE_SWIPED, resetTtsPlayback);
     eventSource.on(event_types.CHAT_CHANGED, onChatChanged);

From d5f6ecf3c342415a9eda70c72ea364d4246a06df Mon Sep 17 00:00:00 2001
From: Finadil <PatrickEHerbst@gmail.com>
Date: Tue, 28 Jan 2025 18:03:01 -0500
Subject: [PATCH 11/11] Fix /note-role argument name
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

I am full of shame. 🫢
---
 public/scripts/authors-note.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/public/scripts/authors-note.js b/public/scripts/authors-note.js
index 2bf0b254d..326de966a 100644
--- a/public/scripts/authors-note.js
+++ b/public/scripts/authors-note.js
@@ -566,7 +566,7 @@ export function initAuthorsNote() {
         namedArgumentList: [],
         unnamedArgumentList: [
             new SlashCommandArgument(
-                'position', [ARGUMENT_TYPE.STRING], false, false, null, ['system', 'user', 'assistant'],
+                'role', [ARGUMENT_TYPE.STRING], false, false, null, ['system', 'user', 'assistant'],
             ),
         ],
         helpString: `