sillytavern 1.10.3 → 1.10.4

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,90 @@
+name: Bug Report 🐛
+description: Report something that's not working the way it's (probably) intended to. PAY ATTENTION, Support requests for external programs (reverse proxies, 3rd party servers, other peoples' forks) will be refused!"
+title: '[BUG] <title>'
+labels: ['bug']
+body:
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: Where are you running SillyTavern?
+      options:
+        - Self-Hosted (Bare Metal)      
+        - Self-Hosted (Docker)
+        - Android (Termux)
+        - Cloud Service (Static)
+        - Other (Specify below)
+    validations:
+      required: true
+
+  - type: input
+    id: system
+    attributes:
+      label: System
+      description: >-
+        For deployment issues, specify your [distro or OS](https://whatsmyos.com/) and/ or Docker version.
+        For client-side issues, include your [browser version](https://www.whatsmybrowser.org/)
+      placeholder: e.g. Firefox 101, Manjaro Linux 21.3.0, Docker 20.10.16
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of SillyTavern are you running?
+      placeholder: (check User Settings to see the version)
+    validations:
+      required: true
+
+  - type: textarea
+    id: desktop
+    attributes:
+      label: Desktop Information
+      description: Please provide details about your desktop environment.
+      placeholder: |
+        - Node.js version (if applicable): [run `node --version` in cmd]
+        - Generation API [e.g. KoboldAI, OpenAI]
+        - Branch [staging, release]
+        - Model [e.g. Pygmalion 6b, LLaMa 13b]
+    validations:
+      required: false
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Describe the problem
+      description: Please describe exactly what is not working, include the steps to reproduce, actual result and expected result
+      placeholder: When doing ABC then DEF, I expect to see XYZ, but I actually see ZYX
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional info
+      description: Logs? Screenshots? Yes, please.
+      placeholder: If the issue happens during build-time, include terminal logs. For run-time errors, include browser logs which you can view in the Dev Tools (F12), under the Console tab. Take care to blank out any personal info.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: idiot-check
+    attributes:
+      label: Please tick the boxes
+      description: Before submitting, please ensure that
+      options:
+        - label: You have explained the issue clearly, and included all relevant info
+          required: true
+        - label: You've checked that this [issue hasn't already been raised](https://github.com/SillyTavern/SillyTavern/issues?q=is%3Aissue)
+          required: true
+        - label: You've checked the [docs](https://docs.sillytavern.app/) ![important](https://img.shields.io/badge/Important!-F6094E)
+          required: true
+
+  - type: markdown
+    attributes:
+      value: |-
+        ## Thanks 🙏
+        Thank you for raising this ticket - in doing so you are helping to make SillyTavern better for everyone.
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,91 @@
+name: Feature Request ✨
+description: Suggest an idea for future development of this project
+title: '[FEATURE_REQUEST] <title>'
+labels: ['enhancement']
+
+body:
+
+  # Field 1 - Did the user searched for similar requests
+  - type: dropdown
+    id: similarRequest
+    attributes:
+      label: Have you searched for similar [requests](https://github.com/SillyTavern/SillyTavern/issues?q=)?
+      description:
+      options:
+        - 'No'
+        - 'Yes'
+    validations:
+      required: false
+
+  # Field 2 - Is it bug-related
+  - type: textarea
+    id: issue
+    attributes:
+      label: Is your feature request related to a problem? If so, please describe.
+      description:
+      placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: false
+
+  # Field 3 - Describe feature
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      placeholder: An outline of how you would like this to be implemented, include as much details as possible 
+    validations:
+      required: true
+
+  # Field 4 - Describe alternatives
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      placeholder: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  # Field 5 - Additional context
+  - type: textarea
+    id: addcontext
+    attributes:
+      label: Additional context
+      placeholder: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
+
+  # Field 6 - Priority
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      description: How urgent is the development of this feature
+      options:
+        - Low (Nice-to-have)
+        - Medium (Would be very useful)
+        - High (The app does not function without it)
+    validations:
+      required: true
+
+  # Field 7 - Can the user implement
+  - type: dropdown
+    id: canImplement
+    attributes:
+      label: Is this something you would be keen to implement?
+      description: Are you raising this ticket in order to get an issue number for your PR?
+      options:
+        - 'No'
+        - 'Maybe'
+        - 'Yes!'
+    validations:
+      required: false
+
+  # Final text
+  - type: markdown
+    attributes:
+      value: |-
+        ## Thanks 🙏
+        Thank you for your feature suggestion.
+        Please note that there is no guarantee that your idea will be implemented.
+    validations:
+      required: false

package/.github/readme.md

@@ -292,6 +292,7 @@ GNU Affero General Public License for more details.**
 * RossAscends' additions: AGPL v3
 * Portions of CncAnon's TavernAITurbo mod: Unknown license
 * kingbri's various commits and suggestions (<https://github.com/bdashore3>)
+* city_unit's extensions and various QoL features (<https://github.com/city-unit>)
 * StefanDanielSchwarz's various commits and bug reports (<https://github.com/StefanDanielSchwarz>)
 * Waifu mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>)
 * Thanks Pygmalion University for being awesome testers and suggesting cool features!

package/.github/workflows/docker-publish.yml

@@ -0,0 +1,45 @@
+# This workflow will publish a docker image for every full release to the GitHub package repository
+
+name: Create Docker Image on Release
+
+on:
+  release:
+    # Only runs on full releases not pre releases
+    types: [released]
+
+env:
+  # This should allow creation of docker images even in forked repositories
+  # Image name may not contain uppercase characters, so we can not use the repository name
+  # Creates a string like: ghcr.io/SillyTavern/sillytavern
+  image_name: ghcr.io/${{ github.repository_owner }}/sillytavern
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      # Build docker image using dockerfile and tag it with branch name
+      # Assumes branch name is the version number
+      - name: Build the Docker image
+        run: |
+          docker build . --file Dockerfile --tag $image_name:${{ github.ref_name }}
+
+      # Login into package repository as the person who created the release
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Assumes release is the latest and marks image as such
+      - name: Docker Tag and Push
+        run: |
+          docker tag $image_name:${{ github.ref_name }} $image_name:latest
+          docker push $image_name:${{ github.ref_name }}
+          docker push $image_name:latest

package/Dockerfile

@@ -13,7 +13,7 @@ ENTRYPOINT [ "tini", "--" ]
 WORKDIR ${APP_HOME}
 
 # Install app dependencies
-COPY package*.json ./
+COPY package*.json post-install.js ./
 RUN \
   echo "*** Install npm packages ***" && \
   npm install && npm cache clean --force

package/colab/GPU.ipynb

@@ -73,6 +73,7 @@
         "#@markdown Enables ChromaDB for Infinity Context plugin\n",
         "\n",
         "import subprocess\n",
+        "import secrets\n",
         "\n",
         "# ---\n",
         "# SillyTavern extras\n",
@@ -116,6 +117,7 @@
         "!npm install -g localtunnel\n",
         "!pip install -r requirements-complete.txt\n",
         "!pip install tensorflow==2.12\n",
+        "!pip install colorama\n",
         "!pip install Flask-Cors\n",
         "!pip install Flask-Compress\n",
         "!pip install transformers\n",
@@ -130,6 +132,13 @@
         "!wget https://github.com/cloudflare/cloudflared/releases/download/2023.5.0/cloudflared-linux-amd64 -O /tmp/cloudflared-linux-amd64\n",
         "!chmod +x /tmp/cloudflared-linux-amd64\n",
         "\n",
+        "# Generate a random API key\n",
+        "api_key = secrets.token_hex(5)\n",
+        "\n",
+        "# Write the API key to api_key.txt\n",
+        "with open('./api_key.txt', 'w') as f:\n",
+        "    f.write(api_key)\n",
+        "print(f\"API Key generated: {api_key}\")\n",
         "\n",
         "cmd = f\"python server.py {' '.join(params)}\"\n",
         "print(cmd)\n",

package/config.conf

@@ -0,0 +1,52 @@
+const port = 8000;
+const whitelist = ['127.0.0.1']; //Example for add several IP in whitelist: ['127.0.0.1', '192.168.0.10']
+const whitelistMode = true; //Disabling enabling the ip whitelist mode. true/false
+const basicAuthMode = false; //Toggle basic authentication for endpoints.
+const basicAuthUser = {username: "user", password: "password"}; //Login credentials when basicAuthMode is true.
+const disableThumbnails = false; //Disables the generation of thumbnails, opting to use the raw images instead
+const autorun = true; //Autorun in the browser. true/false
+const enableExtensions = true; //Enables support for TavernAI-extras project
+const listen = true; // If true, Can be access from other device or PC. otherwise can be access only from hosting machine.
+const allowKeysExposure = false; // If true, private API keys could be fetched to the frontend.
+const skipContentCheck = false; // If true, no new default content will be delivered to you.
+const thumbnailsQuality = 95; // Quality of thumbnails. 0-100
+
+// If true, Allows insecure settings for listen, whitelist, and authentication.
+// Change this setting only on "trusted networks". Do not change this value unless you are aware of the issues that can arise from changing this setting and configuring a insecure setting.
+const securityOverride = false;
+
+// Additional settings for extra modules / extensions
+const extras = {
+    // Disables auto-download of models from the HuggingFace Hub.
+    // You will need to manually download the models and put them into the /cache folder.
+    disableAutoDownload: false,
+    // Text classification model for sentiment analysis. HuggingFace ID of a model in ONNX format.
+    classificationModel: 'Cohee/distilbert-base-uncased-go-emotions-onnx',
+    // Image captioning model. HuggingFace ID of a model in ONNX format.
+    captioningModel: 'Xenova/vit-gpt2-image-captioning',
+    // Feature extraction model. HuggingFace ID of a model in ONNX format.
+    embeddingModel: 'Xenova/all-mpnet-base-v2',
+};
+
+// Request overrides for additional headers
+// Format is an array of objects:
+// { hosts: [ "<url>" ], headers: { <header>: "<value>" } }
+const requestOverrides = [];
+
+module.exports = {
+    port,
+    whitelist,
+    whitelistMode,
+    basicAuthMode,
+    basicAuthUser,
+    autorun,
+    enableExtensions,
+    listen,
+    disableThumbnails,
+    allowKeysExposure,
+    securityOverride,
+    skipContentCheck,
+    requestOverrides,
+    thumbnailsQuality,
+    extras,
+};

package/default/config.conf

@@ -9,13 +9,28 @@ const enableExtensions = true; //Enables support for TavernAI-extras project
 const listen = true; // If true, Can be access from other device or PC. otherwise can be access only from hosting machine.
 const allowKeysExposure = false; // If true, private API keys could be fetched to the frontend.
 const skipContentCheck = false; // If true, no new default content will be delivered to you.
-
+const thumbnailsQuality = 95; // Quality of thumbnails. 0-100
 
 // If true, Allows insecure settings for listen, whitelist, and authentication.
 // Change this setting only on "trusted networks". Do not change this value unless you are aware of the issues that can arise from changing this setting and configuring a insecure setting.
 const securityOverride = false;
 
+// Additional settings for extra modules / extensions
+const extras = {
+    // Disables auto-download of models from the HuggingFace Hub.
+    // You will need to manually download the models and put them into the /cache folder.
+    disableAutoDownload: false,
+    // Text classification model for sentiment analysis. HuggingFace ID of a model in ONNX format.
+    classificationModel: 'Cohee/distilbert-base-uncased-go-emotions-onnx',
+    // Image captioning model. HuggingFace ID of a model in ONNX format.
+    captioningModel: 'Xenova/vit-gpt2-image-captioning',
+    // Feature extraction model. HuggingFace ID of a model in ONNX format.
+    embeddingModel: 'Xenova/all-mpnet-base-v2',
+};
+
 // Request overrides for additional headers
+// Format is an array of objects:
+// { hosts: [ "<url>" ], headers: { <header>: "<value>" } }
 const requestOverrides = [];
 
 module.exports = {
@@ -32,4 +47,6 @@ module.exports = {
     securityOverride,
     skipContentCheck,
     requestOverrides,
+    thumbnailsQuality,
+    extras,
 };

package/default/settings.json

@@ -75,9 +75,6 @@
         "always_force_name2": true,
         "user_prompt_bias": "",
         "show_user_prompt_bias": true,
-        "multigen": false,
-        "multigen_first_chunk": 50,
-        "multigen_next_chunks": 30,
         "markdown_escape_strings": "",
         "fast_ui_mode": false,
         "avatar_style": 0,
@@ -167,7 +164,6 @@
         "custom_stopping_strings_macro": true,
         "fuzzy_search": true,
         "encode_tags": false,
-        "lazy_load": 100,
         "ui_mode": 1
     },
     "extension_settings": {

package/docker/docker-compose.yml

@@ -9,4 +9,5 @@ services:
       - "8000:8000"
     volumes:
       - "./config:/home/node/app/config"
+      - "./user:/home/node/app/public/user"
     restart: unless-stopped

package/package.json

@@ -14,8 +14,7 @@
         "gpt3-tokenizer": "^1.1.5",
         "ip-matching": "^2.1.2",
         "ipaddr.js": "^2.0.1",
-        "jimp": "^0.22.7",
-        "jquery": "^3.6.4",
+        "jimp": "^0.22.10",
         "json5": "^2.2.3",
         "lodash": "^4.17.21",
         "mime-types": "^2.1.35",
@@ -27,8 +26,9 @@
         "png-chunks-extract": "^1.0.0",
         "response-time": "^2.3.2",
         "sanitize-filename": "^1.6.3",
+        "sillytavern-transformers": "^2.7.3",
         "simple-git": "^3.19.1",
-        "uniqolor": "^1.1.0",
+        "vectra": "^0.2.2",
         "write-file-atomic": "^5.0.1",
         "ws": "^8.13.0",
         "yargs": "^17.7.1",
@@ -46,11 +46,12 @@
         "type": "git",
         "url": "https://github.com/SillyTavern/SillyTavern.git"
     },
-    "version": "1.10.3",
+    "version": "1.10.4",
     "scripts": {
         "start": "node server.js",
         "start-multi": "node server.js --disableCsrf",
-        "pkg": "pkg --compress Gzip --no-bytecode --public ."
+        "pkg": "pkg --compress Gzip --no-bytecode --public .",
+        "postinstall": "node post-install.js"
     },
     "bin": {
         "sillytavern": "./server.js"
@@ -75,6 +76,7 @@
         ]
     },
     "devDependencies": {
+        "jquery": "^3.6.4",
         "pkg": "^5.8.1",
         "pkg-fetch": "^3.5.2"
     }

package/post-install.js

@@ -0,0 +1,81 @@
+/**
+ * Scripts to be done before starting the server for the first time.
+ */
+const fs = require('fs');
+const path = require('path');
+const crypto = require('crypto');
+
+/**
+ * Creates the default config files if they don't exist yet.
+ */
+function createDefaultFiles() {
+    const files = {
+        settings: './public/settings.json',
+        bg_load: './public/css/bg_load.css',
+        config: './config.conf',
+    };
+
+    for (const file of Object.values(files)) {
+        try {
+            if (!fs.existsSync(file)) {
+                const defaultFilePath = path.join('./default', path.parse(file).base);
+                fs.copyFileSync(defaultFilePath, file);
+                console.log(`Created default file: ${file}`);
+            }
+        } catch (error) {
+            console.error(`FATAL: Could not write default file: ${file}`, error);
+        }
+    }
+}
+
+/**
+ * Returns the MD5 hash of the given data.
+ * @param {Buffer} data Input data
+ * @returns {string} MD5 hash of the input data
+ */
+function getMd5Hash(data) {
+    return crypto
+        .createHash('md5')
+        .update(data)
+        .digest('hex');
+}
+
+/**
+ * Copies the WASM binaries from the sillytavern-transformers package to the dist folder.
+ */
+function copyWasmFiles() {
+    if (!fs.existsSync('./dist')) {
+        fs.mkdirSync('./dist');
+    }
+
+    const listDir = fs.readdirSync('./node_modules/sillytavern-transformers/dist');
+
+    for (const file of listDir) {
+        if (file.endsWith('.wasm')) {
+            const sourcePath = `./node_modules/sillytavern-transformers/dist/${file}`;
+            const targetPath = `./dist/${file}`;
+
+            // Don't copy if the file already exists and is the same checksum
+            if (fs.existsSync(targetPath)) {
+                const sourceChecksum = getMd5Hash(fs.readFileSync(sourcePath));
+                const targetChecksum = getMd5Hash(fs.readFileSync(targetPath));
+
+                if (sourceChecksum === targetChecksum) {
+                    continue;
+                }
+            }
+
+            fs.copyFileSync(sourcePath, targetPath);
+            console.log(`${file} successfully copied to ./dist/${file}`);
+        }
+    }
+}
+
+try {
+    // 1. Create default config files
+    createDefaultFiles();
+    // 2. Copy transformers WASM binaries from node_modules
+    copyWasmFiles();
+} catch (error) {
+    console.error(error);
+}

package/public/KoboldAI Settings/Miro Bronze.settings

@@ -0,0 +1,25 @@
+{
+    "temp": 1.06,
+    "rep_pen": 1,
+    "rep_pen_range": 0,
+    "top_p": 1,
+    "top_a": 0,
+    "top_k": 0,
+    "typical": 1,
+    "tfs": 1,
+    "rep_pen_slope": 0.9,
+    "single_line": false,
+    "sampler_order": [
+        6,
+        0,
+        1,
+        3,
+        4,
+        2,
+        5
+    ],
+    "mirostat": 2,
+    "mirostat_tau": 9.61,
+    "mirostat_eta": 1,
+    "use_default_badwordsids": true
+}

package/public/KoboldAI Settings/Miro Gold.settings

@@ -0,0 +1,25 @@
+{
+    "temp": 1.17,
+    "rep_pen": 1,
+    "rep_pen_range": 0,
+    "top_p": 1,
+    "top_a": 0,
+    "top_k": 0,
+    "typical": 1,
+    "tfs": 1,
+    "rep_pen_slope": 0.9,
+    "single_line": false,
+    "sampler_order": [
+        6,
+        0,
+        1,
+        3,
+        4,
+        2,
+        5
+    ],
+    "mirostat": 2,
+    "mirostat_tau": 9.91,
+    "mirostat_eta": 1,
+    "use_default_badwordsids": true
+}

package/public/KoboldAI Settings/Miro Silver.settings

@@ -0,0 +1,25 @@
+{
+    "temp": 1.17,
+    "rep_pen": 1,
+    "rep_pen_range": 0,
+    "top_p": 1,
+    "top_a": 0,
+    "top_k": 0,
+    "typical": 1,
+    "tfs": 1,
+    "rep_pen_slope": 0.9,
+    "single_line": false,
+    "sampler_order": [
+        6,
+        0,
+        1,
+        3,
+        4,
+        2,
+        5
+    ],
+    "mirostat": 2,
+    "mirostat_tau": 9.62,
+    "mirostat_eta": 1,
+    "use_default_badwordsids": true
+}

package/public/TextGen Settings/Miro Bronze.settings

@@ -0,0 +1,24 @@
+{
+    "temp": 1.06,
+    "top_p": 1,
+    "top_k": 0,
+    "typical_p": 1,
+    "top_a": 0,
+    "tfs": 1,
+    "epsilon_cutoff": 0,
+    "eta_cutoff": 0,
+    "rep_pen": 1,
+    "rep_pen_range": 0,
+    "no_repeat_ngram_size": 0,
+    "penalty_alpha": 0,
+    "num_beams": 1,
+    "length_penalty": 1,
+    "min_length": 0,
+    "encoder_rep_pen": 1,
+    "do_sample": true,
+    "early_stopping": false,
+    "mirostat_mode": 2,
+    "mirostat_tau": 9.61,
+    "mirostat_eta": 1,
+    "rep_pen_size": 0
+}

package/public/TextGen Settings/Miro Gold.settings

@@ -0,0 +1,24 @@
+{
+    "temp": 1.17,
+    "top_p": 1,
+    "top_k": 0,
+    "typical_p": 1,
+    "top_a": 0,
+    "tfs": 1,
+    "epsilon_cutoff": 0,
+    "eta_cutoff": 0,
+    "rep_pen": 1,
+    "rep_pen_range": 0,
+    "no_repeat_ngram_size": 0,
+    "penalty_alpha": 0,
+    "num_beams": 1,
+    "length_penalty": 1,
+    "min_length": 0,
+    "encoder_rep_pen": 1,
+    "do_sample": true,
+    "early_stopping": false,
+    "mirostat_mode": 2,
+    "mirostat_tau": 9.91,
+    "mirostat_eta": 1,
+    "rep_pen_size": 0
+}

package/public/TextGen Settings/Miro Silver.settings

@@ -0,0 +1,24 @@
+{
+    "temp": 1.17,
+    "top_p": 1,
+    "top_k": 0,
+    "typical_p": 1,
+    "top_a": 0,
+    "tfs": 1,
+    "epsilon_cutoff": 0,
+    "eta_cutoff": 0,
+    "rep_pen": 1,
+    "rep_pen_range": 0,
+    "no_repeat_ngram_size": 0,
+    "penalty_alpha": 0,
+    "num_beams": 1,
+    "length_penalty": 1,
+    "min_length": 0,
+    "encoder_rep_pen": 1,
+    "do_sample": true,
+    "early_stopping": false,
+    "mirostat_mode": 2,
+    "mirostat_tau": 9.62,
+    "mirostat_eta": 1,
+    "rep_pen_size": 0
+}

package/public/context/OldDefault.json

@@ -0,0 +1,6 @@
+{
+    "story_string": "{{#if system}}{{system}}\n{{/if}}{{#if wiBefore}}{{wiBefore}}\n{{/if}}{{#if description}}{{description}}\n{{/if}}{{#if personality}}{{char}}'s personality: {{personality}}\n{{/if}}{{#if scenario}}Circumstances and context of the dialogue: {{scenario}}\n{{/if}}{{#if wiAfter}}{{wiAfter}}\n{{/if}}{{#if persona}}{{persona}}\n{{/if}}",
+    "chat_start": "\nThen the roleplay chat between {{user}} and {{char}} begins.\n",
+    "example_separator": "This is how {{char}} should talk",
+    "name": "OldDefault"
+}