Revamp read me (#2854) * inital commit * Rewrite some readme sections * Fix typo * more edits * Remove remote connections from readme * Vision wording * Fix headers * edit api key viewing instructions * Fix heading nesting * Swap priorities * Swap news sections * Don't deadname horde * merge STL install instructions into a single section * NodeJS is family friendly * Windows users are users too * Numbers are scary * Total Waifu Annihilation * less repetittitiitiveness * attempted ordered list fix * emoji for STL * clarify termux install disclaimer * Remove outdated credits * fix broken note format * Remove news section * Move screenshots * not so braggadiciously * Add contributors workflow * Add contributors workflow * add wolf to support spam recipients list * chore: update contributors [skip ci] * no double or * typo * Add contributors list * Replace with a remote image * Remove contributors workflow * Lean credits list * Fix typos * Remove defaults from CMD args * Contributors => Top Contributors * Replace link to API connections * Less repetition --------- Co-authored-by: RossAscends <124905043+RossAscends@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed| @@ -4,73 +4,78 @@ English | [中文](readme-zh_cn.md) | [日本語](readme-ja_jp.md) | [Русск | ||
| 4 | 4 | |
| 5 | 5 | ![][cover] |
| 6 | 6 | |
| 7 | 7 | Mobile-friendlySillyTavern layout,provides Multi-APIa single unified interface for many LLM APIs (KoboldAI/CPP, Horde, NovelAI, Ooba, Tabby, OpenAI, OpenRouter, Claude, ScaleMistral and more), VNa mobile-likefriendly Waifulayout, Visual Novel Mode, StableAutomatic1111 Diffusion& ComfyUI API image generation integration, TTS, WorldInfo (lorebooks), customizable UI, auto-translate, and more prompt options than you'd ever want or need, +and abilityendless togrowth installpotential via third-party extensions. |
| 8 | 8 | |
| 9 | -Based on a fork of [TavernAI](https://github.com/TavernAI/TavernAI) 1.2.8 | |
| 9 | +We have a [Documentation website](https://docs.sillytavern.app/) to answer most of your questions and help you get started. | |
| 10 | 10 | |
| 11 | 11 | ## ImportantWhat news!is SillyTavern? |
| 12 | 12 | |
| 13 | -1. We have created a [Documentation website](https://docs.sillytavern.app/) to answer most of your questions and help you get started. | |
| 13 | +SillyTavern is a locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. | |
| 14 | 14 | |
| 15 | -2. Missing extensions after the update? Since the 1.10.6 release version, most of the previously built-in extensions have been converted to downloadable add-ons. You can download them via the built-in "Download Extensions and Assets" menu in the extensions panel (stacked blocks icon in the top bar). | |
| 15 | +Beginning in February 2023 as a fork of TavernAI 1.2.8, SillyTavern now has over 100 contributors and 2 years of independent development under its belt, and continues to serve as a leading software for savvy AI hobbyists. | |
| 16 | 16 | |
| 17 | -3. Unsupported platform: android arm LEtime-web. 32-bit Android requires an external dependency that can't be installed with npm. Use the following command to install it: `pkg install esbuild`. Then run the usual installation steps. | |
| 17 | +## Our Vision | |
| 18 | 18 | |
| 19 | -### Brought to you by Cohee, RossAscends, and the SillyTavern community | |
| 19 | +1. We aim to empower users with as much utility and control over their LLM prompts as possible. The steep learning curve is part of the fun! | |
| 20 | +2. We do not provide any online or hosted services, nor programmatically track any user data. | |
| 21 | +3. SillyTavern is a passion project brought to you by a dedicated community of LLM enthusiasts, and will always be free and open sourced. | |
| 20 | 22 | |
| 21 | -### What is SillyTavern or TavernAI? | |
| 23 | +## Branches | |
| 22 | - | |
| 23 | -SillyTavern is a user interface you can install on your computer (and Android phones) that allows you to interact with text generation AIs and chat/roleplay with characters you or the community create. | |
| 24 | - | |
| 25 | -SillyTavern is a fork of TavernAI 1.2.8 which is under more active development and has added many major features. At this point, they can be thought of as completely independent programs. | |
| 26 | - | |
| 27 | -## Screenshots | |
| 28 | - | |
| 29 | -<img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/e902c7a2-45a6-4415-97aa-c59c597669c1"> | |
| 30 | -<img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/f8a79c47-4fe9-4564-9e4a-bf247ed1c961"> | |
| 31 | - | |
| 32 | -### Branches | |
| 33 | 24 | |
| 34 | 25 | SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users. |
| 35 | 26 | |
| 36 | 27 | * `release` -🌟 **Recommended for most users.** This is the most stable and recommended branch, updated only when major releases are pushed. It's suitable for the majority of users. Typically updated once a month. |
| 37 | 28 | * `staging` - ⚠️ **Not recommended for casual use.** This branch has the latest features, but be cautious as it may break at any time. Only for power users and enthusiasts. Updates several times daily. |
| 38 | 29 | |
| 39 | 30 | If you're not familiar with using the git CLI or don't understand what a branch is, don't worry! The release branch is always the preferable option for you. |
| 40 | 31 | |
| 41 | 32 | ### What do I need other than SillyTavern? |
| 42 | 33 | |
| 43 | 34 | On its ownSince SillyTavern is useless, as it's just aonly useran interface. You, haveyou towill haveneed access to an AI systemLLM backend thatto provide inference. You can actuse asAI theHorde roleplayfor characterinstant out-of-the-box chatting. ThereAside arefrom variousthat, supportedwe backends:support OpenAPImany APIother (GPT),local KoboldAIand (eithercloud-based runningLLM locallybackends: orOpenAI-compatible onAPI, GoogleKoboldAI, Colab)Tabby, and many more. You can read more about thisour supported APIs in [the FAQ](https://docs.sillytavern.app/usage/faqapi-connections/). |
| 44 | 35 | |
| 45 | 36 | ### Do I need a powerful PC to run SillyTavern? |
| 46 | 37 | |
| 47 | -Since SillyTavern is only a user interface, it has tiny hardware requirements, it will run on anything. It's the AI system backend that needs to be powerful. | |
| 38 | +The hardware requirements are minimal: it will run on anything that can run NodeJS 18 or higher. If you intend to do LLM inference on your local machine, we recommend a 3000-series NVIDIA graphics card with at least 6GB of VRAM. Check your backend's documentation for more details. | |
| 39 | + | |
| 40 | +### Suggested Backends (not affiliated) | |
| 41 | + | |
| 42 | +* [AI Horde](https://aihorde.net/) - use models hosted by volunteers. Requires no further setup | |
| 43 | +* [KoboldCpp](https://github.com/LostRuins/koboldcpp) - a community's favorite for running GGUF models locally | |
| 44 | +* [tabbyAPI](https://github.com/theroyallab/tabbyAPI) - a popular, lightweight, locally-hosted exl2 inference API | |
| 45 | +* [OpenRouter](https://openrouter.ai) - a single API for many cloud providers (OpenAI, Claude, Meta Llama, etc.) as well as popular community models. | |
| 48 | 46 | |
| 49 | 47 | ## Questions or suggestions? |
| 50 | 48 | |
| 51 | 49 | ### We now have a community Discord server |
| 52 | 50 | |
| 53 | 51 | | [![][discord-shield-badge]][discord-link] | [Join our Discord community!](https://discord.gg/sillytavern) Get support, share favorite characters and prompts. | |
| 54 | 52 | | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- | |
| 55 | 53 | |
| 56 | 54 | Or get in touch with the developers directly: |
| 57 | 55 | |
| 58 | 56 | * Discord: cohee or, rossascends, wolfsblvt |
| 59 | 57 | * Reddit: [/u/RossAscends](https://www.reddit.com/user/RossAscends/) or, [/u/sillylossy](https://www.reddit.com/user/sillylossy/), [u/Wolfsblvt](https://www.reddit.com/user/Wolfsblvt/) |
| 60 | 58 | * [Post a GitHub issue](https://github.com/SillyTavern/SillyTavern/issues) |
| 61 | 59 | |
| 62 | -## This version includes | |
| 60 | +### I like your project! How do I contribute? | |
| 61 | + | |
| 62 | +1. Send pull requests. Learn how to contribute: [CONTRIBUTING.md](../CONTRIBUTING.md) | |
| 63 | +2. Send feature suggestions and issue reports using the provided templates. | |
| 64 | +3. Read this entire readme file and check the documentation website first, to avoid sending duplicate issues. | |
| 65 | + | |
| 66 | +## Screenshots | |
| 67 | + | |
| 68 | +<img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/e902c7a2-45a6-4415-97aa-c59c597669c1"> | |
| 69 | +<img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/f8a79c47-4fe9-4564-9e4a-bf247ed1c961"> | |
| 70 | + | |
| 71 | +## Key Features | |
| 63 | 72 | |
| 64 | -* A heavily modified TavernAI 1.2.8 (more than 50% of code rewritten or optimized) | |
| 73 | +* Advanced text generation settings with many community-made presets | |
| 65 | -* Swipes | |
| 66 | -* Group chats: multi-bot rooms for characters to talk to you or each other | |
| 67 | -* Chat checkpoints / branching | |
| 68 | -* Advanced KoboldAI / TextGen generation settings with a lot of community-made presets | |
| 69 | 74 | * World Info support: create rich lore or save tokens on your character card |
| 70 | -* [OpenRouter](https://openrouter.ai) connection for various APIs (Claude, GPT-4/3.5 and more) | |
| 75 | +* Group chats: multi-bot rooms for characters to talk to you and/or each other | |
| 71 | -* [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui) API connection | |
| 76 | +* Rich UI customization options: theme colors, background images, custom CSS, and more | |
| 72 | -* [AI Horde](https://aihorde.net/) connection | |
| 77 | +* User personas: let the AI know a bit about you for greater immersion | |
| 73 | -* Prompt generation formatting tweaking | |
| 78 | +* Built-in RAG support: add documents to your chats for the AI to reference | |
| 74 | 79 | |
| 75 | 80 | ## Extensions |
| 76 | 81 | |
| @@ -78,58 +83,26 @@ SillyTavern has extensibility support. | ||
| 78 | 83 | |
| 79 | 84 | * Character emotional expressions (sprites) |
| 80 | 85 | * Auto-Summary of the chat history |
| 81 | -* Sending images to chat, and the AI interpreting the content | |
| 86 | +* Automatic UI and chat translation | |
| 82 | -* Stable Diffusion image generation (5 chat-related presets plus 'free mode') | |
| 87 | +* Stable Diffusion/FLUX/DALL-E image generation | |
| 83 | 88 | * Text-to-speech for AI response messages (via ElevenLabs, Silero, or the OS's System TTS) |
| 84 | -* Many more available to download from the "Download Extensions & Assets" menu. | |
| 89 | +* Web Search capabilities for adding additional real world context to your prompts | |
| 90 | +* Many more are available to download from the "Download Extensions & Assets" menu. | |
| 85 | 91 | |
| 86 | 92 | Tutorials on how to use them can be found in the [Docs](https://docs.sillytavern.app/). |
| 87 | 93 | |
| 88 | -## UI/CSS/Quality of Life tweaks by RossAscends | |
| 89 | - | |
| 90 | -* Mobile UI optimized for iOS, and supports saving a shortcut to the home screen and opening in fullscreen mode. | |
| 91 | -* HotKeys | |
| 92 | - * Up = Edit last message in chat | |
| 93 | - * Ctrl+Up = Edit last USER message in chat | |
| 94 | - * Left = swipe left | |
| 95 | - * Right = swipe right (NOTE: swipe hotkeys are disabled when the chat bar has something typed into it) | |
| 96 | - * Ctrl+Left = view locally stored variables (in the browser console window) | |
| 97 | - * Enter (with chat bar selected) = send your message to AI | |
| 98 | - * Ctrl+Enter = Regenerate the last AI response | |
| 99 | - | |
| 100 | -* User Name Changes and Character Deletion no longer force the page to refresh. | |
| 101 | - | |
| 102 | -* Toggle option to automatically connect to API on page load. | |
| 103 | -* Toggle option to automatically load the most recently viewed character on page load. | |
| 104 | -* Better Token Counter - works on unsaved characters, and shows both permanent and temporary tokens. | |
| 105 | - | |
| 106 | -* Better Past Chats View | |
| 107 | - * New Chat filenames are saved in a readable format of "(character) - (when it was created)" | |
| 108 | - * Chat preview increased from 40 characters to 300. | |
| 109 | - * Multiple options for characters list sorting (by name, creation date, chat sizes). | |
| 110 | - | |
| 111 | -* By default the left and right settings panel will close when you click away from it. | |
| 112 | -* Clicking the Lock on the nav panel will hold the panel open, and this setting be remembered across sessions. | |
| 113 | -* Nav panel status of open or closed will also be saved across sessions. | |
| 114 | - | |
| 115 | -* Customizable chat UI: | |
| 116 | - * Play a sound when a new message arrives | |
| 117 | - * Switch between round or rectangle avatar styles | |
| 118 | - * Have a wider chat window on the desktop | |
| 119 | - * Optional semi-transparent glass-like panels | |
| 120 | - * Customizable page colors for 'main text', 'quoted text', and 'italics text'. | |
| 121 | - * Customizable UI background color and blur amount | |
| 122 | - | |
| 123 | 94 | # ⌛ Installation |
| 124 | 95 | |
| 125 | 96 | > \[!WARNING] |
| 97 | +> | |
| 126 | 98 | > * DO NOT INSTALL INTO ANY WINDOWS CONTROLLED FOLDER (Program Files, System32, etc). |
| 127 | 99 | > * DO NOT RUN START.BAT WITH ADMIN PERMISSIONS |
| 128 | 100 | > * INSTALLATION ON WINDOWS 7 IS IMPOSSIBLE AS IT CAN NOT RUN NODEJS 18.16 |
| 129 | 101 | |
| 130 | 102 | ## 🪟 Windows |
| 131 | 103 | |
| 132 | 104 | ### Installing via Git |
| 105 | + | |
| 133 | 106 | 1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended) |
| 134 | 107 | 2. Install [Git for Windows](https://gitforwindows.org/) |
| 135 | 108 | 3. Open Windows Explorer (`Win+E`) |
| @@ -137,24 +110,16 @@ Tutorials on how to use them can be found in the [Docs](https://docs.sillytavern | ||
| 137 | 110 | 5. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter. |
| 138 | 111 | 6. Once the black box (Command Prompt) pops up, type ONE of the following into it and press Enter: |
| 139 | 112 | |
| 140 | 113 | -* for Release Branch: `git clone https://github.com/SillyTavern/SillyTavern -b release` |
| 141 | 114 | -* for Staging Branch: `git clone https://github.com/SillyTavern/SillyTavern -b staging` |
| 142 | 115 | |
| 143 | 116 | 7. Once everything is cloned, double-click `Start.bat` to make NodeJS install its requirements. |
| 144 | 117 | 8. The server will then start, and SillyTavern will pop up in your browser. |
| 145 | 118 | |
| 146 | 119 | ### Installing via SillyTavernGitHub LauncherDesktop |
| 147 | -1. On your keyboard: press **`WINDOWS + R`** to open Run dialog box. Then, run the following command to install git: | |
| 148 | -```shell | |
| 149 | -cmd /c winget install -e --id Git.Git | |
| 150 | -``` | |
| 151 | -2. On your keyboard: press **`WINDOWS + E`** to open File Explorer, then navigate to the folder where you want to install the launcher. Once in the desired folder, type `cmd` into the address bar and press enter. Then, run the following command: | |
| 152 | -```shell | |
| 153 | -git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher && start installer.bat | |
| 154 | -``` | |
| 155 | 120 | |
| 156 | -## Installing via GitHub Desktop | |
| 157 | 121 | (This allows git usage **only** in GitHub Desktop, if you want to use `git` on the command line too, you also need to install [Git for Windows](https://gitforwindows.org/)) |
| 122 | + | |
| 158 | 123 | 1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended) |
| 159 | 124 | 2. Install [GitHub Desktop](https://central.github.com/deployments/desktop/desktop/latest/win32) |
| 160 | 125 | 3. After installing GitHub Desktop, click on `Clone a repository from the internet....` (Note: You **do NOT need** to create a GitHub account for this step) |
| @@ -172,50 +137,82 @@ For MacOS / Linux all of these will be done in a Terminal. | ||
| 172 | 137 | 1. Install git and nodeJS (the method for doing this will vary depending on your OS) |
| 173 | 138 | 2. Clone the repo |
| 174 | 139 | |
| 175 | 140 | -* for Release Branch: `git clone https://github.com/SillyTavern/SillyTavern -b release` |
| 176 | 141 | -* for Staging Branch: `git clone https://github.com/SillyTavern/SillyTavern -b staging` |
| 177 | 142 | |
| 178 | 143 | 3. `cd SillyTavern` to navigate into the install folder. |
| 179 | 144 | 4. Run the `start.sh` script with one of these commands: |
| 180 | 145 | |
| 181 | 146 | -* `./start.sh` |
| 182 | 147 | -* `bash start.sh` |
| 148 | + | |
| 149 | +## ⚡ Installing via SillyTavern Launcher | |
| 150 | + | |
| 151 | +SillyTavern Launcher is an installation wizard that will help you get setup with many options, including installing a backend for local inference. | |
| 152 | + | |
| 153 | +### For Windows users | |
| 154 | + | |
| 155 | +1. On your keyboard: press **`WINDOWS + R`** to open Run dialog box. Then, run the following command to install git: | |
| 156 | + | |
| 157 | +```shell | |
| 158 | +cmd /c winget install -e --id Git.Git | |
| 159 | +``` | |
| 160 | + | |
| 161 | +2. On your keyboard: press **`WINDOWS + E`** to open File Explorer, then navigate to the folder where you want to install the launcher. Once in the desired folder, type `cmd` into the address bar and press enter. Then, run the following command: | |
| 183 | 162 | |
| 184 | -## Installing via SillyTavern Launcher | |
| 163 | +```shell | |
| 164 | +git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher && start installer.bat | |
| 165 | +``` | |
| 185 | 166 | |
| 186 | 167 | ### For Linux users |
| 168 | + | |
| 187 | 169 | 1. Open your favorite terminal and install git |
| 188 | 170 | 2. Git clone the Sillytavern-Launcher with: |
| 171 | + | |
| 189 | 172 | ```shell |
| 190 | 173 | git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher |
| 191 | 174 | ``` |
| 175 | + | |
| 192 | 176 | 3. Start the installer.sh with: |
| 177 | + | |
| 193 | 178 | ```shell |
| 194 | 179 | chmod +x install.sh && ./install.sh |
| 195 | 180 | ``` |
| 181 | + | |
| 196 | 182 | 4. After installation start the launcher.sh with: |
| 183 | + | |
| 197 | 184 | ```shell |
| 198 | 185 | chmod +x launcher.sh && ./launcher.sh |
| 199 | 186 | ``` |
| 200 | 187 | |
| 201 | 188 | ### For Mac users |
| 189 | + | |
| 202 | 190 | 1. Open a terminal and install brew with: |
| 191 | + | |
| 203 | 192 | ```shell |
| 204 | 193 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" |
| 205 | 194 | ``` |
| 195 | + | |
| 206 | 196 | 2. Install git with: |
| 197 | + | |
| 207 | 198 | ```shell |
| 208 | 199 | brew install git |
| 209 | 200 | ``` |
| 201 | + | |
| 210 | 202 | 3. Git clone the Sillytavern-Launcher with: |
| 203 | + | |
| 211 | 204 | ```shell |
| 212 | 205 | git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher |
| 213 | 206 | ``` |
| 207 | + | |
| 214 | 208 | 4. Start the installer.sh with: |
| 209 | + | |
| 215 | 210 | ```shell |
| 216 | 211 | chmod +x install.sh && ./install.sh |
| 217 | 212 | ``` |
| 213 | + | |
| 218 | 214 | 5. After installation start the launcher.sh with: |
| 215 | + | |
| 219 | 216 | ```shell |
| 220 | 217 | chmod +x launcher.sh && ./launcher.sh |
| 221 | 218 | ``` |
| @@ -236,18 +233,18 @@ You will need two mandatory directory mappings and a port mapping to allow Silly | ||
| 236 | 233 | |
| 237 | 234 | ##### Volume Mappings |
| 238 | 235 | |
| 239 | 236 | -* [config] - The directory where SillyTavern configuration files will be stored on your host machine |
| 240 | 237 | -* [data] - The directory where SillyTavern user data (including characters) will be stored on your host machine |
| 241 | 238 | -* [plugins] - (optional) The directory where SillyTavern server plugins will be stored on your host machine |
| 242 | 239 | |
| 243 | 240 | ##### Port Mappings |
| 244 | 241 | |
| 245 | 242 | -* [PublicPort] - The port to expose the traffic on. This is mandatory, as you will be accessing the instance from outside of its virtual machine container. DO NOT expose this to the internet without implementing a separate service for security. |
| 246 | 243 | |
| 247 | 244 | ##### Additional Settings |
| 248 | 245 | |
| 249 | 246 | -* [DockerNet] - The docker network that the container should be created with a connection to. If you don't know what it is, see the [official Docker documentation](https://docs.docker.com/reference/cli/docker/network/). |
| 250 | 247 | -* [version] - On the right-hand side of this GitHub page, you'll see "Packages". Select the "sillytavern" package and you'll see the image versions. The image tag "latest" will keep you up-to-date with the current release. You can also utilize "staging" and "release" tags that point to the nightly images of the respective branches, but this may not be appropriate, if you are utilizing extensions that could be broken, and may need time to update. |
| 251 | 248 | |
| 252 | 249 | #### Install command |
| 253 | 250 | |
| @@ -258,23 +255,28 @@ You will need two mandatory directory mappings and a port mapping to allow Silly | ||
| 258 | 255 | |
| 259 | 256 | > Note that 8000 is a default listening port. Don't forget to use an appropriate port if you change it in the config. |
| 260 | 257 | |
| 261 | 258 | ## 📱 Mobile - Installing via termuxTermux on Android OS |
| 262 | 259 | |
| 263 | 260 | > \[!NOTE] |
| 264 | 261 | > **SillyTavern can be run natively on Android phonesdevices using Termux., Pleasebut referwe todo thisnot guideprovide byofficial ArroganceComplex#2659:support for this use case.** |
| 262 | +> | |
| 263 | +> **Please refer to this guide by ArroganceComplex#2659:** | |
| 264 | +> | |
| 265 | 265 | > * <https://rentry.org/STAI-Termux> |
| 266 | 266 | |
| 267 | +**Unsupported platform: android arm LEtime-web.** 32-bit Android requires an external dependency that can't be installed with npm. Use the following command to install it: `pkg install esbuild`. Then run the usual installation steps. | |
| 267 | 268 | |
| 268 | 269 | ## API keys management |
| 269 | 270 | |
| 270 | 271 | SillyTavern saves your API keys to a `secrets.json` file in the user data directory (`/data/default-user/secrets.json` is the default path). |
| 271 | 272 | |
| 272 | 273 | By default, theyAPI keys will not be exposedvisible tofrom athe frontendinterface after you enterhave saved them and reloadrefreshed the page. |
| 273 | 274 | |
| 274 | 275 | In order to enable viewing your keys by clicking a button in the API block: |
| 275 | 276 | |
| 276 | 277 | 1. Set the value of `allowKeysExposure` to `true` in `config.yaml` file. |
| 277 | 278 | 2. Restart the SillyTavern server. |
| 279 | +3. Click the 'View hidden API keys' link at the bottom right of the API Connection Panel. | |
| 278 | 280 | |
| 279 | 281 | ## Command-line arguments |
| 280 | 282 | |
| @@ -292,134 +294,43 @@ Start.bat --port 8000 --listen false | ||
| 292 | 294 | |
| 293 | 295 | ### Supported arguments |
| 294 | 296 | |
| 295 | 297 | | Option | Description | Type | Default | |
| 296 | 298 | |-------------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------| |
| 297 | 299 | | `--version` | Show version number | boolean | | |
| 298 | 300 | | `--enableIPv6` | Enables IPv6. | boolean | false | |
| 299 | 301 | | `--enableIPv4` | Enables IPv4. | boolean | true | |
| 300 | 302 | | `--port` | Sets the port under which SillyTavern will run. If not provided falls back to yaml config 'port'. | number | 8000 | |
| 301 | 303 | | `--dnsPreferIPv6` | Prefers IPv6 for dns. If not provided falls back to yaml config 'preferIPv6'. | boolean | false | |
| 302 | 304 | | `--autorun` | Automatically launch SillyTavern in the browser. If not provided falls back to yaml config 'autorun'.| boolean | false | |
| 303 | 305 | | `--autorunHostname` | The autorun hostname, probably best left on 'auto'. | string | null | |
| 304 | 306 | | `--autorunPortOverride` | Overrides the port for autorun. | string | null | |
| 305 | 307 | | `--listen` | SillyTavern is listening on all network interfaces. If not provided falls back to yaml config 'listen'.| boolean | false | |
| 306 | 308 | | `--corsProxy` | Enables CORS proxy. If not provided falls back to yaml config 'enableCorsProxy'. | boolean | false | |
| 307 | 309 | | `--disableCsrf` | Disables CSRF protection | boolean | null | |
| 308 | 310 | | `--ssl` | Enables SSL | boolean | false | |
| 309 | 311 | | `--certPath` | Path to your certificate file. | string | "certs/cert.pem" | |
| 310 | 312 | | `--keyPath` | Path to your private key file. | string | "certs/privkey.pem" | |
| 311 | 313 | | `--whitelist` | Enables whitelist mode | boolean | null | |
| 312 | 314 | | `--dataRoot` | Root directory for data storage | string | null | |
| 313 | 315 | | `--avoidLocalhost` | Avoids using 'localhost' for autorun in auto mode. | boolean | null | |
| 314 | 316 | | `--basicAuthMode` | Enables basic authentication | boolean | null | |
| 315 | 317 | | `--requestProxyEnabled` | Enables a use of proxy for outgoing requests | boolean | null | |
| 316 | 318 | | `--requestProxyUrl` | Request proxy URL (HTTP or SOCKS protocols) | string | null | |
| 317 | 319 | | `--requestProxyBypass` | Request proxy bypass list (space separated list of hosts) | array | null | |
| 318 | 320 | |
| 319 | 321 | ## Remote connections |
| 320 | 322 | |
| 321 | 323 | Most often this is for people who want to use SillyTavern on their mobile phones while their PC runs the ST server on the same wifiWi-Fi network. However, it can be used to allow remote connections from anywhere as well. |
| 322 | - | |
| 323 | -However, it can be used to allow remote connections from anywhere as well. | |
| 324 | - | |
| 325 | -**IMPORTANT: Refer to the official guide if you want to configure SillyTavern user accounts with (optional) password protection: [Users](https://docs.sillytavern.app/installation/st-1.12.0-migration-guide/#users).** | |
| 326 | - | |
| 327 | -### 1. Managing whitelisted IPs | |
| 328 | - | |
| 329 | -* Create a new text file inside your SillyTavern base install folder called `whitelist.txt`. | |
| 330 | -* Open the file in a text editor, and add a list of IPs you want to be allowed to connect. | |
| 331 | - | |
| 332 | -*Both individual IPs and wildcard IP ranges are accepted. Examples:* | |
| 333 | - | |
| 334 | -```txt | |
| 335 | -192.168.0.1 | |
| 336 | -192.168.0.20 | |
| 337 | -``` | |
| 338 | - | |
| 339 | -or | |
| 340 | - | |
| 341 | -```txt | |
| 342 | -192.168.0.* | |
| 343 | -``` | |
| 344 | - | |
| 345 | -(the above wildcard IP range will allow any device on the local network to connect) | |
| 346 | - | |
| 347 | -CIDR masks are also accepted (eg. 10.0.0.0/24). | |
| 348 | - | |
| 349 | -* Save the `whitelist.txt` file. | |
| 350 | -* Restart your ST server. | |
| 351 | - | |
| 352 | -Now devices which have the IP specified in the file will be able to connect. | |
| 353 | - | |
| 354 | -*Note: `config.yaml` also has a `whitelist` array, which you can use in the same way, but this array will be ignored if `whitelist.txt` exists.* | |
| 355 | - | |
| 356 | -### 2. Getting the IP for the ST host machine | |
| 357 | - | |
| 358 | -After the whitelist has been setup, you'll need the IP of the ST-hosting device. | |
| 359 | - | |
| 360 | -If the ST-hosting device is on the same wifi network, you will use the ST-host's internal wifi IP: | |
| 361 | - | |
| 362 | -* For Windows: windows button > type `cmd.exe` in the search bar > type `ipconfig` in the console, hit Enter > look for `IPv4` listing. | |
| 363 | - | |
| 364 | -If you (or someone else) want to connect to your hosted ST while not being on the same network, you will need the public IP of your ST-hosting device. | |
| 365 | 324 | |
| 366 | -* While using the ST-hosting device, access [this page](https://whatismyipaddress.com/) and look for `IPv4`. This is what you would use to connect from the remote device. | |
| 325 | +Read the detailed guide on how to set up remote connections in the [Docs](https://docs.sillytavern.app/usage/remoteconnections/). | |
| 367 | 326 | |
| 368 | -### 3. Connect the remote device to the ST host machine | |
| 327 | +You may also want to configure SillyTavern user profiles with (optional) password protection: [Users](https://docs.sillytavern.app/installation/st-1.12.0-migration-guide/#users). | |
| 369 | - | |
| 370 | -Whatever IP you ended up with for your situation, you will put that IP address and port number into the remote device's web browser. | |
| 371 | - | |
| 372 | -A typical address for an ST host on the same wifi network would look like this: | |
| 373 | - | |
| 374 | -`http://192.168.0.5:8000` | |
| 375 | - | |
| 376 | -Use http:// NOT https:// | |
| 377 | - | |
| 378 | -### Opening your ST to all IPs | |
| 379 | - | |
| 380 | -We do not recommend doing this, but you can open `config.yaml` and change `whitelistMode` to `false`. | |
| 381 | - | |
| 382 | -You must remove (or rename) `whitelist.txt` in the SillyTavern base install folder if it exists. | |
| 383 | - | |
| 384 | -This is usually an insecure practice, so we require you to set a username and password when you do this. | |
| 385 | - | |
| 386 | -The username and password are set in `config.yaml`. | |
| 387 | - | |
| 388 | -After restarting your ST server, any device will be able to connect to it, regardless of their IP as long as they know the username and password. | |
| 389 | - | |
| 390 | -### Still Unable To Connect? | |
| 391 | - | |
| 392 | -* Create an inbound/outbound firewall rule for the port found in `config.yaml`. Do NOT mistake this for port-forwarding on your router, otherwise, someone could find your chat logs and that's a big no-no. | |
| 393 | -* Enable the Private Network profile type in Settings > Network and Internet > Ethernet. This is VERY important for Windows 11, otherwise, you would be unable to connect even with the aforementioned firewall rules. | |
| 394 | 328 | |
| 395 | 329 | ## Performance issues? |
| 396 | 330 | |
| 397 | 331 | Try1. enablingDisable the No Blur Effect (Fastand UI)enable modeReduced Motion on the User settingsSettings panel (UI Theme toggles category). |
| 398 | - | |
| 332 | +2. If using response streaming, set the streaming FPS to a lower value (10-15 FPS is recommended). | |
| 399 | -## I like your project! How do I contribute? | |
| 333 | +3. Make sure the browser is enabled to use GPU acceleration for rendering. | |
| 400 | - | |
| 401 | -### DO's | |
| 402 | - | |
| 403 | -1. Send pull requests | |
| 404 | -2. Send feature suggestions and issue reports using established templates | |
| 405 | -3. Read the readme file and built-in documentation before asking anything | |
| 406 | - | |
| 407 | -### DONT's | |
| 408 | - | |
| 409 | -1. Offer monetary donations | |
| 410 | -2. Send bug reports without providing any context | |
| 411 | -3. Ask the questions that were already answered numerous times | |
| 412 | - | |
| 413 | -## Where can I find the old backgrounds? | |
| 414 | - | |
| 415 | -We're moving to a 100% original content only policy, so old background images have been removed from this repository. | |
| 416 | - | |
| 417 | -You can find them archived here: | |
| 418 | - | |
| 419 | -<https://files.catbox.moe/1xevnc.zip> | |
| 420 | - | |
| 421 | - | |
| 422 | - | |
| 423 | 334 | |
| 424 | 335 | ## License and credits |
| 425 | 336 | |
| @@ -428,32 +339,19 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 428 | 339 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 429 | 340 | GNU Affero General Public License for more details.** |
| 430 | 341 | |
| 431 | -* TAI Base by Humi: MIT | |
| 342 | +* [TavernAI](https://github.com/TavernAI/TavernAI) 1.2.8 by Humi: MIT License | |
| 432 | -* Cohee's modifications and derived code: AGPL v3 | |
| 343 | +* Portions of CncAnon's TavernAITurbo mod used with permission | |
| 433 | -* RossAscends' additions: AGPL v3 | |
| 344 | +* Visual Novel Mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>) | |
| 434 | -* Portions of CncAnon's TavernAITurbo mod: Unknown license | |
| 435 | -* kingbri's various commits and suggestions (<https://github.com/bdashore3>) | |
| 436 | -* city_unit's extensions and various QoL features (<https://github.com/city-unit>) | |
| 437 | -* StefanDanielSchwarz's various commits and bug reports (<https://github.com/StefanDanielSchwarz>) | |
| 438 | -* Waifu mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>) | |
| 439 | -* Thanks Pygmalion University for being awesome testers and suggesting cool features! | |
| 440 | -* Thanks oobabooga for compiling presets for TextGen | |
| 441 | -* KoboldAI Presets from KAI Lite: <https://lite.koboldai.net/> | |
| 442 | 345 | * Noto Sans font by Google (OFL license) |
| 443 | 346 | * Icon theme by Font Awesome <https://fontawesome.com> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) |
| 444 | -* AI Horde client library by ZeldaFan0225: <https://github.com/ZeldaFan0225/ai_horde> | |
| 347 | +* Default content by @OtisAlejandro (Seraphina character and lorebook) and @kallmeflocc (10K Discord Users Celebratory Background) | |
| 445 | -* Linux startup script by AlpinDale | |
| 446 | -* Thanks paniphons for providing a FAQ document | |
| 447 | -* 10K Discord Users Celebratory Background by @kallmeflocc | |
| 448 | -* Default content (characters and lore books) provided by @OtisAlejandro, @RossAscends and @kallmeflocc | |
| 449 | -* Korean translation by @doloroushyeonse | |
| 450 | -* k_euler_a support for Horde by <https://github.com/Teashrock> | |
| 451 | -* Chinese translation by [@XXpE3](https://github.com/XXpE3), 中文 ISSUES 可以联系 @XXpE3 | |
| 452 | 348 | * Docker guide by [@mrguymiah](https://github.com/mrguymiah) and [@Bronya-Rand](https://github.com/Bronya-Rand) |
| 453 | 349 | |
| 350 | +## Top Contributors | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 454 | 354 | <!-- LINK GROUP --> |
| 455 | -[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square | |
| 456 | 355 | [cover]: https://github.com/SillyTavern/SillyTavern/assets/18619528/c2be4c3f-aada-4f64-87a3-ae35a68b61a4 |
| 457 | 356 | [discord-link]: https://discord.gg/sillytavern |
| 458 | -[discord-shield]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square | |
| 459 | 357 | [discord-shield-badge]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge |