Sillytavern docs. Launch SillyTavern and navigate to Extensions > Assets.

Sillytavern docs If target language is not provided, the value from the extension settings will be used. SillyTavern LLM Frontend for Power Users Documentation. Contribute to SillyTavern/SillyTavern-Docs development by creating an account on GitHub. 3 KB. getContext (). Several routers come with the ability to host a VPN server (primarily OpenVPN or WireGuard) in the router administration page. release - 🌟 Recommended for most users. 2. You switched accounts on another tab or window. If you don't mind your chats potentially being used to train models, improve Mancer's service, publish datasets, or whatever else they To share your SillyTavern instance with others, you can create multiple user accounts. repo-forked. The selected group member will be the only one to reply. Install the "Objective" extension from the "Download Extensions & Assets" menu in the Extensions panel (stacked blocks icon). This tool is used to convert incoming audio. The summary is updated and embedded into the chat file's metadata for the message that The technical storage or access is strictly necessary for the legitimate purpose of enabling the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network. SillyTavern can connect to a wide range of LLM APIs. # ffmpeg. (Optional but recommended) Set up trigger words in SillyTavern. This is your hub for managing the SillyTavern saves your API keys to a secrets. on your PC, or the colab machine). Make sure you have ffmpeg binary in your PATH environment variable. API Connections. API Key. label order icon; VPNs and Tunneling-40. It will break your other packages, do unnecessary # Tips and FAQs for using NovelAI with SillyTavern. # Method 1 - GIT We always recommend users install using 'git'. bankrupt app developers, hamper moderation, and exclude blind users Configure SillyTavern: (Optional) Specify a custom Whisper model as in the Whisper setup above. Edit these settings in the "Advanced Formatting" panel. 0) adds a new option in the "Magic Wand" menu - Data Bank. This guide is not for Windows users. # What are a Character's 'Permanent Tokens'? These will always be sent to the AI with every generation request: Character Name (keep the name short! Sent at the start of EVERY Character message) The SillyTavern engine activates and seamlessly integrates the appropriate lore into the prompt, providing background information to the AI. . formality in config. # Methods. It possesses the following features: Do not use SillyTavern on a public server or with untrusted users. !!! /help – displays the help message /api - switches to a different API /sys - sends a neutral message as a system narrator /send - sends a message as the user without triggering the SillyTavern-Docs / extensions / Stable-Diffusion. SillyTavern comes with many extensions that can be enabled or disabled in the Extensions panel. # Extensions panel. The free mode is also supported via the /sd (anything_here) command in the chat input bar. Once in the desired folder, type cmd into the address bar and press enter. json file with one of the default SillyTavern templates. md at zh-CN · eigeen/SillyTavern-Docs-CN Checking the logs in the terminal window that you're running SillyTavern in; Checking the console in your browser's developer tools # Changing how the Prompt is Built. This field is a template for pre-chat character data (known internally as a story string). If you have an OpenAI Follow the installation guide for your platform: SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users. yaml file: # Enable multi-user mode enableUserAccounts: true # Enable discreet login mode: hides user list on the login screen enableDiscreetLogin: true. The Prompt Manager is a system that allows for more control over the prompt-building strategy for Chat Completion APIs. By default, they will not be exposed to a frontend after you enter them and reload the page. For Windows Users. /websearch (query) — searches snippets of the web pages online for the specified query and Documentation website for SillyTavern. order icon expanded route-30. When you send a message to your AI, the text you write is combined with other text to form a single request that's sent to the AI. Formality levels available for German, French, Italian, Spanish, Dutch, Japanese, and Russian; Configure via deepl. They are useful to organize quickly growing collections by themes, quality, provenance or whatever you like. The classify module uses a small 'sentiment parsing' model that runs on the SillyTavern host machine (eg. Our goal is to empower users with as much utility and control over It's a simple yet powerful scripting language that could be used to expand the functionality of SillyTavern without serious coding, allowing you to: STscript is built using the slash commands engine, utilizing command batching, data piping, SillyTavern (or ST for short) is a locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. Github; Discord; Reddit #Important note. SillyTavern extensions (both built-in, downloadable and third-party) can add their own slash command. Enter your Mancer API Key and click Connect. User accounts can also be password-protected. #Image Generation. Documentation website for SillyTavern. SillyTavern 中文文档 (SillyTavern document website for Chinese) - SillyTavern-Docs-CN/readme. # Fair Warning. This guide is not meant for beginners. This combined text is called a "prompt" or sometimes the "request" or This guide will show you how to use a VPN or a tunnel to access your SillyTavern instance from anywhere. Once connected, just go to SillyTavern Documentation. Very important: Don't install the following requirements to your Extras environment or system Python. bat file. Click the API Connections button in the top bar. Refer to your router's manual to setup a VPN and add your devices to the VPN. Must be unique. You signed out in another tab or window. SillyTavern provides a set of tools You signed in with another tab or window. Make sure you're on the latest update of Oobabooga's TextGen (as of Nov 14th, 2023). typography. Applies to: Chat Completion APIs. In the background, what RVC does is work in tandem with SillyTavern's TTS extension: it waits for TTS to generate an audio file (which TTS would've done regardless of whether you use RVC or not), then RVC will perform a second pass that takes the TTS audio file and transforms it into the cloned voice from your RVC configuration. GitHub; Discord; Reddit; Powered by # Prompt Manager. Use when you need The summarization extension is installed in SillyTavern by default, thus it will show up in ST's Extensions panel (stacked cubes icon) list like this: Summarize Config Panel. (Optional) displayName: "My Function", // Description of the function tool. Open the "Web Search" extension settings, set your API key or connect to Extras, and enable the extension. SillyTavern is a fork of TavernAI 1. First try using the UpdateAndStart. 09 KB. Mobile-friendly layout, Multi-API (KoboldAI/CPP, Horde, NovelAI, Ooba, OpenAI, OpenRouter, Claude, Scale), VN-like Waifu Mode, Stable Diffusion, TTS, WorldInfo (lorebooks), customizable UI, auto-translate, and more prompt options than you'd ever want or need + ability to install thir SillyTavern (or ST for short) is a locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. false /usage/api-connections. Enable Dynamic Audio Extension: In SillyTavern, go to Extensions > Dynamic Audio. # Accessing the Data Bank. Install Git using your package manager. Creating user personas is optional, but it is a good way to automate routine actions. json file in the server directory. Don't forget to restart the Docker container for SillyTavern in order to apply your changes! SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users. Summarization can help with outlining general details of what is happening in the SillyTavern-Docs / Administration / tunneling. Each user has their own settings, extensions, and data. SillyTavern's RVC supports several API sources that perform audio conversion: rvc-python; SillyTavern Extras (deprecated) # Common prerequisites. Enable this with the checkbox. This is what you double-click to run SillyTavern) config. A place to discuss the SillyTavern fork of TavernAI. Since the results of tokenization can be inaccurate on context sizes close to the model-defined maximum, some parts of the prompt may be trimmed or dropped, which may The settings provided in this section allow for more control over the prompt-building strategy, primarily for Text Completion APIs. Preview. An implementation of Talking Head Anime 3 Demo for AITuber. You can access your SillyTavern instance from your phone, tablet, or another computer. Extensions can add new features, change the behaviour of existing features, or provide additional content for your AI to use. It is a YAML file that contains various settings, such as the network settings, security settings, and backend-specific options. What is it? This extension allows you to create, store, and utilize automatically generated summaries based on the events happening in your chats. The difference comes down to what the models are trained for. Must describe what the function does and when to use it. The list may be incomplete, make sure to check /help slash for the most complete list of available commands. It is important to note that while World Info helps guide the AI toward the desired content, it does not guarantee its Scripts can also interact with SillyTavern's UI: navigate through the chats or change styling parameters. #DeepL-specific configuration. This guide will show you how to use a VPN or a tunnel to access your SillyTavern instance from A persona in SillyTavern represents a combination of a user name and a picture that create a unique identity for the character you play in your chats or identify yourself as. Before you begin, ensure you've met the following prerequisites. bat which is located in your SillyTavern installation base folder. order icon; 140. SillyTavern Documentation. This will be very technical. Image Generation. If disabled, mouth will be animated according to the message text length when a new character message is received. Code. Click on the "Connect" button to establish a connection to the official assets repository. **So What is SillyTavern?** Tavern is a user interface you can install on your computer (and Android phones) that allows you to interact text generation AIs and chat/roleplay with characters you or the community create. release- Recommended for most users. Here's why: When you have installed via git clone, all you have to do to update is type git pull in a command line in the ST folder. 103 lines (67 loc) · 7. AI Horde is a community-driven AI service that provides access to a variety of AI models. While multiple sentiments may be expressed in a single message, the model only picks the most likely one and returns that to Silly Tavern is a web UI which allows you to create upload and download unique characters and bring them to life with an LLM Backend. On your keyboard: press WINDOWS + R to open Run dialog box. . Do not use SillyTavern on a public server or with untrusted users. Manage extensions: Activate, deactivate, and update extensions; Download Extensions & Assets: Install more extensions, characters, sounds, and backgrounds from the SillyTavern repository; Notify on extension updates: Check to be notified when there are updates available for installed daswer123 made an API server that runs the XTTSv2 model on your computer and connects to SillyTavern's TTS extension. md at zh-CN · xikunerte/SillyTavern-Docs-CN SillyTavern-Docs / Usage / API_Connections / novelai. 12. SillyTavern-Docs / Usage / API_Connections / index. Blame. Below is a description of their respective strengths, weaknesses, and use cases. Will be shown in the UI. Then, run the following command to install git: cmd /c winget install -e --id Git. Alternatively, if the The SillyTavern engine activates and seamlessly integrates the appropriate lore into the prompt, providing background information to the AI. For the most up-to-date list of commands that will work in your instance, use the /help slash chat command in any SillyTavern chat. The built-in Chat Attachments extension (included by default in release versions >= 1. GitHub; Discord; Reddit; Powered by. There are several ways to add or remove tags to a character card: Import !!!warning This is not an exhaustive list as it is updated rarely. # Story string. Our goal is to empower users with as much utility and control over SillyTavern (or ST for short) is a locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. You can always change them later. The Content of this box is not automatically transferred to any new chat. 12 KB. NovelAI. Remote access. To enable viewing your keys by clicking a button in the API block: SillyTavern-Docs / Usage / Prompts / prompts. # Character navigation /random — opens a chat with the random character. yaml is the main configuration file for the SillyTavern server that you can find in the repository root directory after completing the installation. You signed in with another tab or window. SillyTavern (or ST for short) is a locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. # Anonymous Logging. The web search results will be added to the prompt organically as you chat. This is the main way to format your character card for text completion and instruct models. In SillyTavern's onboarding screen, enter a name for your persona. First, searches for the exact name match, then by a prefix, then by a substring. SillyTavern's configuration file (config. Debian (Ubuntu/Pop! OS/etc. On your keyboard: press WINDOWS + E to open File Explorer, then navigate to the folder where you want to install the launcher. Select some AI models to use. Close the API Connections window. yaml) will be located within the config folder. On your keyboard: press WINDOWS + E to open File Explorer, then navigate to the SillyTavern provides a set of tools for building a multi-purpose knowledge base from a diverse number of sources, as well as using the collected data in LLM prompts. Presenting all the parts of your prompt to the AI in the right way is crucial for getting the best responses. Context comprises character information, system prompts, chat history, etc. # Tagging. !!! /help – displays the help message /api - switches to a different API /sys - sends a neutral message as a system narrator /send - sends a message as the user without triggering the SillyTavern is a frontend for power users to interact with LLMs, offering documentation and community support. getContext provides a more stable API. Typically updated once a month. name: "myFunction", // Display name of the function tool. NovelAI is a paid subscription service that allows unlimited monthly access to their high-quality in-house text generation, image generation, and text-to-speech models. Raw. 146 lines (103 loc) · 8. Using imports from SillyTavern code is unreliable and can break at any time if the internal structure of ST's modules changes. Git. When the user account setting is disabled, a default-user fallback admin account is utilized for 1. Auto-send Interaction: #Configuring Author's Notes # Chat-specific Author's Note The box at the top of the Author's Note panel contains the Author's Note for your current chat. It's suitable for the majority of users. 67 lines (41 loc) · 4. 187 lines (107 loc) · 13 KB. That depends on how good your model is at making use of additional information! In SillyTavern, select the Text Completion API, and then select Mancer under API Type. Our goal is to empower Here are two easy ways to get started: You can use AI Horde for free. Most You signed in with another tab or window. Reload to refresh your session. The SillyTavern engine activates and seamlessly integrates the appropriate lore into the prompt, providing background information to the AI. bat part of the file name might be hidden by your OS, in that case, it will look like a file called "Start". daswer123 made an API server that runs the XTTSv2 model on your computer and connects to SillyTavern's TTS extension. 228 lines (153 loc) · 12. Edit the CMD_FLAGS. The maximum number of tokens that SillyTavern will send to the API as the prompt, minus the response length. The changes made to this file will take effect after restarting the server. Each character has a name, personality, and conversation history. In this tutorial I will show how to set silly tavern using a This guide will hopefully cover how to host SillyTavern on your PC where you can connect from anywhere and chat to your bots on the same PC you use to run AI models! Warning. Regular updates, which can sometimes break compatibility with SillyTavern; GitHub; Correct Way to Connect SillyTavern to Ooba's new OpenAI API. Prompts. You can control how the prompt is built. yaml # Slash Commands Use /translate command for quick translations. Contribute to ConsciousDissonance/SusTavern-Docs development by creating an account on GitHub. /go (name) — opens a chat with the character of the specified name. md. There are several ways to use this: There are several ways to use this: # 1. VPNs and tunnels are a secure way to access your home network from anywhere in the world. By default, the repository will be cloned here: C:\Users\[Your Windows Username]\Documents\GitHub\SillyTavern. Enter an API key for AI Horde. It's completely independent of Extras API and would use a separate environment. We recommend using a Linux VM SillyTavern. Launch SillyTavern and navigate to Extensions > Assets. If that fails, come back here and continue reading. Double-click on the start. 179 lines (114 loc) · 9. Plugins are not sandboxed, be careful what you install and run! SillyTavern 中文文档 (SillyTavern document website for Chinese) - xikunerte/SillyTavern-Docs-CN #Windows. VPNs and Tunneling. There are a lot of common problems and questions that come up when switching to NovelAI from another ST backend API. Derive templates option must be enabled in the Advanced Formatting menu. Your imagination is the limit, you can give the AI any objective you wish and it will plan out how to achieve it. Character cards and groups can be assigned zero or more tags. SillyTavern-Docs / extensions / Summarize. Only messages starting with these trigger words will be sent to SillyTavern as actual messages. Plugins are contained in the plugins directory of SillyTavern and loaded on server startup, but only if enableServerPlugins is set to true in the config. It will break your other packages, do unnecessary downgrades, etc. Use local or cloud-based Stable Diffusion, FLUX or DALL-E APIs to generate images. staging - ⚠️ Not recommended for Unless SillyTavern uses a tokenizer provided by the remote backend API that runs the model, all token counts assumed during prompt generation are estimated based on the selected tokenizer type. !!!warning This is not an exhaustive list as it is updated rarely. It helps improve the accuracy of AI answers by accessing information outside of the model's training data. Our goal is to empower 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 Follow the steps in Manage Docker as a non-root user in the Docker Post-Installation Guide. It is important to note that while World Info helps guide the AI toward the desired content, it does not guarantee its appearance in the generated output messages. You can ask it to plan how to slay a demon, rob a temple, throw a Install the extension via the "Download Extensions & Assets" menu in SillyTavern. This works by comparing a hash of the chat template defined in the model's tokenizer_config. Download the desired audio assets, such as background music (BGM) or ambient sounds, that correspond to the backgrounds you intend to use. User messages won't trigger any replies automatically. Then restart Ooba's server. Only work with TTS whose sound is played by Sillytavern itself like XTTS (not in streaming mode). 17 KB. Just choose a few from the top. This is the most stable and recommended branch, updated only when major releases are pushed. Use a home-made VPN. description: "My function description. Most of the settings in this panel do not apply to Chat Completions APIs as they are governed by the prompt manager system instead. Text Completion APIs Documentation website for SillyTavern. 8 which is under more active development, and has added many major A FastAPI based application that allows for generating text using an LLM using the Exllamav2 backend, with support for Exl2, GPTQ, and FP16 models. If you're missing any of the functions/properties in getContext, please get in touch with the developers or send us a Pull Request! # Registering slash commands (new way) While Documentation website for SillyTavern. registerFunctionTool ({// Internal name of the function tool. This model takes the new output from the AI and detects what kind of sentiment, or emotion, the text is expressing. Triggering a generation with an empty user input will trigger a random unmuted group member to SillyTavern 中文文档 (SillyTavern document website for Chinese) - SillyTavern-Docs-CN/readme. (Note: the . Then, run the following command: Documentation website for SillyTavern. Syntax: /translate [target=language_code] text. This name will be used in the chat. This prevents random speech or noise from being transcribed. You can use 0000000000 for now, or get a free key from AI Horde. GitHub; Discord; Reddit; Powered by # Tags. File metadata and controls. Some Text Completion sources provide To open or close the Extensions panel, choose Extensions in the top bar. That depends on how good your model is at Retrieval-augmented generation (RAG) is a technique for providing external sources of knowledge to the LLM. Some Text Completion sources provide an ability to automatically choose templates recommended by the model author. Top. 2. ) Clone the SillyTavern SillyTavern uses HTML elements with data-i18n attributes to mark translatable content. Below is just an example of the capabilities in the official extensions. Configuring the config file should be no different than configuring it without Docker, however you will need to run nano or a code editor with administrator rights in order to save your changes. Summarize. This can be applied to #Installing. For equivalent settings in Text Completion APIs, use Advanced Formatting. lock. Automatically generate images as replies to your messages for full immersion, generate from chat history and character information from the wand menu or slash commands, or use the /sd (anything_here) command in the chat input bar to make an image with your own prompt. Characters are the AI identities that you can create and manage to shape the AI's role in the conversation. SillyTavern automatically calculates the best way to allocate the available context tokens before sending the information to the AI model. yaml file. With the LLM now on your PC, we need to download a tool that will act as a middle-man between SillyTavern and the model: it will load the model, and expose its functionality as a local HTTP web API that SillyTavern can talk to, the same way that SillyTavern talks with paid webservices like OpenAI GPT or Claude. Most likely, you've used an OpenAI or Anthropic model (or a local model made to resemble those), which is built Enable this checkbox to have the VRM mouth movement follow the sound of your TTS when it's played. GitHub; Discord; Reddit; Powered by # Characters. Current summary - displays and provides an ability to modify the current summary. 51 KB. # Configuration. You can create as many characters as you like, and switch between them at any time. SillyTavern includes a list of pre-made conversion rules for different models, but you may customize them however you like. A dotted line between messages denotes the context range for the chat. Access Prompt You can select the character to reply manually from the menu or with the /trigger command. To enable and use the multi-user mode, edit the config. More extensions can be installed from the "Download Extensions & Assets" menu in the Extensions panel. # Common Use Cases. Make sure you're on the latest version of SillyTavern. txt file, and add the --api flag there. You should now be able to chat with any Mancer model of your choice. qnup jyvt mtgfl kctdw njil bdikioac qdukod wvbppl huovta qbmbw