# Expression Images

# What is it?

Expression images are images (aka 'sprites') of your AI character which are shown next to (or behind) the chat window.

Expression images do not require Extras to work.

However, having Extras running with the classify module enabled allows the Expressions to change automatically based on the sentiment expressed in the AI's most recent chat response.

# Setup Instructions (Offline Mode without Extras)

Open the Extensions Panel and expand the 'Expression images' section (the section will only show up when you have a character selected). You will see a grid of image placeholders.

Expression Drawer
Click the 'import' button at the top left of each image in the grid, and select the image you want to apply to that emotion. This will save the image with the correct filename inside the /public/characters/(character_name_here)/ folder.
To show the image in your SillyTavern window, click the image in the grid after it has been uploaded.

# Setup Instructions (with Extras)

Have Extras installed and running with the classify module enabled: python server.py --enable-modules=classify
Import the expression images the same way as mentioned above.
The appropriate expression image will display automatically whenever the AI sends you a response.

# How do I get more expression options?

By default we use a classification model with 6 options nateraw/bert-base-uncased-emotion

There is also a model with 28 options: : joeddav/distilbert-base-uncased-go-emotions-student

To use this model you need to change your Extras command line to include the following argument (with a space before and after):

--classification-model=joeddav/distilbert-base-uncased-go-emotions-student

# How does the classify module work?

The classify module uses a small 'sentiment parsing' model that runs on the SillyTavern Extras host machine (eg. on your PC, or on the colab machine). This model takes the new output from the AI and detects what kind of sentiment, or emotion, the text is expressing. While multiple sentiments may be expressed in a single message, the model only picks the most likely one and returns that back to the Extras server. The Extras server then displays the image that is associated with that sentiment.

# What image formats are supported for Expressions?

Any image format is allowed, including webp and animated gifs.

The most common format is a PNG file with a transparent background.

# Using the 'default expressions'

(This feature will only activate if Extras is running. There is no way to manually display default expression images.)

If you don't have custom expression images for a character, you can use the built-in default expressions which are included with the base SillyTavern installation. These are simple emoji style images. Just click the checkbox at the bottom of the Expression images section inside the Extension panel. Default expressions will work alongside any available custom Expressions, and will display in cases when your custom image set is any missing images for a particular emotion.

# Importing an Expression images zip file

Using the 'import ZIP' button, you can import a zip file which contains a collection of expression images, and those images will automatically be added into the correct folder for your currently selected character. The zip file must have a flat internal structure (no subfolders) and the individual images should be named correctly. Importing a zip will not automatically rename any images to make them match the emotions.

# Limitations

# Display names (not character card filenames) dictate which image set is used

If you have more than one character with the same display name, they will both use the same set of expression images.

If you want a different image set to be used for each version of the same-named character, you must change the display name of one of them, and provide the alternate expression images in a folder with the new display name.