SillyTavern README

The project's README from github.com/SillyTavern/SillyTavern. As one markdown file: README.md.

English | German | 中文 | 繁體中文 | 日本語 | Русский | 한국어

GitHub Stars GitHub Forks GitHub Issues GitHub Pull Requests


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.

We have a Documentation website to answer most of your questions and help you get started.

What is SillyTavern?

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.

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.

Our Vision

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

Do I need a powerful PC to run SillyTavern?

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.

Questions or suggestions?

Discord server

Join our Discord community! Get support, share favorite characters and prompts.

Or get in touch with the developers directly:

I like your project! How do I contribute?

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

Screenshots

image image

Installation

For detailed installation instructions, please visit our documentation:

License and credits

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

Top Contributors

Contributors

SillyTavern (SillyTavern/SillyTavern)

Searching Database…

这是什么?SillyTavern 是一款安装在本地的用户界面,用于与文本生成类 LLM、图像生成引擎和 TTS 语音模型进行交互。它将众多 LLM 接口(KoboldAI、Horde、NovelAI、Ooba、Tabby、OpenAI、OpenRouter、Claude、Mistral 等)统一到一个前端中,专为角色扮演和提示词调试而打造。
这是一个聊天机器人应用,还是只是我用来连接其他服务的前端?它只是一个前端:SillyTavern 本身不运行任何模型,也不提供托管服务。你需要将它连接到实际生成文本、图像或语音的后端(本地或基于 API 的)。
我该如何让它运行起来?请按照文档中对应平台的安装指南进行操作:Windows、MacOS/Linux、Android(Termux)或 Docker。安装完成后,用 Node 运行 `node server.js`,它会提供一个本地网页界面。
运行前我需要先安装什么?只需 NodeJS 20 或更高版本,除此之外对硬件的要求很低。
我上手难度大吗?是的,这是有意为之——项目着重开放大量提示词和配置选项,而不是为了照顾普通用户而把一切都简化。
我能在手机上运行它吗?它有适合手机的界面布局,并提供官方的 Android 安装指南(通过 Termux),此外还有 Windows、macOS、Linux 和 Docker 的安装指南。
SillyTavern 会追踪我的数据或把数据发送到别处吗?不会——它在本地运行,项目明确声明不提供任何在线或托管服务,也不追踪用户数据。
什么是“Visual Novel Mode”?一种受视觉小说游戏启发的显示模式,聊天时会显示角色立绘和背景,而不是单纯的聊天记录。
它能生成图像和语音,而不只是文字吗?可以——它集成了 Automatic1111 和 ComfyUI 用于图像生成,并支持 TTS 语音输出,与文字聊天同时使用。
什么是“lorebooks(世界书)”?它们是 SillyTavern 的 WorldInfo 功能:可自定义的背景或上下文条目,会被注入到提示词中,让角色和设定拥有持久的背景设定。
我能用插件扩展它吗?可以,SillyTavern 支持第三方扩展,除内置功能外还有无限的扩展潜力。
What are similar projects?wanwan, ChatTTS, LibreChat, unsloth, AstrBot, G0DM0D3, kirara-ai, ODS
Size
210.6 MB
Stars
34.6K
Age
3y
Commits · 90 Days