1
<a name="readme-top"></a>
2

3
![][cover]
4

5
<div align="center">
6

7
English | [German](readme-de_de.md) | [中文](readme-zh_cn.md) | [繁體中文](readme-zh_tw.md) | [日本語](readme-ja_jp.md) | [Русский](readme-ru_ru.md) | [한국어](readme-ko_kr.md)
8

9
[![GitHub Stars](https://img.shields.io/github/stars/SillyTavern/SillyTavern.svg)](https://github.com/SillyTavern/SillyTavern/stargazers)
10
[![GitHub Forks](https://img.shields.io/github/forks/SillyTavern/SillyTavern.svg)](https://github.com/SillyTavern/SillyTavern/forks)
11
[![GitHub Issues](https://img.shields.io/github/issues/SillyTavern/SillyTavern.svg)](https://github.com/SillyTavern/SillyTavern/issues)
12
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/SillyTavern/SillyTavern.svg)](https://github.com/SillyTavern/SillyTavern/pulls)
13

14
</div>
15

16
---
17

18
SillyTavern provides a single unified interface for many LLM APIs (KoboldAI/CPP, Horde, NovelAI, Ooba, Tabby, OpenAI, OpenRouter, Claude, Mistral and more), a mobile-friendly layout, Visual Novel Mode, Automatic1111 & ComfyUI API image generation integration, TTS, WorldInfo (lorebooks), customizable UI, auto-translate, more prompt options than you'd ever want or need, and endless growth potential via third-party extensions.
19

20
We have a [Documentation website](https://docs.sillytavern.app/) to answer most of your questions and help you get started.
21

22
## What is SillyTavern?
23

24
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.
25

26
Beginning in February 2023 as a fork of TavernAI 1.2.8, SillyTavern now has over 300 contributors and 3 years of independent development under its belt, and continues to serve as a leading software for savvy AI hobbyists.
27

28
## Our Vision
29

30
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!
31
2. We do not provide any online or hosted services, nor programmatically track any user data.
32
3. SillyTavern is a passion project brought to you by a dedicated community of LLM enthusiasts, and will always be free and open sourced.
33

34
## Do I need a powerful PC to run SillyTavern?
35

36
The hardware requirements are minimal: it will run on anything that can run NodeJS 20 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, but actual requirements may vary depending on the model and backend you choose to use.
37

38
## Questions or suggestions?
39

40
### Discord server
41

42
| [![][discord-shield-badge]][discord-link] | [Join our Discord community!](https://discord.gg/sillytavern) Get support, share favorite characters and prompts. |
43
| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
44

45
Or get in touch with the developers directly:
46

47
* Discord: cohee, rossascends, wolfsblvt
48
* 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/)
49
* [Post a GitHub issue](https://github.com/SillyTavern/SillyTavern/issues)
50

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

53
1. Send pull requests. Learn how to contribute: [CONTRIBUTING.md](../CONTRIBUTING.md)
54
2. Send feature suggestions and issue reports using the provided templates.
55
3. Read this entire readme file and check the documentation website first, to avoid sending duplicate issues.
56

57
## Screenshots
58

59
<img width="500" alt="image" src="https://github.com/user-attachments/assets/9b5f32f0-c3b3-4102-b3f5-0e9213c0f50f">
60
<img width="500" alt="image" src="https://github.com/user-attachments/assets/913fdbaa-7d33-42f1-ae2c-89dca41c53d1">
61

62
## Installation
63

64
For detailed installation instructions, please visit our documentation:
65

66
* **[Windows Installation Guide](https://docs.sillytavern.app/installation/windows/)**
67
* **[MacOS/Linux Installation Guide](https://docs.sillytavern.app/installation/linuxmacos/)**
68
* **[Android (Termux) Installation Guide](https://docs.sillytavern.app/installation/android-(termux)/)**
69
* **[Docker Installation Guide](https://docs.sillytavern.app/installation/docker/)**
70

71
## License and credits
72

73
**This program is distributed in the hope that it will be useful,
74
but WITHOUT ANY WARRANTY; without even the implied warranty of
75
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
76
GNU Affero General Public License for more details.**
77

78
* [TavernAI](https://github.com/TavernAI/TavernAI) 1.2.8 by Humi: MIT License
79
* Portions of CncAnon's TavernAITurbo mod used with permission
80
* Visual Novel Mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>)
81
* Noto Sans font by Google (OFL license)
82
* Lexer/Parser by Chevrotain (Apache-2.0 license) <https://github.com/chevrotain/chevrotain>
83
* Icon theme by Font Awesome <https://fontawesome.com> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
84
* Default content by @OtisAlejandro (Seraphina character and lorebook) and @kallmeflocc (10K Discord Users Celebratory Background)
85
* Docker guide by [@mrguymiah](https://github.com/mrguymiah) and [@Bronya-Rand](https://github.com/Bronya-Rand)
86
* kokoro-js library by [@hexgrad](https://github.com/hexgrad) (Apache-2.0 License)
87

88
## Top Contributors
89

90
[![Contributors](https://contrib.rocks/image?repo=SillyTavern/SillyTavern)](https://github.com/SillyTavern/SillyTavern/graphs/contributors)
91

92
<!-- LINK GROUP -->
93
[cover]: https://github.com/user-attachments/assets/01a6ae9a-16aa-45f2-8bff-32b5dc587e44
94
[discord-link]: https://discord.gg/sillytavern
95
[discord-shield-badge]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge