Skip to content

Commit

Permalink
Bring main page up to speed
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cohee1207
Cohee1207 committed Sep 15, 2024
1 parent 8275314 commit eebb033
Showing 1 changed file with 54 additions and 52 deletions.
106 changes: 54 additions & 52 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,89 +2,91 @@

![SillyTavern - LLM Frontend for Power Users](/static/banner.jpg)

Brought to you by Cohee, RossAscends, and the SillyTavern community, SillyTavern is a local-install interface that allows you to interact with text generation AIs (LLMs) to chat and roleplay with custom characters.
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.

SillyTavern originated as a modification of TavernAI 1.2.8 in February 2023, and has since added many cutting-edge features not present in the original TavernAI.
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 enthusiasts.

### 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).

### Screenshots
## Screenshots

| ![VN Mode](/static/screenshot1.jpg) | ![Character Management](/static/screenshot2.jpg) |
|:---:|:---:|
| ![Advanced Formatting](/static/screenshot3.jpg) | ![Slash Commands](/static/screenshot4.jpg) |
| ![Extensions](/static/screenshot5.jpg) | ![Response Config](/static/screenshot6.jpg) |
| ![Backgrounds](/static/screenshot7.jpg) | ![User Settings](/static/screenshot8.jpg) |

### Branches
## Branches

SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users.

* 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.
* 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.
* `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.
* `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.

Learn more [here](https://docs.sillytavern.app/usage/branches/).

### Features
## Character Cards

SillyTavern is built around the concept of "character cards". A character card is a collection of prompts that set the behavior of the LLM and is required to have persistent conversations in SillyTavern. They function similarly to ChatGPT's GPTs or Poe's bots. The content of a character card can be anything: an abstract scenario, an assistant tailored for a specific task, a famous personality or a fictional character.

The name field is the only required character card input. To start a neutral conversation with the language model, create a new card simply called "Assistant" and leave the rest of the boxes blank. For a more themed chat, you can provide the language model with various background details, behavior and writing patterns, and a scenario to jump start the chat.

<!-- To have a quick conversation without selecting a character card or to just test the LLM connection, simply type your prompt input into the input bar on the Welcome Screen after opening SillyTavern. Please note that such chats are temporary and will not be saved. -->

To get a general idea on how to define character cards, see the default character (Seraphina) or download selected community-made cards from the "Download Extensions & Assets" menu.

* Mobile-friendly interface
* Multiple backend API connectivity ([KoboldAI](https://github.com/KoboldAI/KoboldAI-Client), [KoboldCpp](https://github.com/LostRuins/koboldcpp), [AI Horde](https://horde.koboldai.net/), [NovelAI](https://github.com/LostRuins/koboldcpp), [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui), [OpenAI](https://chat.openai.com/), [WindowAI](https://windowai.io), [OpenRouter](https://openrouter.ai/), [TabbyAPI](https://github.com/theroyallab/tabbyAPI), and many more...). See [API connections](https://docs.sillytavern.app/usage/api-connections/).
* Visual Novel-like Waifu Mode
* Horde Stable Diffusion generation
* TTS support (ElevenLabs, Silero, etc.)
* WorldInfo (lorebooks)
* Author's Note / Character Bias
* Customizable colors, backgrounds, avatar styles, and UI panel placement
* Notification sound for AI responses
* Export chats as .txt files
* Auto-translate single messages or the entire chat via Google API, even automatically.
* Extensive prompt formatting options
* Character HotSwap buttons to quickly change between your favorite characters
* Prompt token breakdown view for each message
* Swipes
* Group chats: multi-bot rooms for characters to talk to you or each other
* Chat bookmarks / branching
## Key Features

### Extensions
* Advanced [text generation settings](/Usage/Core%20Concepts/advancedformatting.md) with many community-made presets
* [World Info support](/Usage/Core%20Concepts/worldinfo.md): create rich lore or save tokens on your character card
* [Group chats](/Usage/Core%20Concepts/groupchats.md): multi-bot rooms for characters to talk to you and/or each other
* [Rich UI customization options](/Usage/Core%20Concepts/uicustomization.md): theme colors, background images, custom CSS, and more
* [User personas](/Usage/Core%20Concepts/personas.md): let the AI know a bit about you for greater immersion
* [Built-in RAG support](/Usage/Core%20Concepts/Data%20Bank.md): add documents to your chats for the AI to reference

SillyTavern supports extensions/plugins:
## Extensions

* Character emotional expressions
* Auto-Summary of the chat history
* Sending images to chat, and the AI interpreting the content.
* Stable Diffusion image generation (5 chat-related presets plus 'free mode')
* Text-to-speech for AI response messages (via ElevenLabs, Silero, or the OS's System TTS)
SillyTavern has extensibility support.

Additional functionality can be added by using [SillyTavern Extras](https://github.com/SillyTavern/SillyTavern-extras).
* [Character emotional expressions (sprites)](/extensions/Expression-Images.md)
* [Auto-Summary of the chat history](/extensions/Summarize.md)
* Automatic UI and chat translation
* [Stable Diffusion/FLUX/DALL-E image generation](/extensions/Stable-Diffusion.md)
* [Text-to-speech for AI response messages (via ElevenLabs, Silero, or the OS's System TTS)](/extensions/TTS.md)
* [Web Search capabilities for adding additional real world context to your prompts](/extensions/WebSearch.md)
* Many more are available to download from the "Download Extensions & Assets" menu.

<!--
### Screenshots
## Installation Requirements

![](https://user-images.githubusercontent.com/18619528/228649245-8061c60f-63dc-488e-9325-f151b7a3ec2d.png)
![](https://user-images.githubusercontent.com/18619528/228649856-fbdeef05-d727-4d5a-be80-266cbbc6b811.png)
-->
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.

### Installation Requirements
Follow the installation guide for your platform:

* SillyTavern will run on virtually any device capable of running NodeJS v18.
* NOTE: due to the above requirement, **SillyTavern will not run on Windows 7.**
* [Windows](https://docs.sillytavern.app/installation/windows/)
* [Linux and Mac](https://docs.sillytavern.app/installation/linuxmacos/)
* [Android](https://docs.sillytavern.app/installation/android-(termux)/)
* [Docker](https://docs.sillytavern.app/installation/docker/)

### What do I need other than SillyTavern?
## What do I need other than SillyTavern?

SillyTavern is only a frontend interface, so you will need to have access to one of the backend APIs listed above.
Since SillyTavern is only an interface, you will need access to an LLM backend to provide inference. You can use AI Horde for instant out-of-the-box chatting. Aside from that, we support many other local and cloud-based LLM backends: OpenAI-compatible API, KoboldAI, Tabby, and many more. You can read more about our supported APIs in the [API Connections](https://docs.sillytavern.app/usage/api-connections/) section.

### How can I get in touch with the developers directly?
## How can I get in touch with the developers directly?

* Discord: cohee or rossascends
* Reddit: /u/RossAscends or /u/sillylossy
* Discord: cohee, rossascends, wolfsblvt
* Reddit: [/u/RossAscends](https://www.reddit.com/user/RossAscends/), [/u/sillylossy](https://www.reddit.com/user/sillylossy/), [u/Wolfsblvt](https://www.reddit.com/user/Wolfsblvt/)
* [Post a GitHub issue](https://github.com/SillyTavern/SillyTavern/issues)

### I like your project! How do I contribute?
## I like your project! How do I contribute?

* We welcome pull requests!
* We welcome pull requests! Follow the [Contribution Guidelines](https://github.com/SillyTavern/SillyTavern/blob/release/CONTRIBUTING.md) to get started.
* We also welcome helpful and informed bug reports that use the templates provided in our GitHub.
* We do not accept monetary donations for the project itself.
* Cohee does not take donations.

## Personal Donations

Your support for individual contributors is appreciated, but it will not influence the overall development direction of SillyTavern.

* RossAscends has a personal [Patreon](https://www.patreon.com/RossAscends) & [Kofi](https://ko-fi.com/rossascends)

## License

SillyTavern is a free and open-source project released under the [AGPL-3.0 License](https://github.com/SillyTavern/SillyTavern/blob/release/LICENSE).

0 comments on commit eebb033

Please sign in to comment.