# Extras Installation

This page contains instructions for installing SillyTavern Extras on your local device.

# Extras project has been discontinued since April 2024 and won't receive any new updates or modules. The vast majority of modules are available natively in the main SillyTavern application. You may still install and use it but don't expect to get immediate support if you face any issues.

Local installation of Extras can be difficult or impossible on your OS (especially Termux).

# Use the Official Extras Colab

  • Simple to setup
  • Free to use
  • No Colab GPU credits required (use the use_cpu options)
  • See the Colab Guide Page for details.

# Installation Methods

# MiniConda (recommended)

This method is recommended because Conda makes a 'virtual environment' for the Extras requirement packages to live inside, so they do not affect your system-wide Python setup.

  1. Install Miniconda

(Important!) Read how to use Conda

  1. Install git

(Chads who installed SillyTavern with git to begin with can skip this step!)

After you have both of them installed...

Type/paste the commands below ONE BY ONE IN THE CONDA COMMAND PROMPT WINDOW and hit Enter after each one.

  1. Create a new Conda environment (let's call it extras):

conda create -n extras

  1. Activate the new environment

conda activate extras (you should see (extras) pop up on the left side of your command prompt)

  1. Install the required system packages (this will take some time)

conda install python=3.11 git

  1. Clone the Extras GitHub repo

git clone https://github.com/SillyTavern/SillyTavern-extras

  1. Navigate to your cloned Extras repo

cd SillyTavern-extras

  1. Install Extras' requirements by using one of the following commands (will take time, again):
  • pip install -r requirements.txt - for basic features
  • pip install -r requirements-rvc.txt - for real-time voice cloning
  • pip install -r requirements-coqui.txt - for Coqui TTS (not recommended)

See the Common Problems page if you get errors at this step!

  1. See below 'Running Extras After Install'

# System-Wide Installation

This is easier, but will affect your system-wide Python installation.

This can cause conflicts if you work with many Python programs that have different requirements.

If this is your first time touching anything Python-related, that should not be a problem.

  1. Install Python 3.11: https://www.python.org/downloads/release/python-3115/
  2. Install git: https://git-scm.com/downloads
  3. Open a command prompt window and go to a folder in which you have complete access permissions.
  4. Clone the repo: git clone https://github.com/SillyTavern/SillyTavern-extras, hit Enter.
  5. After the clone has finished, type cd SillyTavern-extras, hit Enter.
  6. Type python -m pip install -r requirements.txt
  7. See below 'Running Extras After Install'

# Running Extras After Install

# Confirm extensions are enabled

  1. Open the file called config.yamlin a text editor. The file is located in ST's base install folder.
  2. Look for the line that reads enableExtensions.
  3. Make sure that line has true, and not false.

# Decide which module to use

(This only needs to be done once)

  • Extras is always started with a Python command line.
  • python server.py is the bare minimum, but it does not enable any useful modules.
  • to enable modules you must use the --enable-modules= modifier, with a comma-separated list of module names

Example: python server.py --enable-modules=caption,summarize,classify

This would enable Image Captioning, Chat Summary, and live updating Character Expressions.

Below is a table that describes each module.

Name Description
caption Image captioning
summarize Text summarization
classify Text sentiment classification
sd Stable Diffusion image generation
silero-tts Silero TTS server
edge-tts Microsoft Edge TTS client
chromadb Vector storage server
coqui-tts Coqui TTS
rvc Real-time voice cloning
  • Decide which modules you want to add to your Python command line.
  • They will be used in the next step.

NOTE: There must be no spaces at all in your Python command's module list!

# Start Extras Server

While still in your command prompt window inside the Extras installation folder...

  1. Make sure your conda environment is active (if you used the Conda install method)
  2. Type activate extras if the environment is not active.
  3. Type python server.py --enable-modules=YOUR,SELECTED,MODULE,LIST,HERE
  4. The extras server will load.
  5. After a while it will show you a URL at the end. For local installs, this defaults to http://localhost:5100.
  6. Copy the API URL.

# Connect ST to the Extras server

  1. Start your SillyTavern server, and view the SillyTavern interface in your browser.
  2. Open the Extensions panel (via the 'Stacked Blocks' icon at the top of the page)
  3. Paste the API URL into the input box.
  4. Click Connect.

To run Extras again, simply activate the environment and run these commands in a command prompt.

conda activate extras, Hit Enter. python server.py, Hit Enter.

Be sure to the additional options for server.py (see below) that your setup requires.

# Make a .bat File for Easy Startup

This is Optional and only applies to Windows, but something similar should be possible on MacOS.

  1. View your Windows Desktop
  2. Right-click, select New, and then click Text Document
  3. A new file will appear on your Desktop, asking for a name.
  4. Name the file STExtras.txt
  5. Open the newly created file in a text editor.
  6. Paste the following code into it:
cd C:\_your_\_full_\_Extras_\_folder_\_path_\
call conda activate extras
python server.py --enable-modules=YOUR,SELECTED,MODULE,LIST,HERE,WITH,NO,SPACES
call conda deactivate
  1. Replace the placeholder folder path with your actual Extras install folder path.
  2. Replace the python command line with your actual command line
  3. Save the file with a new name STExtras.bat (Use File >> Save As in most text editors)

You can now simply double-click on this .bat file to easily start Extras.

If you ever want to change the module list (or any other command line modifiers for the extras server), simply edit the python command inside the .bat file.