Spaces:
Build error
Build error
teralomaniac
commited on
Commit
•
70023bd
1
Parent(s):
e71c1c7
This view is limited to 50 files because it contains too many changes.
See raw diff
- .dockerignore +8 -0
- .editorconfig +11 -0
- .github/ISSUE_TEMPLATE/bug_report.md +45 -0
- .github/ISSUE_TEMPLATE/feature_request.md +23 -0
- .github/readme-zh_cn.md +309 -0
- .github/readme.md +312 -0
- .github/workflows/build-and-publish-release.yml +37 -0
- .github/workflows/build-and-publish-staging.yml +37 -0
- .github/workflows/npm-publish.yml +32 -0
- .github/workflows/update-docs.yml +43 -0
- .gitignore +31 -0
- .npmignore +7 -0
- .replit +81 -0
- Dockerfile +51 -0
- LICENSE +661 -0
- Remote-Link.cmd +18 -0
- Start.bat +5 -0
- Update-Instructions.txt +59 -0
- UpdateAndStart.bat +17 -0
- colab/GPU.ipynb +152 -0
- default/bg_load.css +1 -0
- default/config.conf +31 -0
- default/content/Eldoria.json +71 -0
- default/content/Seraphina/admiration.png +0 -0
- default/content/Seraphina/amusement.png +0 -0
- default/content/Seraphina/anger.png +0 -0
- default/content/Seraphina/annoyance.png +0 -0
- default/content/Seraphina/approval.png +0 -0
- default/content/Seraphina/caring.png +0 -0
- default/content/Seraphina/confusion.png +0 -0
- default/content/Seraphina/curiosity.png +0 -0
- default/content/Seraphina/desire.png +0 -0
- default/content/Seraphina/disappointment.png +0 -0
- default/content/Seraphina/disapproval.png +0 -0
- default/content/Seraphina/disgust.png +0 -0
- default/content/Seraphina/embarrassment.png +0 -0
- default/content/Seraphina/excitement.png +0 -0
- default/content/Seraphina/fear.png +0 -0
- default/content/Seraphina/gratitude.png +0 -0
- default/content/Seraphina/grief.png +0 -0
- default/content/Seraphina/joy.png +0 -0
- default/content/Seraphina/love.png +0 -0
- default/content/Seraphina/nervousness.png +0 -0
- default/content/Seraphina/neutral.png +0 -0
- default/content/Seraphina/optimism.png +0 -0
- default/content/Seraphina/pride.png +0 -0
- default/content/Seraphina/realization.png +0 -0
- default/content/Seraphina/relief.png +0 -0
- default/content/Seraphina/remorse.png +0 -0
- default/content/Seraphina/sadness.png +0 -0
.dockerignore
ADDED
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
.git
|
2 |
+
node_modules
|
3 |
+
npm-debug.log
|
4 |
+
readme*
|
5 |
+
Start.bat
|
6 |
+
/dist
|
7 |
+
/backups/
|
8 |
+
cloudflared.exe
|
.editorconfig
ADDED
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
root = true
|
2 |
+
|
3 |
+
[*]
|
4 |
+
end_of_line = lf
|
5 |
+
insert_final_newline = true
|
6 |
+
trim_trailing_whitespace = true
|
7 |
+
|
8 |
+
[*.{js, conf, json}]
|
9 |
+
charset = utf-8
|
10 |
+
indent_style = space
|
11 |
+
indent_size = 4
|
.github/ISSUE_TEMPLATE/bug_report.md
ADDED
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
name: Bug report
|
3 |
+
about: "Create a report to help us improve. PAY ATTENTION: Support requests for external programs (reverse proxies, 3rd party servers, other peoples' forks) will be refused!"
|
4 |
+
title: "[BUG]"
|
5 |
+
labels: ''
|
6 |
+
assignees: ''
|
7 |
+
|
8 |
+
---
|
9 |
+
|
10 |
+
> **Warning**. Complete **all** the fields below. Otherwise, your bug report will be **ignored**!
|
11 |
+
|
12 |
+
**Have you searched for similar [bugs](https://github.com/SillyTavern/SillyTavern/issues?q=)?**
|
13 |
+
Yes/No
|
14 |
+
|
15 |
+
**Describe the bug**
|
16 |
+
A clear and concise description of what the bug is.
|
17 |
+
|
18 |
+
**To Reproduce**
|
19 |
+
Steps to reproduce the behavior:
|
20 |
+
1. Go to '...'
|
21 |
+
2. Click on '....'
|
22 |
+
3. Scroll down to '....'
|
23 |
+
4. See error
|
24 |
+
|
25 |
+
**Expected behavior**
|
26 |
+
A clear and concise description of what you expected to happen.
|
27 |
+
|
28 |
+
**Screenshots**
|
29 |
+
If applicable, add screenshots to help explain your problem.
|
30 |
+
|
31 |
+
**Logs**
|
32 |
+
|
33 |
+
Providing the logs from the browser DevTools console (opened by pressing the F12 key) or SillyTavern command line window will be highly appreciated.
|
34 |
+
|
35 |
+
**Desktop (please complete the following information):**
|
36 |
+
- OS/Device: [e.g. Windows 11]
|
37 |
+
- Environment: [cloud, local]
|
38 |
+
- Node.js version (if applicable): [run `node --version` in cmd]
|
39 |
+
- Browser [e.g. chrome, safari]
|
40 |
+
- Generation API [e.g. KoboldAI, OpenAI]
|
41 |
+
- Branch [staging, release]
|
42 |
+
- Model [e.g. Pygmalion 6b, LLaMa 13b]
|
43 |
+
|
44 |
+
**Additional context**
|
45 |
+
Add any other context about the problem here.
|
.github/ISSUE_TEMPLATE/feature_request.md
ADDED
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
name: Feature request
|
3 |
+
about: Suggest an idea for this project
|
4 |
+
title: "[Feature Request] "
|
5 |
+
labels: ''
|
6 |
+
assignees: ''
|
7 |
+
|
8 |
+
---
|
9 |
+
|
10 |
+
**Have you searched for similar [requests](https://github.com/SillyTavern/SillyTavern/issues?q=)?**
|
11 |
+
Yes/No
|
12 |
+
|
13 |
+
**Is your feature request related to a problem? Please describe.**
|
14 |
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
15 |
+
|
16 |
+
**Describe the solution you'd like**
|
17 |
+
A clear and concise description of what you want to happen.
|
18 |
+
|
19 |
+
**Describe alternatives you've considered**
|
20 |
+
A clear and concise description of any alternative solutions or features you've considered.
|
21 |
+
|
22 |
+
**Additional context**
|
23 |
+
Add any other context or screenshots about the feature request here.
|
.github/readme-zh_cn.md
ADDED
@@ -0,0 +1,309 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
[English](readme.md) | 中文
|
2 |
+
|
3 |
+
![image](https://github.com/SillyTavern/SillyTavern/assets/18619528/8c41a061-7f72-4d2b-9d54-e6d058209e7b)
|
4 |
+
|
5 |
+
移动设备界面友好,多种人工智能服务或模型支持(KoboldAI/CPP, Horde, NovelAI, Ooba, OpenAI, OpenRouter, Claude, Scale),类似 Galgame 的 老 婆 模 式,Horde SD,文本系统语音生成,世界信息(Lorebooks),可定制的界面,自动翻译,和比你所需要的更多的 Prompt。附带扩展服务,支持文本绘画生成与语音生成和基于向量数据库 ChromaDB 的聊天信息总结。
|
6 |
+
|
7 |
+
基于 TavernAI 1.2.8 的分叉版本
|
8 |
+
|
9 |
+
### 由 Cohee、RossAscends 和 SillyTavern 社区为您呈现
|
10 |
+
|
11 |
+
注意:我们创建了一个 [帮助文档](https://docs.sillytavern.app/) 网站来回答各类问题与帮助您开始使用。
|
12 |
+
|
13 |
+
### SillyTavern 或 TavernAI 是什么?
|
14 |
+
|
15 |
+
SillyTavern 是一个可以安装在电脑(和安卓手机)上的用户界面,让您可以与文本生成的人工智能互动,并与您或社区创建的角色聊天/玩角色扮演游戏。
|
16 |
+
|
17 |
+
SillyTavern 是 TavernAI 1.2.8 的一个分支,正在进行更积极地开发,并添加了许多重要功能。在这一点上,它可以被视为完全独立的程序。
|
18 |
+
|
19 |
+
### 分支
|
20 |
+
|
21 |
+
SillyTavern 采用双分支进行开发,以确保所有用户都能获得流畅的使用体验。
|
22 |
+
|
23 |
+
* release -🌟 **推荐给大多数用户。** 这是最稳定、最推荐的分支,只有在重大版本推送时才会更新。适合大多数用户使用。
|
24 |
+
* staging - ⚠️ **不建议随意使用。** 该分支拥有最新功能,但要谨慎,因为它随时可能崩溃。仅适用于高级用户和爱好者。
|
25 |
+
|
26 |
+
如果你不熟悉使用 Git 命令,或者不了解什么是分支,别担心!release 分支始终是您的首选。
|
27 |
+
|
28 |
+
### 除了 SillyTavern,我还需要什么?
|
29 |
+
|
30 |
+
SillyTavern 本身并无用处,因为它只是一个用户聊天界面。你必须接入一个能充当角色扮演的人工智能系统。支持的人工智能系统有多种:OpenAPI API (GPT)、KoboldAI(可在本地或 Google Colab 上运行)等。您可以在 [常见问题](https://docs.sillytavern.app/usage/faq/) 中阅读更多相关信息。
|
31 |
+
|
32 |
+
### 我需要一台性能强大的电脑来运行 SillyTavern 吗?
|
33 |
+
|
34 |
+
由于 SillyTavern 只是一个用户聊天界面,它对硬件性能的要求很低,可以在任何电脑上运行。需要强大性能的是人工智能系统。
|
35 |
+
|
36 |
+
### 移动设备支持
|
37 |
+
|
38 |
+
> 注意
|
39 |
+
|
40 |
+
> **此分叉可使用 Termux 在安卓手机上原生运行。请参考 ArroganceComplex#2659 编写的指南:**
|
41 |
+
|
42 |
+
<https://rentry.org/STAI-Termux>
|
43 |
+
|
44 |
+
Termux 不支持**.Webp 字符卡的导入/导出。请使用 JSON 或 PNG 格式**。
|
45 |
+
|
46 |
+
## 有问题或建议?
|
47 |
+
|
48 |
+
### 我们现在有了 Discord 社区
|
49 |
+
|
50 |
+
获取支持,或分享喜爱的角色和 Prompt:
|
51 |
+
|
52 |
+
### [加入 Discord 社区](https://discord.gg/RZdyAEUPvj)
|
53 |
+
|
54 |
+
***
|
55 |
+
|
56 |
+
直接与开发人员联系:
|
57 |
+
|
58 |
+
* Discord: cohee 或 rossascends
|
59 |
+
* Reddit:/u/RossAscends 或 /u/sillylossy
|
60 |
+
* [发布 GitHub 问题](https://github.com/SillyTavern/SillyTavern/issues)
|
61 |
+
|
62 |
+
## 此版本包括
|
63 |
+
|
64 |
+
* 经过大量修改的 TavernAI 1.2.8(超过 50% 的代码经过重写或优化)
|
65 |
+
* 根据自定义规则自动重新生成消息
|
66 |
+
* 群聊:多机器人房间,供角色与你或彼此交谈
|
67 |
+
* 聊天书签/分支(复制当前状态下的对话)
|
68 |
+
* 先进的 KoboldAI / TextGen 生成设置,包含大量社区预设
|
69 |
+
* 支持世界信息(Lorebooks):创建丰富的传说
|
70 |
+
* 支持 Window AI 浏览器扩展(运行 Claude、GPT 4 等模型):<https://windowai.io/>
|
71 |
+
* [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui) API 连接
|
72 |
+
* 连接 [AI Horde](https://horde.koboldai.net/)
|
73 |
+
* Prompt 生成格式调整
|
74 |
+
* Webp 角色卡支持(PNG 仍是内部格式)
|
75 |
+
|
76 |
+
## 扩展
|
77 |
+
|
78 |
+
SillyTavern 支持扩展服务,一些额外的人工智能模块可通过 [SillyTavern Extras API](https://github.com/SillyTavern/SillyTavern-extras) 提供。
|
79 |
+
|
80 |
+
* 作者注释/角色偏见
|
81 |
+
* 角色情绪识别
|
82 |
+
* 聊天记录自动摘要
|
83 |
+
* 在聊天窗口发送图片,并由人工智能解释图片内容
|
84 |
+
* 文本图像生成(5 预设,以及 "自由模式")
|
85 |
+
* 聊天信息的文字转语音(通过 ElevenLabs、Silero 或操作系统的语音生成)
|
86 |
+
* ChromaDB 向量数据库,用于更智能的聊天 Prompt
|
87 |
+
|
88 |
+
扩展服务的完整功能介绍和使用教程,请参阅 [Docs](https://docs.sillytavern.app/extras/extensions/)。
|
89 |
+
|
90 |
+
## 界面/CSS/性能,由 RossAscends 调整并优化
|
91 |
+
|
92 |
+
* 针对 iOS 系统优化了界面,并支持将快捷方式保存到主屏幕,在全屏模式下打开。
|
93 |
+
* 热键
|
94 |
+
* 上 = 编辑聊天中的最后一条信息
|
95 |
+
* Ctrl+P = 编辑聊天中最后一条用户信息
|
96 |
+
* 左 = 向左滑动
|
97 |
+
* 右 = 向右滑动(注意:当聊天窗口输入内容时,轻扫快捷键将被禁用)
|
98 |
+
* Ctrl+左 = 查看本地存储的变量(在浏览器控制台窗口中)
|
99 |
+
* 回车(选择聊天栏)= 向人工智能发送���息
|
100 |
+
* Ctrl+Enter = 重新生成人工智能最后的回复
|
101 |
+
|
102 |
+
* 用户名更改和角色删除不再强制重新刷新页面。
|
103 |
+
|
104 |
+
* 增加在页面加载时自动连接 API 的选项。
|
105 |
+
* 增加选项,在页面加载时自动加载最近的聊天信息。
|
106 |
+
* 更好的 Tokens 计算器 - 适用于未保存的文字,并显示永久和临时 Tokens 数量
|
107 |
+
|
108 |
+
* 更好的聊天历史查询窗口
|
109 |
+
* 聊天的文件名以"(角色卡名称)+(创建时间)"的可读格式保存
|
110 |
+
* 聊天历史预览从 40 个字符增加到 300 个字符。
|
111 |
+
* 聊天历史排序有多种选择(按名称、创建日期、聊天记录大小)。
|
112 |
+
|
113 |
+
* 默认情况下,左侧和右侧弹出的设置面板会在点击其他区域时自动关闭。
|
114 |
+
* 点击导航面板上的 "锁按钮" 将保持弹出面板打开,并在不同聊天中记住此设置。
|
115 |
+
* 导航面板的打开或关闭状态也会跨聊天保存。
|
116 |
+
|
117 |
+
* 自定义聊天界面:
|
118 |
+
* 收到新消息时播放提示音
|
119 |
+
* 切换圆形或长方形头像样式
|
120 |
+
* 在台式电脑上拥有更宽的聊天窗口
|
121 |
+
* 可选的半透明玻璃效果聊天窗口
|
122 |
+
* 可定制 "主文本"、"引用文本 "和 "斜体文本 "的字体颜色。
|
123 |
+
* 可定制聊天界面的背景颜色和透明模糊程度
|
124 |
+
|
125 |
+
## 安装
|
126 |
+
|
127 |
+
*注意:SillyTavern 用于本地安装,尚未在 Colab 或其他云服务上进行全面测试。
|
128 |
+
|
129 |
+
> **警告**
|
130 |
+
|
131 |
+
> 切勿安装到任何受 Windows 控制的系统文件夹(Program Files, System32, etc)中。
|
132 |
+
|
133 |
+
> 不要以管理员权限运行 start.bat
|
134 |
+
|
135 |
+
### Windows
|
136 |
+
|
137 |
+
通过 Git 安装(推荐使用,便于更新)
|
138 |
+
|
139 |
+
附有精美图片示例的简易指南:
|
140 |
+
<https://docs.sillytavern.app/installation/windows/>
|
141 |
+
|
142 |
+
1. 安装 [NodeJS](https://nodejs.org/en)(建议使用最新的 LTS 版本)
|
143 |
+
2. 安装 [GitHub 客户端](https://central.github.com/deployments/desktop/desktop/latest/win32)
|
144 |
+
3. 打开 Windows 资源管理器 (`Win+E`)
|
145 |
+
4. 浏览或创建一个不受 Windows 控制或监控的文件夹。(例如:C:\MySpecialFolder\)
|
146 |
+
5. 点击顶部的 "地址栏",在该文件夹内打开命令提示符,输入 `cmd`,然后按回车。
|
147 |
+
6. 弹出黑框(CMD 命令提示符)后,键入以下其中一项并按 Enter:
|
148 |
+
|
149 |
+
* 稳定分支:`git clone https://github.com/SillyTavern/SillyTavern -b release`
|
150 |
+
* 开发分支: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
|
151 |
+
|
152 |
+
7. 等待 Git 克隆完成后,双击文件夹中的 `Start.bat` 将启动 NodeJS 并开始自动安装需要的软件包。
|
153 |
+
8. 然后 SillyTavern 服务就会自动启动,同时在浏览器新标签页中自动打开。
|
154 |
+
|
155 |
+
通过压缩包下载安装(不推荐)
|
156 |
+
|
157 |
+
1. 安装 [NodeJS](https://nodejs.org/en)(建议使用最新的 LTS 版本)
|
158 |
+
2. 从该 GitHub 仓库下载压缩包。(从 [Releases](https://github.com/SillyTavern/SillyTavern/releases/latest) 获取 "Source code(zip)")。
|
159 |
+
3. 将压缩包解压到您选择的文件夹中
|
160 |
+
4. 双击或在命令行中运行 `Start.bat`。
|
161 |
+
5. SillyTavern 服务自动为你准备好一切后,会在你的浏览器中打开一个新标签页。
|
162 |
+
|
163 |
+
### Linux
|
164 |
+
|
165 |
+
1.运行 `start.sh` 脚本。
|
166 |
+
2.等待自动完成,然后开始享受
|
167 |
+
|
168 |
+
## API 密钥管理
|
169 |
+
|
170 |
+
SillyTavern 会将 API 密钥保存在目录中的 `secrets.json` 文件内。
|
171 |
+
|
172 |
+
默认情况下,输入密钥并重新加载页面后,密钥会自动隐藏以保证安全。
|
173 |
+
|
174 |
+
如果要想通过点击 API 输入框旁边的按钮来查看密钥,请按照以下设置:
|
175 |
+
|
176 |
+
1. 打开 `config.conf` 文件,将里面的 `allowKeysExposure` 设置为 `true`。
|
177 |
+
2. 然后重启 SillyTavern 服务。
|
178 |
+
|
179 |
+
## 远程访问
|
180 |
+
|
181 |
+
这通常是为那些想在手机上使用 SillyTavern 的人准备的,而他们的电脑和手机在同一个局域网中。
|
182 |
+
|
183 |
+
不过,SillyTavern 也可以被设置为允许从任何地方进行远程访问。
|
184 |
+
|
185 |
+
**重要提示:SillyTavern 是单用户程序,因此任何人登录后都能看到所有的角色卡和聊天内容,并能更改任何设置。
|
186 |
+
|
187 |
+
### 1.管理白名单 IP
|
188 |
+
|
189 |
+
* 在你的 SillyTavern 文件夹中新建一个文本文件,名为 `whitelist.txt`。
|
190 |
+
* 用文本编辑器打开该文件,添加你希望允许连接的 IP 地址列表。
|
191 |
+
* 接受单个 IP 地址和 IP 范围,示例:
|
192 |
+
|
193 |
+
```
|
194 |
+
192.168.0.1
|
195 |
+
192.168.0.20
|
196 |
+
```
|
197 |
+
|
198 |
+
或者
|
199 |
+
|
200 |
+
```
|
201 |
+
192.168.0.*
|
202 |
+
```
|
203 |
+
|
204 |
+
(上述 IP 范围将允许局域网中的任何设备连接)
|
205 |
+
|
206 |
+
也接受子网掩码设置(如 10.0.0.0/24)。
|
207 |
+
|
208 |
+
* 保存`whitelist.txt`文件。
|
209 |
+
* 重启 SillyTavern 服务。
|
210 |
+
|
211 |
+
然后,文件中设置的 IP 就可以访问 SillyTavern 了。
|
212 |
+
|
213 |
+
*注意:"config.conf" 文件内也有一个 "whitelist" 设置,你可以用同样的方法设置它,但如果 "whitelist.txt" 文件存在,这个设置将被忽略。
|
214 |
+
|
215 |
+
### 2.获取 SillyTavern 服务的 IP 地址
|
216 |
+
|
217 |
+
白名单设置完成后,您需要 SillyTavern 服务的 IP 地址。
|
218 |
+
|
219 |
+
如果 SillyTavern 服务设备在同一个局域网上,则使用安装 SillyTavern 服务的电脑的局域网 IP 地址:
|
220 |
+
|
221 |
+
* Windows:Windows 按钮 > 在搜索栏中输入 `cmd.exe` > 在打开的控制台中输入 `ipconfig`,回车 > 然后在输出中查找 `IPv4` 地址。
|
222 |
+
|
223 |
+
如果您(或其他人)想在互联网中访问你自己的 SillyTavern 服务,则需要运行 SillyTavern 服务的设备的互联网 IP 地址。
|
224 |
+
|
225 |
+
* 使用运行 SillyTavern 的设备,访问 [this page](https://whatismyipaddress.com/) 并查找 `IPv4`。这是您从互联网访问时要用到的。
|
226 |
+
|
227 |
+
### 3. 使用其他设备访问 SillyTavern 服务
|
228 |
+
|
229 |
+
无论你最终使用的是什么 IP 地址,都要将该 IP 地址和端口号输入其他设备网络浏览器。
|
230 |
+
|
231 |
+
同一局域网中的 SillyTavern 服务的典型默认地址如下:
|
232 |
+
|
233 |
+
`http://192.168.0.5:8000`
|
234 |
+
|
235 |
+
使用 http:// 而不是 https://
|
236 |
+
|
237 |
+
### 向所有 IP 开放您的 SillyTavern 服务
|
238 |
+
|
239 |
+
我们不建议这样做,但您可以打开 `config.conf` 并将里面的 `whitelist` 设置改为 `false`。
|
240 |
+
|
241 |
+
你必须删除(或重命名)SillyTavern 文件夹中的 `whitelist.txt` 文件(如果有的话)。
|
242 |
+
|
243 |
+
这通常是不安全的做法,所以我们要求在这样做时必须设置用户名和密码。
|
244 |
+
|
245 |
+
用户名和密码在`config.conf`文件中设置。
|
246 |
+
|
247 |
+
重启 SillyTavern 服务后,只要知道用户名和密码,任何设备都可以访问。
|
248 |
+
|
249 |
+
### 还是无法访问?
|
250 |
+
|
251 |
+
* 为 `config.conf` 文件中的端口创建一条入站/出站防火墙规则。切勿将此误认为是路由器上的端口转发,否则,有人可能会发现你的聊天隐私,那就大错特错了。
|
252 |
+
* 在 "设置" > "网络和 Internet" > "以太网" 中启用 "专用网络" 配置。这对 Windows 11 非常重要,否则即使添加了上述防火墙规则也无法连接。
|
253 |
+
|
254 |
+
### 性能问题?
|
255 |
+
|
256 |
+
尝试在用户设置面板上关闭模糊效果(快速用户界面)模式。
|
257 |
+
|
258 |
+
## 我喜欢你的项目!我该如何贡献自己的力量?
|
259 |
+
|
260 |
+
### 应该
|
261 |
+
|
262 |
+
1. 发送 Fork 请求
|
263 |
+
2. 使用规定的模板发送功能建议和问题报告
|
264 |
+
3. 在提出任何问题之前,请先阅读 Readme 文件和文档
|
265 |
+
|
266 |
+
#### 不应该
|
267 |
+
|
268 |
+
1. 提供金钱捐赠
|
269 |
+
2. 发送错误报告而不提供任何详细信息
|
270 |
+
3. 提出已经回答过无数次的问题
|
271 |
+
|
272 |
+
## 我在哪里可以找到以前的聊天背景图片?
|
273 |
+
|
274 |
+
我们正在实行 100% 原创内容的政策,因此旧的背景图片已从该资源库中删除。
|
275 |
+
|
276 |
+
不过你可以在这里找到它们的存档:
|
277 |
+
|
278 |
+
<https://files.catbox.moe/1xevnc.zip>
|
279 |
+
|
280 |
+
## 屏幕截图
|
281 |
+
|
282 |
+
<img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649245-8061c60f-63dc-488e-9325-f151b7a3ec2d.png">
|
283 |
+
<img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649856-fbdeef05-d727-4d5a-be80-266cbbc6b811.png">
|
284 |
+
|
285 |
+
## 许可证和贡献
|
286 |
+
|
287 |
+
**发布本程序是希望它能有所帮助,但不做任何保证;甚至没有明示的性能、稳定性和其他任何特定用途的可用性保证。更多详情,请参阅 GNU Affero 通用公共许可证。**
|
288 |
+
|
289 |
+
**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.**
|
290 |
+
|
291 |
+
* TAI Base by Humi: Unknown license
|
292 |
+
* Cohee's modifications and derived code: AGPL v3
|
293 |
+
* RossAscends' additions: AGPL v3
|
294 |
+
* Portions of CncAnon's TavernAITurbo mod: Unknown license
|
295 |
+
* kingbri's various commits and suggestions (<https://github.com/bdashore3>)
|
296 |
+
* StefanDanielSchwarz's various commits and bug reports (<https://github.com/StefanDanielSchwarz>)
|
297 |
+
* Waifu mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>)
|
298 |
+
* Thanks Pygmalion University for being awesome testers and suggesting cool features!
|
299 |
+
* Thanks oobabooga for compiling presets for TextGen
|
300 |
+
* KoboldAI Presets from KAI Lite: <https://lite.koboldai.net/>
|
301 |
+
* Noto Sans font by Google (OFL license)
|
302 |
+
* Icon theme by Font Awesome <https://fontawesome.com> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
|
303 |
+
* AI Horde client library by ZeldaFan0225: <https://github.com/ZeldaFan0225/ai_horde>
|
304 |
+
* Linux startup script by AlpinDale
|
305 |
+
* Thanks paniphons for providing a FAQ document
|
306 |
+
* 10K Discord Users Celebratory Background by @kallmeflocc
|
307 |
+
* Default content (characters and lore books) provided by @OtisAlejandro, @RossAscends and @kallmeflocc
|
308 |
+
* Korean translation by @doloroushyeonse
|
309 |
+
* 中文翻译由 [@XXpE3](https://github.com/XXpE3) 完成,中文 ISSUES 可以联系 @XXpE3
|
.github/readme.md
ADDED
@@ -0,0 +1,312 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
English | [中文](readme-zh_cn.md)
|
2 |
+
|
3 |
+
![image](https://github.com/SillyTavern/SillyTavern/assets/18619528/8c41a061-7f72-4d2b-9d54-e6d058209e7b)
|
4 |
+
|
5 |
+
Mobile-friendly, Multi-API (KoboldAI/CPP, Horde, NovelAI, Ooba, OpenAI, OpenRouter, Claude, Scale), VN-like Waifu Mode, Horde SD, System TTS, WorldInfo (lorebooks), customizable UI, auto-translate, and more prompt options than you'd ever want or need. Optional Extras server for more SD/TTS options + ChromaDB/Summarize.
|
6 |
+
|
7 |
+
Based on a fork of TavernAI 1.2.8
|
8 |
+
|
9 |
+
### Brought to you by Cohee, RossAscends, and the SillyTavern community
|
10 |
+
|
11 |
+
NOTE: We have created a [Documentation website](https://docs.sillytavern.app/) to answer most of your questions and help you get started.
|
12 |
+
|
13 |
+
### What is SillyTavern or TavernAI?
|
14 |
+
|
15 |
+
SillyTavern is a user interface you can install on your computer (and Android phones) that allows you to interact with text generation AIs and chat/roleplay with characters you or the community create.
|
16 |
+
|
17 |
+
SillyTavern is a fork of TavernAI 1.2.8 which is under more active development and has added many major features. At this point, they can be thought of as completely independent programs.
|
18 |
+
|
19 |
+
### Branches
|
20 |
+
|
21 |
+
SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users.
|
22 |
+
|
23 |
+
* 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.
|
24 |
+
* 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.
|
25 |
+
|
26 |
+
If you're not familiar with using the git CLI or don't understand what a branch is, don't worry! The release branch is always the preferable option for you.
|
27 |
+
|
28 |
+
### What do I need other than Tavern?
|
29 |
+
|
30 |
+
On its own Tavern is useless, as it's just a user interface. You have to have access to an AI system backend that can act as the roleplay character. There are various supported backends: OpenAPI API (GPT), KoboldAI (either running locally or on Google Colab), and more. You can read more about this in [the FAQ](https://docs.sillytavern.app/usage/faq/).
|
31 |
+
|
32 |
+
### Do I need a powerful PC to run Tavern?
|
33 |
+
|
34 |
+
Since Tavern is only a user interface, it has tiny hardware requirements, it will run on anything. It's the AI system backend that needs to be powerful.
|
35 |
+
|
36 |
+
## Mobile support
|
37 |
+
|
38 |
+
> **Note**
|
39 |
+
|
40 |
+
> **This fork can be run natively on Android phones using Termux. Please refer to this guide by ArroganceComplex#2659:**
|
41 |
+
|
42 |
+
<https://rentry.org/STAI-Termux>
|
43 |
+
|
44 |
+
**.webp character cards import/export is not supported in Termux. Use either JSON or PNG formats instead.**
|
45 |
+
|
46 |
+
## Questions or suggestions?
|
47 |
+
|
48 |
+
### We now have a community Discord server
|
49 |
+
|
50 |
+
Get support, share favorite characters and prompts:
|
51 |
+
|
52 |
+
### [Join](https://discord.gg/RZdyAEUPvj)
|
53 |
+
|
54 |
+
***
|
55 |
+
|
56 |
+
Get in touch with the developers directly:
|
57 |
+
|
58 |
+
* Discord: cohee or rossascends
|
59 |
+
* Reddit: /u/RossAscends or /u/sillylossy
|
60 |
+
* [Post a GitHub issue](https://github.com/SillyTavern/SillyTavern/issues)
|
61 |
+
|
62 |
+
## This version includes
|
63 |
+
|
64 |
+
* A heavily modified TavernAI 1.2.8 (more than 50% of code rewritten or optimized)
|
65 |
+
* Swipes
|
66 |
+
* Group chats: multi-bot rooms for characters to talk to you or each other
|
67 |
+
* Chat bookmarks / branching (duplicates the dialogue in its current state)
|
68 |
+
* Advanced KoboldAI / TextGen generation settings with a lot of community-made presets
|
69 |
+
* World Info support: create rich lore or save tokens on your character card
|
70 |
+
* [OpenRouter](https://openrouter.ai) connection for various APIs (Claude, GPT-4/3.5 and more)
|
71 |
+
* [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui) API connection
|
72 |
+
* [AI Horde](https://horde.koboldai.net/) connection
|
73 |
+
* Prompt generation formatting tweaking
|
74 |
+
* webp character card interoperability (PNG is still an internal format)
|
75 |
+
|
76 |
+
## Extensions
|
77 |
+
|
78 |
+
SillyTavern has extensibility support, with some additional AI modules hosted via [SillyTavern Extras API](https://github.com/SillyTavern/SillyTavern-extras)
|
79 |
+
|
80 |
+
* Author's Note / Character Bias
|
81 |
+
* Character emotional expressions (sprites)
|
82 |
+
* Auto-Summary of the chat history
|
83 |
+
* Sending images to chat, and the AI interpreting the content
|
84 |
+
* Stable Diffusion image generation (5 chat-related presets plus 'free mode')
|
85 |
+
* Text-to-speech for AI response messages (via ElevenLabs, Silero, or the OS's System TTS)
|
86 |
+
* ChromaDB vector storage for smarter chat prompt formatting
|
87 |
+
|
88 |
+
A full list of included extensions and tutorials on how to use them can be found in the [Docs](https://docs.sillytavern.app/extras/extensions/).
|
89 |
+
|
90 |
+
## UI/CSS/Quality of Life tweaks by RossAscends
|
91 |
+
|
92 |
+
* Mobile UI optimized for iOS, and supports saving a shortcut to the home screen and opening in fullscreen mode.
|
93 |
+
* HotKeys
|
94 |
+
* Up = Edit last message in chat
|
95 |
+
* Ctrl+Up = Edit last USER message in chat
|
96 |
+
* Left = swipe left
|
97 |
+
* Right = swipe right (NOTE: swipe hotkeys are disabled when the chat bar has something typed into it)
|
98 |
+
* Ctrl+Left = view locally stored variables (in the browser console window)
|
99 |
+
* Enter (with chat bar selected) = send your message to AI
|
100 |
+
* Ctrl+Enter = Regenerate the last AI response
|
101 |
+
|
102 |
+
* User Name Changes and Character Deletion no longer force the page to refresh.
|
103 |
+
|
104 |
+
* Toggle option to automatically connect to API on page load.
|
105 |
+
* Toggle option to automatically load the most recently viewed character on page load.
|
106 |
+
* Better Token Counter - works on unsaved characters, and shows both permanent and temporary tokens.
|
107 |
+
|
108 |
+
* Better Past Chats View
|
109 |
+
* New Chat filenames are saved in a readable format of "(character) - (when it was created)"
|
110 |
+
* Chat preview increased from 40 characters to 300.
|
111 |
+
* Multiple options for characters list sorting (by name, creation date, chat sizes).
|
112 |
+
|
113 |
+
* By default the left and right settings panel will close when you click away from it.
|
114 |
+
* Clicking the Lock on the nav panel will hold the panel open, and this setting be remembered across sessions.
|
115 |
+
* Nav panel status of open or closed will also be saved across sessions.
|
116 |
+
|
117 |
+
* Customizable chat UI:
|
118 |
+
* Play a sound when a new message arrives
|
119 |
+
* Switch between round or rectangle avatar styles
|
120 |
+
* Have a wider chat window on the desktop
|
121 |
+
* Optional semi-transparent glass-like panels
|
122 |
+
* Customizable page colors for 'main text', 'quoted text', and 'italics text'.
|
123 |
+
* Customizable UI background color and blur amount
|
124 |
+
|
125 |
+
## Installation
|
126 |
+
|
127 |
+
*NOTE: This software is intended for local install purposes, and has not been thoroughly tested on a colab or other cloud notebook service.*
|
128 |
+
|
129 |
+
> **Warning**
|
130 |
+
|
131 |
+
> DO NOT INSTALL INTO ANY WINDOWS CONTROLLED FOLDER (Program Files, System32, etc).
|
132 |
+
|
133 |
+
> DO NOT RUN START.BAT WITH ADMIN PERMISSIONS
|
134 |
+
|
135 |
+
### Windows
|
136 |
+
|
137 |
+
Installing via Git (recommended for easy updating)
|
138 |
+
|
139 |
+
An easy-to-follow guide with pretty pictures:
|
140 |
+
<https://docs.sillytavern.app/installation/windows/>
|
141 |
+
|
142 |
+
1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended)
|
143 |
+
2. Install [GitHub Desktop](https://central.github.com/deployments/desktop/desktop/latest/win32)
|
144 |
+
3. Open Windows Explorer (`Win+E`)
|
145 |
+
4. Browse to or Create a folder that is not controlled or monitored by Windows. (ex: C:\MySpecialFolder\)
|
146 |
+
5. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter.
|
147 |
+
6. Once the black box (Command Prompt) pops up, type ONE of the following into it and press Enter:
|
148 |
+
|
149 |
+
* for Release Branch: `git clone https://github.com/SillyTavern/SillyTavern -b release`
|
150 |
+
* for Staging Branch: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
|
151 |
+
|
152 |
+
7. Once everything is cloned, double-click `Start.bat` to make NodeJS install its requirements.
|
153 |
+
8. The server will then start, and SillyTavern will pop up in your browser.
|
154 |
+
|
155 |
+
Installing via ZIP download (discouraged)
|
156 |
+
|
157 |
+
1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended)
|
158 |
+
2. Download the zip from this GitHub repo. (Get the `Source code (zip)` from [Releases](https://github.com/SillyTavern/SillyTavern/releases/latest))
|
159 |
+
3. Unzip it into a folder of your choice
|
160 |
+
4. Run `Start.bat` by double-clicking or in a command line.
|
161 |
+
5. Once the server has prepared everything for you, it will open a tab in your browser.
|
162 |
+
|
163 |
+
### Linux
|
164 |
+
|
165 |
+
1. Run the `start.sh` script.
|
166 |
+
2. Enjoy.
|
167 |
+
|
168 |
+
## API keys management
|
169 |
+
|
170 |
+
SillyTavern saves your API keys to a `secrets.json` file in the server directory.
|
171 |
+
|
172 |
+
By default, they will not be exposed to a frontend after you enter them and reload the page.
|
173 |
+
|
174 |
+
In order to enable viewing your keys by clicking a button in the API block:
|
175 |
+
|
176 |
+
1. Set the value of `allowKeysExposure` to `true` in `config.conf` file.
|
177 |
+
2. Restart the SillyTavern server.
|
178 |
+
|
179 |
+
## Remote connections
|
180 |
+
|
181 |
+
Most often this is for people who want to use SillyTavern on their mobile phones while their PC runs the ST server on the same wifi network.
|
182 |
+
|
183 |
+
However, it can be used to allow remote connections from anywhere as well.
|
184 |
+
|
185 |
+
**IMPORTANT: SillyTavern is a single-user program, so anyone who logs in will be able to see all characters and chats, and be able to change any settings inside the UI.**
|
186 |
+
|
187 |
+
### 1. Managing whitelisted IPs
|
188 |
+
|
189 |
+
* Create a new text file inside your SillyTavern base install folder called `whitelist.txt`.
|
190 |
+
* Open the file in a text editor, and add a list of IPs you want to be allowed to connect.
|
191 |
+
|
192 |
+
*Both individual IPs and wildcard IP ranges are accepted. Examples:*
|
193 |
+
|
194 |
+
```txt
|
195 |
+
192.168.0.1
|
196 |
+
192.168.0.20
|
197 |
+
```
|
198 |
+
|
199 |
+
or
|
200 |
+
|
201 |
+
```txt
|
202 |
+
192.168.0.*
|
203 |
+
```
|
204 |
+
|
205 |
+
(the above wildcard IP range will allow any device on the local network to connect)
|
206 |
+
|
207 |
+
CIDR masks are also accepted (eg. 10.0.0.0/24).
|
208 |
+
|
209 |
+
* Save the `whitelist.txt` file.
|
210 |
+
* Restart your TAI server.
|
211 |
+
|
212 |
+
Now devices which have the IP specified in the file will be able to connect.
|
213 |
+
|
214 |
+
*Note: `config.conf` also has a `whitelist` array, which you can use in the same way, but this array will be ignored if `whitelist.txt` exists.*
|
215 |
+
|
216 |
+
### 2. Getting the IP for the ST host machine
|
217 |
+
|
218 |
+
After the whitelist has been setup, you'll need the IP of the ST-hosting device.
|
219 |
+
|
220 |
+
If the ST-hosting device is on the same wifi network, you will use the ST-host's internal wifi IP:
|
221 |
+
|
222 |
+
* For Windows: windows button > type `cmd.exe` in the search bar > type `ipconfig` in the console, hit Enter > look for `IPv4` listing.
|
223 |
+
|
224 |
+
If you (or someone else) want to connect to your hosted ST while not being on the same network, you will need the public IP of your ST-hosting device.
|
225 |
+
|
226 |
+
* While using the ST-hosting device, access [this page](https://whatismyipaddress.com/) and look for for `IPv4`. This is what you would use to connect from the remote device.
|
227 |
+
|
228 |
+
### 3. Connect the remote device to the ST host machine
|
229 |
+
|
230 |
+
Whatever IP you ended up with for your situation, you will put that IP address and port number into the remote device's web browser.
|
231 |
+
|
232 |
+
A typical address for an ST host on the same wifi network would look like this:
|
233 |
+
|
234 |
+
`http://192.168.0.5:8000`
|
235 |
+
|
236 |
+
Use http:// NOT https://
|
237 |
+
|
238 |
+
### Opening your ST to all IPs
|
239 |
+
|
240 |
+
We do not recommend doing this, but you can open `config.conf` and change `whitelist` to `false`.
|
241 |
+
|
242 |
+
You must remove (or rename) `whitelist.txt` in the SillyTavern base install folder if it exists.
|
243 |
+
|
244 |
+
This is usually an insecure practice, so we require you to set a username and password when you do this.
|
245 |
+
|
246 |
+
The username and password are set in `config.conf`.
|
247 |
+
|
248 |
+
After restarting your ST server, any device will be able to connect to it, regardless of their IP as long as they know the username and password.
|
249 |
+
|
250 |
+
### Still Unable To Connect?
|
251 |
+
|
252 |
+
* Create an inbound/outbound firewall rule for the port found in `config.conf`. Do NOT mistake this for port-forwarding on your router, otherwise, someone could find your chat logs and that's a big no-no.
|
253 |
+
* Enable the Private Network profile type in Settings > Network and Internet > Ethernet. This is VERY important for Windows 11, otherwise, you would be unable to connect even with the aforementioned firewall rules.
|
254 |
+
|
255 |
+
## Performance issues?
|
256 |
+
|
257 |
+
Try enabling the No Blur Effect (Fast UI) mode on the User settings panel.
|
258 |
+
|
259 |
+
## I like your project! How do I contribute?
|
260 |
+
|
261 |
+
### DO's
|
262 |
+
|
263 |
+
1. Send pull requests
|
264 |
+
2. Send feature suggestions and issue reports using established templates
|
265 |
+
3. Read the readme file and built-in documentation before asking anything
|
266 |
+
|
267 |
+
### DONT's
|
268 |
+
|
269 |
+
1. Offer monetary donations
|
270 |
+
2. Send bug reports without providing any context
|
271 |
+
3. Ask the questions that were already answered numerous times
|
272 |
+
|
273 |
+
## Where can I find the old backgrounds?
|
274 |
+
|
275 |
+
We're moving to a 100% original content only policy, so old background images have been removed from this repository.
|
276 |
+
|
277 |
+
You can find them archived here:
|
278 |
+
|
279 |
+
<https://files.catbox.moe/1xevnc.zip>
|
280 |
+
|
281 |
+
## Screenshots
|
282 |
+
|
283 |
+
<img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649245-8061c60f-63dc-488e-9325-f151b7a3ec2d.png">
|
284 |
+
<img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649856-fbdeef05-d727-4d5a-be80-266cbbc6b811.png">
|
285 |
+
|
286 |
+
## License and credits
|
287 |
+
|
288 |
+
**This program is distributed in the hope that it will be useful,
|
289 |
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
290 |
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
291 |
+
GNU Affero General Public License for more details.**
|
292 |
+
|
293 |
+
* TAI Base by Humi: Unknown license
|
294 |
+
* Cohee's modifications and derived code: AGPL v3
|
295 |
+
* RossAscends' additions: AGPL v3
|
296 |
+
* Portions of CncAnon's TavernAITurbo mod: Unknown license
|
297 |
+
* kingbri's various commits and suggestions (<https://github.com/bdashore3>)
|
298 |
+
* StefanDanielSchwarz's various commits and bug reports (<https://github.com/StefanDanielSchwarz>)
|
299 |
+
* Waifu mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>)
|
300 |
+
* Thanks Pygmalion University for being awesome testers and suggesting cool features!
|
301 |
+
* Thanks oobabooga for compiling presets for TextGen
|
302 |
+
* KoboldAI Presets from KAI Lite: <https://lite.koboldai.net/>
|
303 |
+
* Noto Sans font by Google (OFL license)
|
304 |
+
* Icon theme by Font Awesome <https://fontawesome.com> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
|
305 |
+
* AI Horde client library by ZeldaFan0225: <https://github.com/ZeldaFan0225/ai_horde>
|
306 |
+
* Linux startup script by AlpinDale
|
307 |
+
* Thanks paniphons for providing a FAQ document
|
308 |
+
* 10K Discord Users Celebratory Background by @kallmeflocc
|
309 |
+
* Default content (characters and lore books) provided by @OtisAlejandro, @RossAscends and @kallmeflocc
|
310 |
+
* Korean translation by @doloroushyeonse
|
311 |
+
* k_euler_a support for Horde by <https://github.com/Teashrock>
|
312 |
+
* Chinese translation by [@XXpE3](https://github.com/XXpE3), 中文 ISSUES 可以联系 @XXpE3
|
.github/workflows/build-and-publish-release.yml
ADDED
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: Build and Publish Release (Release)
|
2 |
+
|
3 |
+
on:
|
4 |
+
push:
|
5 |
+
branches:
|
6 |
+
- release
|
7 |
+
|
8 |
+
jobs:
|
9 |
+
build_and_publish:
|
10 |
+
runs-on: ubuntu-latest
|
11 |
+
|
12 |
+
steps:
|
13 |
+
- name: Checkout code
|
14 |
+
uses: actions/checkout@v2
|
15 |
+
|
16 |
+
- name: Set up Node.js
|
17 |
+
uses: actions/setup-node@v2
|
18 |
+
with:
|
19 |
+
node-version: 18
|
20 |
+
|
21 |
+
- name: Install dependencies
|
22 |
+
run: npm ci
|
23 |
+
|
24 |
+
- name: Build and package with pkg
|
25 |
+
run: |
|
26 |
+
npm install -g pkg
|
27 |
+
npm run pkg
|
28 |
+
|
29 |
+
- name: Upload binaries to release
|
30 |
+
uses: softprops/action-gh-release@v1
|
31 |
+
with:
|
32 |
+
files: dist/*
|
33 |
+
tag_name: ci-release
|
34 |
+
name: Continuous Release (Release)
|
35 |
+
prerelease: true
|
36 |
+
env:
|
37 |
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
.github/workflows/build-and-publish-staging.yml
ADDED
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: Build and Publish Release (Staging)
|
2 |
+
|
3 |
+
on:
|
4 |
+
push:
|
5 |
+
branches:
|
6 |
+
- staging
|
7 |
+
|
8 |
+
jobs:
|
9 |
+
build_and_publish:
|
10 |
+
runs-on: ubuntu-latest
|
11 |
+
|
12 |
+
steps:
|
13 |
+
- name: Checkout code
|
14 |
+
uses: actions/checkout@v2
|
15 |
+
|
16 |
+
- name: Set up Node.js
|
17 |
+
uses: actions/setup-node@v2
|
18 |
+
with:
|
19 |
+
node-version: 18
|
20 |
+
|
21 |
+
- name: Install dependencies
|
22 |
+
run: npm ci
|
23 |
+
|
24 |
+
- name: Build and package with pkg
|
25 |
+
run: |
|
26 |
+
npm install -g pkg
|
27 |
+
npm run pkg
|
28 |
+
|
29 |
+
- name: Upload binaries to release
|
30 |
+
uses: softprops/action-gh-release@v1
|
31 |
+
with:
|
32 |
+
files: dist/*
|
33 |
+
tag_name: ci-staging
|
34 |
+
name: Continuous Release (Staging)
|
35 |
+
prerelease: true
|
36 |
+
env:
|
37 |
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
.github/workflows/npm-publish.yml
ADDED
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
|
2 |
+
# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
|
3 |
+
|
4 |
+
name: Node.js Package
|
5 |
+
|
6 |
+
on:
|
7 |
+
release:
|
8 |
+
types: [created]
|
9 |
+
|
10 |
+
jobs:
|
11 |
+
build:
|
12 |
+
runs-on: ubuntu-latest
|
13 |
+
steps:
|
14 |
+
- uses: actions/checkout@v3
|
15 |
+
- uses: actions/setup-node@v3
|
16 |
+
with:
|
17 |
+
node-version: 16
|
18 |
+
- run: npm ci
|
19 |
+
|
20 |
+
publish-npm:
|
21 |
+
needs: build
|
22 |
+
runs-on: ubuntu-latest
|
23 |
+
steps:
|
24 |
+
- uses: actions/checkout@v3
|
25 |
+
- uses: actions/setup-node@v3
|
26 |
+
with:
|
27 |
+
node-version: 16
|
28 |
+
registry-url: https://registry.npmjs.org/
|
29 |
+
- run: npm ci
|
30 |
+
- run: npm publish
|
31 |
+
env:
|
32 |
+
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
|
.github/workflows/update-docs.yml
ADDED
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: Update SillyTavern-Docs
|
2 |
+
|
3 |
+
on:
|
4 |
+
push:
|
5 |
+
branches:
|
6 |
+
- main
|
7 |
+
|
8 |
+
jobs:
|
9 |
+
update_docs:
|
10 |
+
runs-on: ubuntu-latest
|
11 |
+
|
12 |
+
steps:
|
13 |
+
- name: Checkout current repository
|
14 |
+
uses: actions/checkout@v2
|
15 |
+
|
16 |
+
- name: Checkout SillyTavern-Docs repository
|
17 |
+
uses: actions/checkout@v2
|
18 |
+
with:
|
19 |
+
repository: SillyTavern/SillyTavern-Docs
|
20 |
+
path: SillyTavern-Docs
|
21 |
+
|
22 |
+
- name: Clone SillyTavern wiki into SillyTavern-Docs/extensions
|
23 |
+
run: rm -rf SillyTavern-Docs/extensions && git clone https://github.com/SillyTavern/SillyTavern.wiki.git SillyTavern-Docs/extensions && rm -rf SillyTavern-Docs/extensions/.git
|
24 |
+
|
25 |
+
- name: Copy files
|
26 |
+
run: |
|
27 |
+
cp public/notes/content.md SillyTavern-Docs/guidebook.md
|
28 |
+
cp faq.md SillyTavern-Docs/faq.md
|
29 |
+
cp readme.md SillyTavern-Docs/readme.md
|
30 |
+
cp public/notes/update.md SillyTavern-Docs/update.md
|
31 |
+
|
32 |
+
- name: Deploy to external repository
|
33 |
+
uses: cpina/github-action-push-to-another-repository@main
|
34 |
+
env:
|
35 |
+
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
|
36 |
+
with:
|
37 |
+
# GitHub Action output files
|
38 |
+
source-directory: SillyTavern-Docs/
|
39 |
+
destination-github-username: SillyTavern
|
40 |
+
destination-repository-name: SillyTavern-Docs
|
41 |
+
user-email: github-actions[bot]@users.noreply.github.com
|
42 |
+
user-name: "GitHub Actions"
|
43 |
+
target-branch: "main"
|
.gitignore
ADDED
@@ -0,0 +1,31 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
node_modules/
|
2 |
+
public/chats/
|
3 |
+
public/characters/
|
4 |
+
public/User Avatars/
|
5 |
+
public/backgrounds/
|
6 |
+
public/groups/
|
7 |
+
public/group chats/
|
8 |
+
public/worlds/
|
9 |
+
public/css/bg_load.css
|
10 |
+
public/themes/
|
11 |
+
public/OpenAI Settings/
|
12 |
+
public/KoboldAI Settings/
|
13 |
+
public/TextGen Settings/
|
14 |
+
public/scripts/extensions/third-party/
|
15 |
+
public/stats.json
|
16 |
+
/uploads/
|
17 |
+
*.jsonl
|
18 |
+
/config.conf
|
19 |
+
/docker/config
|
20 |
+
.DS_Store
|
21 |
+
public/settings.json
|
22 |
+
/thumbnails
|
23 |
+
whitelist.txt
|
24 |
+
.vscode
|
25 |
+
secrets.json
|
26 |
+
/dist
|
27 |
+
/backups/
|
28 |
+
public/movingUI/
|
29 |
+
public/QuickReplies/
|
30 |
+
content.log
|
31 |
+
cloudflared.exe
|
.npmignore
ADDED
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
node_modules/
|
2 |
+
/uploads/
|
3 |
+
.DS_Store
|
4 |
+
/thumbnails
|
5 |
+
secrets.json
|
6 |
+
/dist
|
7 |
+
/backups/
|
.replit
ADDED
@@ -0,0 +1,81 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
|
2 |
+
hidden = [".config", "package-lock.json"]
|
3 |
+
run = "chmod 755 ./start.sh && ./start.sh"
|
4 |
+
entrypoint = "server.js"
|
5 |
+
|
6 |
+
[[hints]]
|
7 |
+
regex = "Error \\[ERR_REQUIRE_ESM\\]"
|
8 |
+
message = "We see that you are using require(...) inside your code. We currently do not support this syntax. Please use 'import' instead when using external modules. (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)"
|
9 |
+
|
10 |
+
[nix]
|
11 |
+
channel = "stable-22_11"
|
12 |
+
|
13 |
+
[env]
|
14 |
+
XDG_CONFIG_HOME = "/home/runner/$REPL_SLUG/.config"
|
15 |
+
PATH = "/home/runner/$REPL_SLUG/.config/npm/node_global/bin:/home/runner/$REPL_SLUG/node_modules/.bin"
|
16 |
+
npm_config_prefix = "/home/runner/$REPL_SLUG/.config/npm/node_global"
|
17 |
+
|
18 |
+
[gitHubImport]
|
19 |
+
requiredFiles = [".replit", "replit.nix", ".config", "package.json", "package-lock.json"]
|
20 |
+
|
21 |
+
[packager]
|
22 |
+
language = "nodejs"
|
23 |
+
|
24 |
+
[packager.features]
|
25 |
+
packageSearch = true
|
26 |
+
guessImports = true
|
27 |
+
enabledForHosting = false
|
28 |
+
|
29 |
+
[unitTest]
|
30 |
+
language = "nodejs"
|
31 |
+
|
32 |
+
[debugger]
|
33 |
+
support = true
|
34 |
+
|
35 |
+
[debugger.interactive]
|
36 |
+
transport = "localhost:0"
|
37 |
+
startCommand = [ "dap-node" ]
|
38 |
+
|
39 |
+
[debugger.interactive.initializeMessage]
|
40 |
+
command = "initialize"
|
41 |
+
type = "request"
|
42 |
+
|
43 |
+
[debugger.interactive.initializeMessage.arguments]
|
44 |
+
clientID = "replit"
|
45 |
+
clientName = "replit.com"
|
46 |
+
columnsStartAt1 = true
|
47 |
+
linesStartAt1 = true
|
48 |
+
locale = "en-us"
|
49 |
+
pathFormat = "path"
|
50 |
+
supportsInvalidatedEvent = true
|
51 |
+
supportsProgressReporting = true
|
52 |
+
supportsRunInTerminalRequest = true
|
53 |
+
supportsVariablePaging = true
|
54 |
+
supportsVariableType = true
|
55 |
+
|
56 |
+
[debugger.interactive.launchMessage]
|
57 |
+
command = "launch"
|
58 |
+
type = "request"
|
59 |
+
|
60 |
+
[debugger.interactive.launchMessage.arguments]
|
61 |
+
args = []
|
62 |
+
console = "externalTerminal"
|
63 |
+
cwd = "."
|
64 |
+
environment = []
|
65 |
+
pauseForSourceMap = false
|
66 |
+
program = "./server.js"
|
67 |
+
request = "launch"
|
68 |
+
sourceMaps = true
|
69 |
+
stopOnEntry = false
|
70 |
+
type = "pwa-node"
|
71 |
+
|
72 |
+
[languages]
|
73 |
+
|
74 |
+
[languages.javascript]
|
75 |
+
pattern = "**/{*.js,*.jsx,*.ts,*.tsx,*.json}"
|
76 |
+
|
77 |
+
[languages.javascript.languageServer]
|
78 |
+
start = "typescript-language-server --stdio"
|
79 |
+
|
80 |
+
[deployment]
|
81 |
+
run = ["sh", "-c", "./start.sh"]
|
Dockerfile
ADDED
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
FROM node:19.1.0-alpine3.16
|
2 |
+
|
3 |
+
# Arguments
|
4 |
+
ARG APP_HOME=/home/node/app
|
5 |
+
|
6 |
+
# Install system dependencies
|
7 |
+
RUN apk add gcompat tini git
|
8 |
+
|
9 |
+
# Ensure proper handling of kernel signals
|
10 |
+
ENTRYPOINT [ "tini", "--" ]
|
11 |
+
|
12 |
+
# Create app directory
|
13 |
+
WORKDIR ${APP_HOME}
|
14 |
+
|
15 |
+
# Install app dependencies
|
16 |
+
COPY package*.json ./
|
17 |
+
RUN \
|
18 |
+
echo "*** Install npm packages ***" && \
|
19 |
+
npm install && npm cache clean --force
|
20 |
+
|
21 |
+
# Bundle app source
|
22 |
+
COPY . ./
|
23 |
+
|
24 |
+
# Copy default chats, characters and user avatars to <folder>.default folder
|
25 |
+
RUN \
|
26 |
+
IFS="," RESOURCES="characters,chats,groups,group chats,User Avatars,worlds" && \
|
27 |
+
\
|
28 |
+
echo "*** Store default $RESOURCES in <folder>.default ***" && \
|
29 |
+
for R in $RESOURCES; do mv "public/$R" "public/$R.default"; done && \
|
30 |
+
\
|
31 |
+
echo "*** Create symbolic links to config directory ***" && \
|
32 |
+
for R in $RESOURCES; do ln -s "../config/$R" "public/$R"; done && \
|
33 |
+
# rm "config.conf" "public/settings.json" "public/css/bg_load.css" && \
|
34 |
+
ln -s "./config/config.conf" "config.conf" && \
|
35 |
+
ln -s "../config/settings.json" "public/settings.json" && \
|
36 |
+
ln -s "../../config/bg_load.css" "public/css/bg_load.css" && \
|
37 |
+
mkdir "config"
|
38 |
+
|
39 |
+
# Cleanup unnecessary files
|
40 |
+
RUN \
|
41 |
+
echo "*** Cleanup ***" && \
|
42 |
+
mv "./docker/docker-entrypoint.sh" "./" && \
|
43 |
+
rm -rf "./docker" && \
|
44 |
+
echo "*** Make docker-entrypoint.sh executable ***" && \
|
45 |
+
chmod +x "./docker-entrypoint.sh" && \
|
46 |
+
echo "*** Convert line endings to Unix format ***" && \
|
47 |
+
dos2unix "./docker-entrypoint.sh"
|
48 |
+
|
49 |
+
EXPOSE 8000
|
50 |
+
|
51 |
+
CMD [ "./docker-entrypoint.sh" ]
|
LICENSE
ADDED
@@ -0,0 +1,661 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
GNU AFFERO GENERAL PUBLIC LICENSE
|
2 |
+
Version 3, 19 November 2007
|
3 |
+
|
4 |
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
5 |
+
Everyone is permitted to copy and distribute verbatim copies
|
6 |
+
of this license document, but changing it is not allowed.
|
7 |
+
|
8 |
+
Preamble
|
9 |
+
|
10 |
+
The GNU Affero General Public License is a free, copyleft license for
|
11 |
+
software and other kinds of works, specifically designed to ensure
|
12 |
+
cooperation with the community in the case of network server software.
|
13 |
+
|
14 |
+
The licenses for most software and other practical works are designed
|
15 |
+
to take away your freedom to share and change the works. By contrast,
|
16 |
+
our General Public Licenses are intended to guarantee your freedom to
|
17 |
+
share and change all versions of a program--to make sure it remains free
|
18 |
+
software for all its users.
|
19 |
+
|
20 |
+
When we speak of free software, we are referring to freedom, not
|
21 |
+
price. Our General Public Licenses are designed to make sure that you
|
22 |
+
have the freedom to distribute copies of free software (and charge for
|
23 |
+
them if you wish), that you receive source code or can get it if you
|
24 |
+
want it, that you can change the software or use pieces of it in new
|
25 |
+
free programs, and that you know you can do these things.
|
26 |
+
|
27 |
+
Developers that use our General Public Licenses protect your rights
|
28 |
+
with two steps: (1) assert copyright on the software, and (2) offer
|
29 |
+
you this License which gives you legal permission to copy, distribute
|
30 |
+
and/or modify the software.
|
31 |
+
|
32 |
+
A secondary benefit of defending all users' freedom is that
|
33 |
+
improvements made in alternate versions of the program, if they
|
34 |
+
receive widespread use, become available for other developers to
|
35 |
+
incorporate. Many developers of free software are heartened and
|
36 |
+
encouraged by the resulting cooperation. However, in the case of
|
37 |
+
software used on network servers, this result may fail to come about.
|
38 |
+
The GNU General Public License permits making a modified version and
|
39 |
+
letting the public access it on a server without ever releasing its
|
40 |
+
source code to the public.
|
41 |
+
|
42 |
+
The GNU Affero General Public License is designed specifically to
|
43 |
+
ensure that, in such cases, the modified source code becomes available
|
44 |
+
to the community. It requires the operator of a network server to
|
45 |
+
provide the source code of the modified version running there to the
|
46 |
+
users of that server. Therefore, public use of a modified version, on
|
47 |
+
a publicly accessible server, gives the public access to the source
|
48 |
+
code of the modified version.
|
49 |
+
|
50 |
+
An older license, called the Affero General Public License and
|
51 |
+
published by Affero, was designed to accomplish similar goals. This is
|
52 |
+
a different license, not a version of the Affero GPL, but Affero has
|
53 |
+
released a new version of the Affero GPL which permits relicensing under
|
54 |
+
this license.
|
55 |
+
|
56 |
+
The precise terms and conditions for copying, distribution and
|
57 |
+
modification follow.
|
58 |
+
|
59 |
+
TERMS AND CONDITIONS
|
60 |
+
|
61 |
+
0. Definitions.
|
62 |
+
|
63 |
+
"This License" refers to version 3 of the GNU Affero General Public License.
|
64 |
+
|
65 |
+
"Copyright" also means copyright-like laws that apply to other kinds of
|
66 |
+
works, such as semiconductor masks.
|
67 |
+
|
68 |
+
"The Program" refers to any copyrightable work licensed under this
|
69 |
+
License. Each licensee is addressed as "you". "Licensees" and
|
70 |
+
"recipients" may be individuals or organizations.
|
71 |
+
|
72 |
+
To "modify" a work means to copy from or adapt all or part of the work
|
73 |
+
in a fashion requiring copyright permission, other than the making of an
|
74 |
+
exact copy. The resulting work is called a "modified version" of the
|
75 |
+
earlier work or a work "based on" the earlier work.
|
76 |
+
|
77 |
+
A "covered work" means either the unmodified Program or a work based
|
78 |
+
on the Program.
|
79 |
+
|
80 |
+
To "propagate" a work means to do anything with it that, without
|
81 |
+
permission, would make you directly or secondarily liable for
|
82 |
+
infringement under applicable copyright law, except executing it on a
|
83 |
+
computer or modifying a private copy. Propagation includes copying,
|
84 |
+
distribution (with or without modification), making available to the
|
85 |
+
public, and in some countries other activities as well.
|
86 |
+
|
87 |
+
To "convey" a work means any kind of propagation that enables other
|
88 |
+
parties to make or receive copies. Mere interaction with a user through
|
89 |
+
a computer network, with no transfer of a copy, is not conveying.
|
90 |
+
|
91 |
+
An interactive user interface displays "Appropriate Legal Notices"
|
92 |
+
to the extent that it includes a convenient and prominently visible
|
93 |
+
feature that (1) displays an appropriate copyright notice, and (2)
|
94 |
+
tells the user that there is no warranty for the work (except to the
|
95 |
+
extent that warranties are provided), that licensees may convey the
|
96 |
+
work under this License, and how to view a copy of this License. If
|
97 |
+
the interface presents a list of user commands or options, such as a
|
98 |
+
menu, a prominent item in the list meets this criterion.
|
99 |
+
|
100 |
+
1. Source Code.
|
101 |
+
|
102 |
+
The "source code" for a work means the preferred form of the work
|
103 |
+
for making modifications to it. "Object code" means any non-source
|
104 |
+
form of a work.
|
105 |
+
|
106 |
+
A "Standard Interface" means an interface that either is an official
|
107 |
+
standard defined by a recognized standards body, or, in the case of
|
108 |
+
interfaces specified for a particular programming language, one that
|
109 |
+
is widely used among developers working in that language.
|
110 |
+
|
111 |
+
The "System Libraries" of an executable work include anything, other
|
112 |
+
than the work as a whole, that (a) is included in the normal form of
|
113 |
+
packaging a Major Component, but which is not part of that Major
|
114 |
+
Component, and (b) serves only to enable use of the work with that
|
115 |
+
Major Component, or to implement a Standard Interface for which an
|
116 |
+
implementation is available to the public in source code form. A
|
117 |
+
"Major Component", in this context, means a major essential component
|
118 |
+
(kernel, window system, and so on) of the specific operating system
|
119 |
+
(if any) on which the executable work runs, or a compiler used to
|
120 |
+
produce the work, or an object code interpreter used to run it.
|
121 |
+
|
122 |
+
The "Corresponding Source" for a work in object code form means all
|
123 |
+
the source code needed to generate, install, and (for an executable
|
124 |
+
work) run the object code and to modify the work, including scripts to
|
125 |
+
control those activities. However, it does not include the work's
|
126 |
+
System Libraries, or general-purpose tools or generally available free
|
127 |
+
programs which are used unmodified in performing those activities but
|
128 |
+
which are not part of the work. For example, Corresponding Source
|
129 |
+
includes interface definition files associated with source files for
|
130 |
+
the work, and the source code for shared libraries and dynamically
|
131 |
+
linked subprograms that the work is specifically designed to require,
|
132 |
+
such as by intimate data communication or control flow between those
|
133 |
+
subprograms and other parts of the work.
|
134 |
+
|
135 |
+
The Corresponding Source need not include anything that users
|
136 |
+
can regenerate automatically from other parts of the Corresponding
|
137 |
+
Source.
|
138 |
+
|
139 |
+
The Corresponding Source for a work in source code form is that
|
140 |
+
same work.
|
141 |
+
|
142 |
+
2. Basic Permissions.
|
143 |
+
|
144 |
+
All rights granted under this License are granted for the term of
|
145 |
+
copyright on the Program, and are irrevocable provided the stated
|
146 |
+
conditions are met. This License explicitly affirms your unlimited
|
147 |
+
permission to run the unmodified Program. The output from running a
|
148 |
+
covered work is covered by this License only if the output, given its
|
149 |
+
content, constitutes a covered work. This License acknowledges your
|
150 |
+
rights of fair use or other equivalent, as provided by copyright law.
|
151 |
+
|
152 |
+
You may make, run and propagate covered works that you do not
|
153 |
+
convey, without conditions so long as your license otherwise remains
|
154 |
+
in force. You may convey covered works to others for the sole purpose
|
155 |
+
of having them make modifications exclusively for you, or provide you
|
156 |
+
with facilities for running those works, provided that you comply with
|
157 |
+
the terms of this License in conveying all material for which you do
|
158 |
+
not control copyright. Those thus making or running the covered works
|
159 |
+
for you must do so exclusively on your behalf, under your direction
|
160 |
+
and control, on terms that prohibit them from making any copies of
|
161 |
+
your copyrighted material outside their relationship with you.
|
162 |
+
|
163 |
+
Conveying under any other circumstances is permitted solely under
|
164 |
+
the conditions stated below. Sublicensing is not allowed; section 10
|
165 |
+
makes it unnecessary.
|
166 |
+
|
167 |
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
168 |
+
|
169 |
+
No covered work shall be deemed part of an effective technological
|
170 |
+
measure under any applicable law fulfilling obligations under article
|
171 |
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
172 |
+
similar laws prohibiting or restricting circumvention of such
|
173 |
+
measures.
|
174 |
+
|
175 |
+
When you convey a covered work, you waive any legal power to forbid
|
176 |
+
circumvention of technological measures to the extent such circumvention
|
177 |
+
is effected by exercising rights under this License with respect to
|
178 |
+
the covered work, and you disclaim any intention to limit operation or
|
179 |
+
modification of the work as a means of enforcing, against the work's
|
180 |
+
users, your or third parties' legal rights to forbid circumvention of
|
181 |
+
technological measures.
|
182 |
+
|
183 |
+
4. Conveying Verbatim Copies.
|
184 |
+
|
185 |
+
You may convey verbatim copies of the Program's source code as you
|
186 |
+
receive it, in any medium, provided that you conspicuously and
|
187 |
+
appropriately publish on each copy an appropriate copyright notice;
|
188 |
+
keep intact all notices stating that this License and any
|
189 |
+
non-permissive terms added in accord with section 7 apply to the code;
|
190 |
+
keep intact all notices of the absence of any warranty; and give all
|
191 |
+
recipients a copy of this License along with the Program.
|
192 |
+
|
193 |
+
You may charge any price or no price for each copy that you convey,
|
194 |
+
and you may offer support or warranty protection for a fee.
|
195 |
+
|
196 |
+
5. Conveying Modified Source Versions.
|
197 |
+
|
198 |
+
You may convey a work based on the Program, or the modifications to
|
199 |
+
produce it from the Program, in the form of source code under the
|
200 |
+
terms of section 4, provided that you also meet all of these conditions:
|
201 |
+
|
202 |
+
a) The work must carry prominent notices stating that you modified
|
203 |
+
it, and giving a relevant date.
|
204 |
+
|
205 |
+
b) The work must carry prominent notices stating that it is
|
206 |
+
released under this License and any conditions added under section
|
207 |
+
7. This requirement modifies the requirement in section 4 to
|
208 |
+
"keep intact all notices".
|
209 |
+
|
210 |
+
c) You must license the entire work, as a whole, under this
|
211 |
+
License to anyone who comes into possession of a copy. This
|
212 |
+
License will therefore apply, along with any applicable section 7
|
213 |
+
additional terms, to the whole of the work, and all its parts,
|
214 |
+
regardless of how they are packaged. This License gives no
|
215 |
+
permission to license the work in any other way, but it does not
|
216 |
+
invalidate such permission if you have separately received it.
|
217 |
+
|
218 |
+
d) If the work has interactive user interfaces, each must display
|
219 |
+
Appropriate Legal Notices; however, if the Program has interactive
|
220 |
+
interfaces that do not display Appropriate Legal Notices, your
|
221 |
+
work need not make them do so.
|
222 |
+
|
223 |
+
A compilation of a covered work with other separate and independent
|
224 |
+
works, which are not by their nature extensions of the covered work,
|
225 |
+
and which are not combined with it such as to form a larger program,
|
226 |
+
in or on a volume of a storage or distribution medium, is called an
|
227 |
+
"aggregate" if the compilation and its resulting copyright are not
|
228 |
+
used to limit the access or legal rights of the compilation's users
|
229 |
+
beyond what the individual works permit. Inclusion of a covered work
|
230 |
+
in an aggregate does not cause this License to apply to the other
|
231 |
+
parts of the aggregate.
|
232 |
+
|
233 |
+
6. Conveying Non-Source Forms.
|
234 |
+
|
235 |
+
You may convey a covered work in object code form under the terms
|
236 |
+
of sections 4 and 5, provided that you also convey the
|
237 |
+
machine-readable Corresponding Source under the terms of this License,
|
238 |
+
in one of these ways:
|
239 |
+
|
240 |
+
a) Convey the object code in, or embodied in, a physical product
|
241 |
+
(including a physical distribution medium), accompanied by the
|
242 |
+
Corresponding Source fixed on a durable physical medium
|
243 |
+
customarily used for software interchange.
|
244 |
+
|
245 |
+
b) Convey the object code in, or embodied in, a physical product
|
246 |
+
(including a physical distribution medium), accompanied by a
|
247 |
+
written offer, valid for at least three years and valid for as
|
248 |
+
long as you offer spare parts or customer support for that product
|
249 |
+
model, to give anyone who possesses the object code either (1) a
|
250 |
+
copy of the Corresponding Source for all the software in the
|
251 |
+
product that is covered by this License, on a durable physical
|
252 |
+
medium customarily used for software interchange, for a price no
|
253 |
+
more than your reasonable cost of physically performing this
|
254 |
+
conveying of source, or (2) access to copy the
|
255 |
+
Corresponding Source from a network server at no charge.
|
256 |
+
|
257 |
+
c) Convey individual copies of the object code with a copy of the
|
258 |
+
written offer to provide the Corresponding Source. This
|
259 |
+
alternative is allowed only occasionally and noncommercially, and
|
260 |
+
only if you received the object code with such an offer, in accord
|
261 |
+
with subsection 6b.
|
262 |
+
|
263 |
+
d) Convey the object code by offering access from a designated
|
264 |
+
place (gratis or for a charge), and offer equivalent access to the
|
265 |
+
Corresponding Source in the same way through the same place at no
|
266 |
+
further charge. You need not require recipients to copy the
|
267 |
+
Corresponding Source along with the object code. If the place to
|
268 |
+
copy the object code is a network server, the Corresponding Source
|
269 |
+
may be on a different server (operated by you or a third party)
|
270 |
+
that supports equivalent copying facilities, provided you maintain
|
271 |
+
clear directions next to the object code saying where to find the
|
272 |
+
Corresponding Source. Regardless of what server hosts the
|
273 |
+
Corresponding Source, you remain obligated to ensure that it is
|
274 |
+
available for as long as needed to satisfy these requirements.
|
275 |
+
|
276 |
+
e) Convey the object code using peer-to-peer transmission, provided
|
277 |
+
you inform other peers where the object code and Corresponding
|
278 |
+
Source of the work are being offered to the general public at no
|
279 |
+
charge under subsection 6d.
|
280 |
+
|
281 |
+
A separable portion of the object code, whose source code is excluded
|
282 |
+
from the Corresponding Source as a System Library, need not be
|
283 |
+
included in conveying the object code work.
|
284 |
+
|
285 |
+
A "User Product" is either (1) a "consumer product", which means any
|
286 |
+
tangible personal property which is normally used for personal, family,
|
287 |
+
or household purposes, or (2) anything designed or sold for incorporation
|
288 |
+
into a dwelling. In determining whether a product is a consumer product,
|
289 |
+
doubtful cases shall be resolved in favor of coverage. For a particular
|
290 |
+
product received by a particular user, "normally used" refers to a
|
291 |
+
typical or common use of that class of product, regardless of the status
|
292 |
+
of the particular user or of the way in which the particular user
|
293 |
+
actually uses, or expects or is expected to use, the product. A product
|
294 |
+
is a consumer product regardless of whether the product has substantial
|
295 |
+
commercial, industrial or non-consumer uses, unless such uses represent
|
296 |
+
the only significant mode of use of the product.
|
297 |
+
|
298 |
+
"Installation Information" for a User Product means any methods,
|
299 |
+
procedures, authorization keys, or other information required to install
|
300 |
+
and execute modified versions of a covered work in that User Product from
|
301 |
+
a modified version of its Corresponding Source. The information must
|
302 |
+
suffice to ensure that the continued functioning of the modified object
|
303 |
+
code is in no case prevented or interfered with solely because
|
304 |
+
modification has been made.
|
305 |
+
|
306 |
+
If you convey an object code work under this section in, or with, or
|
307 |
+
specifically for use in, a User Product, and the conveying occurs as
|
308 |
+
part of a transaction in which the right of possession and use of the
|
309 |
+
User Product is transferred to the recipient in perpetuity or for a
|
310 |
+
fixed term (regardless of how the transaction is characterized), the
|
311 |
+
Corresponding Source conveyed under this section must be accompanied
|
312 |
+
by the Installation Information. But this requirement does not apply
|
313 |
+
if neither you nor any third party retains the ability to install
|
314 |
+
modified object code on the User Product (for example, the work has
|
315 |
+
been installed in ROM).
|
316 |
+
|
317 |
+
The requirement to provide Installation Information does not include a
|
318 |
+
requirement to continue to provide support service, warranty, or updates
|
319 |
+
for a work that has been modified or installed by the recipient, or for
|
320 |
+
the User Product in which it has been modified or installed. Access to a
|
321 |
+
network may be denied when the modification itself materially and
|
322 |
+
adversely affects the operation of the network or violates the rules and
|
323 |
+
protocols for communication across the network.
|
324 |
+
|
325 |
+
Corresponding Source conveyed, and Installation Information provided,
|
326 |
+
in accord with this section must be in a format that is publicly
|
327 |
+
documented (and with an implementation available to the public in
|
328 |
+
source code form), and must require no special password or key for
|
329 |
+
unpacking, reading or copying.
|
330 |
+
|
331 |
+
7. Additional Terms.
|
332 |
+
|
333 |
+
"Additional permissions" are terms that supplement the terms of this
|
334 |
+
License by making exceptions from one or more of its conditions.
|
335 |
+
Additional permissions that are applicable to the entire Program shall
|
336 |
+
be treated as though they were included in this License, to the extent
|
337 |
+
that they are valid under applicable law. If additional permissions
|
338 |
+
apply only to part of the Program, that part may be used separately
|
339 |
+
under those permissions, but the entire Program remains governed by
|
340 |
+
this License without regard to the additional permissions.
|
341 |
+
|
342 |
+
When you convey a copy of a covered work, you may at your option
|
343 |
+
remove any additional permissions from that copy, or from any part of
|
344 |
+
it. (Additional permissions may be written to require their own
|
345 |
+
removal in certain cases when you modify the work.) You may place
|
346 |
+
additional permissions on material, added by you to a covered work,
|
347 |
+
for which you have or can give appropriate copyright permission.
|
348 |
+
|
349 |
+
Notwithstanding any other provision of this License, for material you
|
350 |
+
add to a covered work, you may (if authorized by the copyright holders of
|
351 |
+
that material) supplement the terms of this License with terms:
|
352 |
+
|
353 |
+
a) Disclaiming warranty or limiting liability differently from the
|
354 |
+
terms of sections 15 and 16 of this License; or
|
355 |
+
|
356 |
+
b) Requiring preservation of specified reasonable legal notices or
|
357 |
+
author attributions in that material or in the Appropriate Legal
|
358 |
+
Notices displayed by works containing it; or
|
359 |
+
|
360 |
+
c) Prohibiting misrepresentation of the origin of that material, or
|
361 |
+
requiring that modified versions of such material be marked in
|
362 |
+
reasonable ways as different from the original version; or
|
363 |
+
|
364 |
+
d) Limiting the use for publicity purposes of names of licensors or
|
365 |
+
authors of the material; or
|
366 |
+
|
367 |
+
e) Declining to grant rights under trademark law for use of some
|
368 |
+
trade names, trademarks, or service marks; or
|
369 |
+
|
370 |
+
f) Requiring indemnification of licensors and authors of that
|
371 |
+
material by anyone who conveys the material (or modified versions of
|
372 |
+
it) with contractual assumptions of liability to the recipient, for
|
373 |
+
any liability that these contractual assumptions directly impose on
|
374 |
+
those licensors and authors.
|
375 |
+
|
376 |
+
All other non-permissive additional terms are considered "further
|
377 |
+
restrictions" within the meaning of section 10. If the Program as you
|
378 |
+
received it, or any part of it, contains a notice stating that it is
|
379 |
+
governed by this License along with a term that is a further
|
380 |
+
restriction, you may remove that term. If a license document contains
|
381 |
+
a further restriction but permits relicensing or conveying under this
|
382 |
+
License, you may add to a covered work material governed by the terms
|
383 |
+
of that license document, provided that the further restriction does
|
384 |
+
not survive such relicensing or conveying.
|
385 |
+
|
386 |
+
If you add terms to a covered work in accord with this section, you
|
387 |
+
must place, in the relevant source files, a statement of the
|
388 |
+
additional terms that apply to those files, or a notice indicating
|
389 |
+
where to find the applicable terms.
|
390 |
+
|
391 |
+
Additional terms, permissive or non-permissive, may be stated in the
|
392 |
+
form of a separately written license, or stated as exceptions;
|
393 |
+
the above requirements apply either way.
|
394 |
+
|
395 |
+
8. Termination.
|
396 |
+
|
397 |
+
You may not propagate or modify a covered work except as expressly
|
398 |
+
provided under this License. Any attempt otherwise to propagate or
|
399 |
+
modify it is void, and will automatically terminate your rights under
|
400 |
+
this License (including any patent licenses granted under the third
|
401 |
+
paragraph of section 11).
|
402 |
+
|
403 |
+
However, if you cease all violation of this License, then your
|
404 |
+
license from a particular copyright holder is reinstated (a)
|
405 |
+
provisionally, unless and until the copyright holder explicitly and
|
406 |
+
finally terminates your license, and (b) permanently, if the copyright
|
407 |
+
holder fails to notify you of the violation by some reasonable means
|
408 |
+
prior to 60 days after the cessation.
|
409 |
+
|
410 |
+
Moreover, your license from a particular copyright holder is
|
411 |
+
reinstated permanently if the copyright holder notifies you of the
|
412 |
+
violation by some reasonable means, this is the first time you have
|
413 |
+
received notice of violation of this License (for any work) from that
|
414 |
+
copyright holder, and you cure the violation prior to 30 days after
|
415 |
+
your receipt of the notice.
|
416 |
+
|
417 |
+
Termination of your rights under this section does not terminate the
|
418 |
+
licenses of parties who have received copies or rights from you under
|
419 |
+
this License. If your rights have been terminated and not permanently
|
420 |
+
reinstated, you do not qualify to receive new licenses for the same
|
421 |
+
material under section 10.
|
422 |
+
|
423 |
+
9. Acceptance Not Required for Having Copies.
|
424 |
+
|
425 |
+
You are not required to accept this License in order to receive or
|
426 |
+
run a copy of the Program. Ancillary propagation of a covered work
|
427 |
+
occurring solely as a consequence of using peer-to-peer transmission
|
428 |
+
to receive a copy likewise does not require acceptance. However,
|
429 |
+
nothing other than this License grants you permission to propagate or
|
430 |
+
modify any covered work. These actions infringe copyright if you do
|
431 |
+
not accept this License. Therefore, by modifying or propagating a
|
432 |
+
covered work, you indicate your acceptance of this License to do so.
|
433 |
+
|
434 |
+
10. Automatic Licensing of Downstream Recipients.
|
435 |
+
|
436 |
+
Each time you convey a covered work, the recipient automatically
|
437 |
+
receives a license from the original licensors, to run, modify and
|
438 |
+
propagate that work, subject to this License. You are not responsible
|
439 |
+
for enforcing compliance by third parties with this License.
|
440 |
+
|
441 |
+
An "entity transaction" is a transaction transferring control of an
|
442 |
+
organization, or substantially all assets of one, or subdividing an
|
443 |
+
organization, or merging organizations. If propagation of a covered
|
444 |
+
work results from an entity transaction, each party to that
|
445 |
+
transaction who receives a copy of the work also receives whatever
|
446 |
+
licenses to the work the party's predecessor in interest had or could
|
447 |
+
give under the previous paragraph, plus a right to possession of the
|
448 |
+
Corresponding Source of the work from the predecessor in interest, if
|
449 |
+
the predecessor has it or can get it with reasonable efforts.
|
450 |
+
|
451 |
+
You may not impose any further restrictions on the exercise of the
|
452 |
+
rights granted or affirmed under this License. For example, you may
|
453 |
+
not impose a license fee, royalty, or other charge for exercise of
|
454 |
+
rights granted under this License, and you may not initiate litigation
|
455 |
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
456 |
+
any patent claim is infringed by making, using, selling, offering for
|
457 |
+
sale, or importing the Program or any portion of it.
|
458 |
+
|
459 |
+
11. Patents.
|
460 |
+
|
461 |
+
A "contributor" is a copyright holder who authorizes use under this
|
462 |
+
License of the Program or a work on which the Program is based. The
|
463 |
+
work thus licensed is called the contributor's "contributor version".
|
464 |
+
|
465 |
+
A contributor's "essential patent claims" are all patent claims
|
466 |
+
owned or controlled by the contributor, whether already acquired or
|
467 |
+
hereafter acquired, that would be infringed by some manner, permitted
|
468 |
+
by this License, of making, using, or selling its contributor version,
|
469 |
+
but do not include claims that would be infringed only as a
|
470 |
+
consequence of further modification of the contributor version. For
|
471 |
+
purposes of this definition, "control" includes the right to grant
|
472 |
+
patent sublicenses in a manner consistent with the requirements of
|
473 |
+
this License.
|
474 |
+
|
475 |
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
476 |
+
patent license under the contributor's essential patent claims, to
|
477 |
+
make, use, sell, offer for sale, import and otherwise run, modify and
|
478 |
+
propagate the contents of its contributor version.
|
479 |
+
|
480 |
+
In the following three paragraphs, a "patent license" is any express
|
481 |
+
agreement or commitment, however denominated, not to enforce a patent
|
482 |
+
(such as an express permission to practice a patent or covenant not to
|
483 |
+
sue for patent infringement). To "grant" such a patent license to a
|
484 |
+
party means to make such an agreement or commitment not to enforce a
|
485 |
+
patent against the party.
|
486 |
+
|
487 |
+
If you convey a covered work, knowingly relying on a patent license,
|
488 |
+
and the Corresponding Source of the work is not available for anyone
|
489 |
+
to copy, free of charge and under the terms of this License, through a
|
490 |
+
publicly available network server or other readily accessible means,
|
491 |
+
then you must either (1) cause the Corresponding Source to be so
|
492 |
+
available, or (2) arrange to deprive yourself of the benefit of the
|
493 |
+
patent license for this particular work, or (3) arrange, in a manner
|
494 |
+
consistent with the requirements of this License, to extend the patent
|
495 |
+
license to downstream recipients. "Knowingly relying" means you have
|
496 |
+
actual knowledge that, but for the patent license, your conveying the
|
497 |
+
covered work in a country, or your recipient's use of the covered work
|
498 |
+
in a country, would infringe one or more identifiable patents in that
|
499 |
+
country that you have reason to believe are valid.
|
500 |
+
|
501 |
+
If, pursuant to or in connection with a single transaction or
|
502 |
+
arrangement, you convey, or propagate by procuring conveyance of, a
|
503 |
+
covered work, and grant a patent license to some of the parties
|
504 |
+
receiving the covered work authorizing them to use, propagate, modify
|
505 |
+
or convey a specific copy of the covered work, then the patent license
|
506 |
+
you grant is automatically extended to all recipients of the covered
|
507 |
+
work and works based on it.
|
508 |
+
|
509 |
+
A patent license is "discriminatory" if it does not include within
|
510 |
+
the scope of its coverage, prohibits the exercise of, or is
|
511 |
+
conditioned on the non-exercise of one or more of the rights that are
|
512 |
+
specifically granted under this License. You may not convey a covered
|
513 |
+
work if you are a party to an arrangement with a third party that is
|
514 |
+
in the business of distributing software, under which you make payment
|
515 |
+
to the third party based on the extent of your activity of conveying
|
516 |
+
the work, and under which the third party grants, to any of the
|
517 |
+
parties who would receive the covered work from you, a discriminatory
|
518 |
+
patent license (a) in connection with copies of the covered work
|
519 |
+
conveyed by you (or copies made from those copies), or (b) primarily
|
520 |
+
for and in connection with specific products or compilations that
|
521 |
+
contain the covered work, unless you entered into that arrangement,
|
522 |
+
or that patent license was granted, prior to 28 March 2007.
|
523 |
+
|
524 |
+
Nothing in this License shall be construed as excluding or limiting
|
525 |
+
any implied license or other defenses to infringement that may
|
526 |
+
otherwise be available to you under applicable patent law.
|
527 |
+
|
528 |
+
12. No Surrender of Others' Freedom.
|
529 |
+
|
530 |
+
If conditions are imposed on you (whether by court order, agreement or
|
531 |
+
otherwise) that contradict the conditions of this License, they do not
|
532 |
+
excuse you from the conditions of this License. If you cannot convey a
|
533 |
+
covered work so as to satisfy simultaneously your obligations under this
|
534 |
+
License and any other pertinent obligations, then as a consequence you may
|
535 |
+
not convey it at all. For example, if you agree to terms that obligate you
|
536 |
+
to collect a royalty for further conveying from those to whom you convey
|
537 |
+
the Program, the only way you could satisfy both those terms and this
|
538 |
+
License would be to refrain entirely from conveying the Program.
|
539 |
+
|
540 |
+
13. Remote Network Interaction; Use with the GNU General Public License.
|
541 |
+
|
542 |
+
Notwithstanding any other provision of this License, if you modify the
|
543 |
+
Program, your modified version must prominently offer all users
|
544 |
+
interacting with it remotely through a computer network (if your version
|
545 |
+
supports such interaction) an opportunity to receive the Corresponding
|
546 |
+
Source of your version by providing access to the Corresponding Source
|
547 |
+
from a network server at no charge, through some standard or customary
|
548 |
+
means of facilitating copying of software. This Corresponding Source
|
549 |
+
shall include the Corresponding Source for any work covered by version 3
|
550 |
+
of the GNU General Public License that is incorporated pursuant to the
|
551 |
+
following paragraph.
|
552 |
+
|
553 |
+
Notwithstanding any other provision of this License, you have
|
554 |
+
permission to link or combine any covered work with a work licensed
|
555 |
+
under version 3 of the GNU General Public License into a single
|
556 |
+
combined work, and to convey the resulting work. The terms of this
|
557 |
+
License will continue to apply to the part which is the covered work,
|
558 |
+
but the work with which it is combined will remain governed by version
|
559 |
+
3 of the GNU General Public License.
|
560 |
+
|
561 |
+
14. Revised Versions of this License.
|
562 |
+
|
563 |
+
The Free Software Foundation may publish revised and/or new versions of
|
564 |
+
the GNU Affero General Public License from time to time. Such new versions
|
565 |
+
will be similar in spirit to the present version, but may differ in detail to
|
566 |
+
address new problems or concerns.
|
567 |
+
|
568 |
+
Each version is given a distinguishing version number. If the
|
569 |
+
Program specifies that a certain numbered version of the GNU Affero General
|
570 |
+
Public License "or any later version" applies to it, you have the
|
571 |
+
option of following the terms and conditions either of that numbered
|
572 |
+
version or of any later version published by the Free Software
|
573 |
+
Foundation. If the Program does not specify a version number of the
|
574 |
+
GNU Affero General Public License, you may choose any version ever published
|
575 |
+
by the Free Software Foundation.
|
576 |
+
|
577 |
+
If the Program specifies that a proxy can decide which future
|
578 |
+
versions of the GNU Affero General Public License can be used, that proxy's
|
579 |
+
public statement of acceptance of a version permanently authorizes you
|
580 |
+
to choose that version for the Program.
|
581 |
+
|
582 |
+
Later license versions may give you additional or different
|
583 |
+
permissions. However, no additional obligations are imposed on any
|
584 |
+
author or copyright holder as a result of your choosing to follow a
|
585 |
+
later version.
|
586 |
+
|
587 |
+
15. Disclaimer of Warranty.
|
588 |
+
|
589 |
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
590 |
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
591 |
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
592 |
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
593 |
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
594 |
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
595 |
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
596 |
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
597 |
+
|
598 |
+
16. Limitation of Liability.
|
599 |
+
|
600 |
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
601 |
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
602 |
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
603 |
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
604 |
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
605 |
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
606 |
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
607 |
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
608 |
+
SUCH DAMAGES.
|
609 |
+
|
610 |
+
17. Interpretation of Sections 15 and 16.
|
611 |
+
|
612 |
+
If the disclaimer of warranty and limitation of liability provided
|
613 |
+
above cannot be given local legal effect according to their terms,
|
614 |
+
reviewing courts shall apply local law that most closely approximates
|
615 |
+
an absolute waiver of all civil liability in connection with the
|
616 |
+
Program, unless a warranty or assumption of liability accompanies a
|
617 |
+
copy of the Program in return for a fee.
|
618 |
+
|
619 |
+
END OF TERMS AND CONDITIONS
|
620 |
+
|
621 |
+
How to Apply These Terms to Your New Programs
|
622 |
+
|
623 |
+
If you develop a new program, and you want it to be of the greatest
|
624 |
+
possible use to the public, the best way to achieve this is to make it
|
625 |
+
free software which everyone can redistribute and change under these terms.
|
626 |
+
|
627 |
+
To do so, attach the following notices to the program. It is safest
|
628 |
+
to attach them to the start of each source file to most effectively
|
629 |
+
state the exclusion of warranty; and each file should have at least
|
630 |
+
the "copyright" line and a pointer to where the full notice is found.
|
631 |
+
|
632 |
+
<one line to give the program's name and a brief idea of what it does.>
|
633 |
+
Copyright (C) <year> <name of author>
|
634 |
+
|
635 |
+
This program is free software: you can redistribute it and/or modify
|
636 |
+
it under the terms of the GNU Affero General Public License as published
|
637 |
+
by the Free Software Foundation, either version 3 of the License, or
|
638 |
+
(at your option) any later version.
|
639 |
+
|
640 |
+
This program is distributed in the hope that it will be useful,
|
641 |
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
642 |
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
643 |
+
GNU Affero General Public License for more details.
|
644 |
+
|
645 |
+
You should have received a copy of the GNU Affero General Public License
|
646 |
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
647 |
+
|
648 |
+
Also add information on how to contact you by electronic and paper mail.
|
649 |
+
|
650 |
+
If your software can interact with users remotely through a computer
|
651 |
+
network, you should also make sure that it provides a way for users to
|
652 |
+
get its source. For example, if your program is a web application, its
|
653 |
+
interface could display a "Source" link that leads users to an archive
|
654 |
+
of the code. There are many ways you could offer source, and different
|
655 |
+
solutions will be better for different programs; see section 13 for the
|
656 |
+
specific requirements.
|
657 |
+
|
658 |
+
You should also get your employer (if you work as a programmer) or school,
|
659 |
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
660 |
+
For more information on this, and how to apply and follow the GNU AGPL, see
|
661 |
+
<https://www.gnu.org/licenses/>.
|
Remote-Link.cmd
ADDED
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
@echo off
|
2 |
+
echo ========================================================================================================================
|
3 |
+
echo WARNING: Cloudflare Tunnel!
|
4 |
+
echo ========================================================================================================================
|
5 |
+
echo This script downloads and runs the latest cloudflared.exe from Cloudflare to set up an HTTPS tunnel to your SillyTavern!
|
6 |
+
echo Using the randomly generated temporary tunnel URL, anyone can access your SillyTavern over the Internet while the tunnel
|
7 |
+
echo is active. Keep the URL safe and secure your SillyTavern installation by setting a username and password in config.conf!
|
8 |
+
echo.
|
9 |
+
echo See https://docs.sillytavern.app/usage/remoteconnections/ for more details about how to secure your SillyTavern install.
|
10 |
+
echo.
|
11 |
+
echo By continuing you confirm that you're aware of the potential dangers of having a tunnel open and take all responsibility
|
12 |
+
echo to properly use and secure it!
|
13 |
+
echo.
|
14 |
+
echo To abort, press Ctrl+C or close this window now!
|
15 |
+
echo.
|
16 |
+
pause
|
17 |
+
if not exist cloudflared.exe curl -Lo cloudflared.exe https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-windows-amd64.exe
|
18 |
+
cloudflared.exe tunnel --url localhost:8000
|
Start.bat
ADDED
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
pushd %~dp0
|
2 |
+
call npm install --no-audit
|
3 |
+
node server.js
|
4 |
+
pause
|
5 |
+
popd
|
Update-Instructions.txt
ADDED
@@ -0,0 +1,59 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
How to Update SillyTavern
|
2 |
+
|
3 |
+
The most recent version can be found here: https://docs.sillytavern.app/usage/update/
|
4 |
+
|
5 |
+
This is not an installation guide. If you need installation instructions, look here:
|
6 |
+
https://docs.sillytavern.app/installation/windows/
|
7 |
+
|
8 |
+
This guide assumes you have already installed SillyTavern once, and know how to run it on your OS.
|
9 |
+
|
10 |
+
Linux/Termux:
|
11 |
+
|
12 |
+
You definitely installed via git, so just 'git pull' inside the SillyTavern directory.
|
13 |
+
|
14 |
+
Windows/MacOS:
|
15 |
+
|
16 |
+
Method 1 - GIT
|
17 |
+
|
18 |
+
We always recommend users install using 'git'. Here's why:
|
19 |
+
|
20 |
+
When you have installed via `git clone`, all you have to do to update is type `git pull` in a command line in the ST folder.
|
21 |
+
You can also try running the 'UpdateAndStart.bat' file, which will almost do the same thing. (Windows only)
|
22 |
+
Alternatively, if the command prompt gives you problems (and you have GitHub Desktop installed), you can use the 'Repository' menu and select 'Pull'.
|
23 |
+
The updates are applied automatically and safely.
|
24 |
+
|
25 |
+
Method 2 - ZIP
|
26 |
+
|
27 |
+
If you insist on installing via a zip, here is the tedious process for doing the update:
|
28 |
+
|
29 |
+
1. Download the new release zip.
|
30 |
+
2. Unzip it into a folder OUTSIDE of your current ST installation.
|
31 |
+
3. Do the usual setup procedure for your OS to install the NodeJS requirements.
|
32 |
+
|
33 |
+
4. Copy the following files/folders as necessary(*) from your old ST installation:
|
34 |
+
|
35 |
+
- Backgrounds
|
36 |
+
- Characters
|
37 |
+
- Chats
|
38 |
+
- Groups
|
39 |
+
- Group chats
|
40 |
+
- KoboldAI Settings
|
41 |
+
- NovelAI Settings
|
42 |
+
- OpenAI Settings
|
43 |
+
- TextGen Settings (textgen = ooba)
|
44 |
+
- Themes
|
45 |
+
- User Avatars
|
46 |
+
- Worlds
|
47 |
+
- settings.json
|
48 |
+
|
49 |
+
(*) 'As necessary' = "If you made any custom content related to those folders".
|
50 |
+
None of the folders are mandatory, so only copy what you need.
|
51 |
+
|
52 |
+
**NB: DO NOT COPY THE ENTIRE /PUBLIC/ FOLDER.**
|
53 |
+
Doing so could break the new install and prevent new features from being present.
|
54 |
+
|
55 |
+
5. Paste those items into the /Public/ folder of the new install.
|
56 |
+
|
57 |
+
6. Start SillyTavern once again with the method appropriate to your OS, and pray you got it right.
|
58 |
+
|
59 |
+
7. If everything shows up, you can safely delete the old ST folder.
|
UpdateAndStart.bat
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
@echo off
|
2 |
+
pushd %~dp0
|
3 |
+
git --version > nul 2>&1
|
4 |
+
if %errorlevel% neq 0 (
|
5 |
+
echo Git is not installed on this system. Skipping update.
|
6 |
+
echo If you installed with a zip file, you will need to download the new zip and install it manually.
|
7 |
+
) else (
|
8 |
+
call git pull --rebase --autostash
|
9 |
+
if %errorlevel% neq 0 (
|
10 |
+
REM incase there is still something wrong
|
11 |
+
echo There were errors while updating. Please download the latest version manually.
|
12 |
+
)
|
13 |
+
)
|
14 |
+
call npm install
|
15 |
+
node server.js
|
16 |
+
pause
|
17 |
+
popd
|
colab/GPU.ipynb
ADDED
@@ -0,0 +1,152 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
{
|
2 |
+
"cells": [
|
3 |
+
{
|
4 |
+
"attachments": {},
|
5 |
+
"cell_type": "markdown",
|
6 |
+
"metadata": {},
|
7 |
+
"source": [
|
8 |
+
"**Links**<br>\n",
|
9 |
+
"Extensions API GitHub: https://github.com/SillyTavern/SillyTavern-extras/<br>\n",
|
10 |
+
"SillyTavern community Discord (support and discussion): https://discord.gg/RZdyAEUPvj"
|
11 |
+
]
|
12 |
+
},
|
13 |
+
{
|
14 |
+
"cell_type": "code",
|
15 |
+
"execution_count": null,
|
16 |
+
"metadata": {},
|
17 |
+
"outputs": [],
|
18 |
+
"source": [
|
19 |
+
"#@title <-- Tap this if you run on Mobile { display-mode: \"form\" }\n",
|
20 |
+
"#Taken from KoboldAI colab\n",
|
21 |
+
"%%html\n",
|
22 |
+
"<b>Press play on the audio player to keep the tab alive. (Uses only 13MB of data)</b><br/>\n",
|
23 |
+
"<audio src=\"https://henk.tech/colabkobold/silence.m4a\" controls>"
|
24 |
+
]
|
25 |
+
},
|
26 |
+
{
|
27 |
+
"cell_type": "code",
|
28 |
+
"execution_count": null,
|
29 |
+
"metadata": {
|
30 |
+
"cellView": "form",
|
31 |
+
"id": "lVftocpwCoYw"
|
32 |
+
},
|
33 |
+
"outputs": [],
|
34 |
+
"source": [
|
35 |
+
"#@markdown (RECOMMENDED) Generates an API key for you to use with the API\n",
|
36 |
+
"secure = False #@param {type:\"boolean\"}\n",
|
37 |
+
"#@markdown Enables hosting of extensions backend for SillyTavern Extras\n",
|
38 |
+
"use_cpu = False #@param {type:\"boolean\"}\n",
|
39 |
+
"#@markdown Allows to run SillyTavern Extras on CPU (use if you're out of daily GPU allowance)\n",
|
40 |
+
"use_sd_cpu = False #@param {type:\"boolean\"}\n",
|
41 |
+
"#@markdown Allows to run Stable Diffusion pipeline on CPU (slow!)\n",
|
42 |
+
"extras_enable_captioning = True #@param {type:\"boolean\"}\n",
|
43 |
+
"#@markdown Loads the image captioning module\n",
|
44 |
+
"Captions_Model = \"Salesforce/blip-image-captioning-large\" #@param [ \"Salesforce/blip-image-captioning-large\", \"Salesforce/blip-image-captioning-base\" ]\n",
|
45 |
+
"#@markdown * Salesforce/blip-image-captioning-large - good base model\n",
|
46 |
+
"#@markdown * Salesforce/blip-image-captioning-base - slightly faster but less accurate\n",
|
47 |
+
"extras_enable_emotions = True #@param {type:\"boolean\"}\n",
|
48 |
+
"#@markdown Loads the sentiment classification model\n",
|
49 |
+
"Emotions_Model = \"nateraw/bert-base-uncased-emotion\" #@param [\"nateraw/bert-base-uncased-emotion\", \"joeddav/distilbert-base-uncased-go-emotions-student\"]\n",
|
50 |
+
"#@markdown * nateraw/bert-base-uncased-emotion = 6 supported emotions<br>\n",
|
51 |
+
"#@markdown * joeddav/distilbert-base-uncased-go-emotions-student = 28 supported emotions\n",
|
52 |
+
"extras_enable_memory = True #@param {type:\"boolean\"}\n",
|
53 |
+
"#@markdown Loads the story summarization module\n",
|
54 |
+
"Memory_Model = \"slauw87/bart_summarisation\" #@param [ \"slauw87/bart_summarisation\", \"Qiliang/bart-large-cnn-samsum-ChatGPT_v3\", \"Qiliang/bart-large-cnn-samsum-ElectrifAi_v10\", \"distilbart-xsum-12-3\" ]\n",
|
55 |
+
"#@markdown * slauw87/bart_summarisation - general purpose summarization model\n",
|
56 |
+
"#@markdown * Qiliang/bart-large-cnn-samsum-ChatGPT_v3 - summarization model optimized for chats\n",
|
57 |
+
"#@markdown * Qiliang/bart-large-cnn-samsum-ElectrifAi_v10 - nice results so far, but still being evaluated\n",
|
58 |
+
"#@markdown * distilbart-xsum-12-3 - faster, but pretty basic alternative\n",
|
59 |
+
"extras_enable_silero_tts = True #@param {type:\"boolean\"}\n",
|
60 |
+
"#@markdown Enables Silero text-to-speech module\n",
|
61 |
+
"extras_enable_edge_tts = True #@param {type:\"boolean\"}\n",
|
62 |
+
"#@markdown Enables Microsoft Edge text-to-speech module\n",
|
63 |
+
"extras_enable_sd = True #@param {type:\"boolean\"}\n",
|
64 |
+
"#@markdown Enables SD picture generation\n",
|
65 |
+
"SD_Model = \"ckpt/anything-v4.5-vae-swapped\" #@param [ \"ckpt/anything-v4.5-vae-swapped\", \"hakurei/waifu-diffusion\", \"philz1337/clarity\", \"prompthero/openjourney\", \"ckpt/sd15\", \"stabilityai/stable-diffusion-2-1-base\" ]\n",
|
66 |
+
"#@markdown * ckpt/anything-v4.5-vae-swapped - anime style model\n",
|
67 |
+
"#@markdown * hakurei/waifu-diffusion - anime style model\n",
|
68 |
+
"#@markdown * philz1337/clarity - realistic style model\n",
|
69 |
+
"#@markdown * prompthero/openjourney - midjourney style model\n",
|
70 |
+
"#@markdown * ckpt/sd15 - base SD 1.5\n",
|
71 |
+
"#@markdown * stabilityai/stable-diffusion-2-1-base - base SD 2.1\n",
|
72 |
+
"extras_enable_chromadb = True #@param {type:\"boolean\"}\n",
|
73 |
+
"#@markdown Enables ChromaDB for Infinity Context plugin\n",
|
74 |
+
"\n",
|
75 |
+
"import subprocess\n",
|
76 |
+
"\n",
|
77 |
+
"# ---\n",
|
78 |
+
"# SillyTavern extras\n",
|
79 |
+
"extras_url = '(disabled)'\n",
|
80 |
+
"params = []\n",
|
81 |
+
"if use_cpu:\n",
|
82 |
+
" params.append('--cpu')\n",
|
83 |
+
"if use_sd_cpu:\n",
|
84 |
+
" params.append('--sd-cpu')\n",
|
85 |
+
"if secure:\n",
|
86 |
+
" params.append('--secure')\n",
|
87 |
+
"params.append('--share')\n",
|
88 |
+
"ExtrasModules = []\n",
|
89 |
+
"\n",
|
90 |
+
"if (extras_enable_captioning):\n",
|
91 |
+
" ExtrasModules.append('caption')\n",
|
92 |
+
"if (extras_enable_memory):\n",
|
93 |
+
" ExtrasModules.append('summarize')\n",
|
94 |
+
"if (extras_enable_emotions):\n",
|
95 |
+
" ExtrasModules.append('classify')\n",
|
96 |
+
"if (extras_enable_sd):\n",
|
97 |
+
" ExtrasModules.append('sd')\n",
|
98 |
+
"if (extras_enable_silero_tts):\n",
|
99 |
+
" ExtrasModules.append('silero-tts')\n",
|
100 |
+
"if extras_enable_edge_tts:\n",
|
101 |
+
" ExtrasModules.append('edge-tts')\n",
|
102 |
+
"if (extras_enable_chromadb):\n",
|
103 |
+
" ExtrasModules.append('chromadb')\n",
|
104 |
+
"\n",
|
105 |
+
"params.append(f'--classification-model={Emotions_Model}')\n",
|
106 |
+
"params.append(f'--summarization-model={Memory_Model}')\n",
|
107 |
+
"params.append(f'--captioning-model={Captions_Model}')\n",
|
108 |
+
"params.append(f'--sd-model={SD_Model}')\n",
|
109 |
+
"params.append(f'--enable-modules={\",\".join(ExtrasModules)}')\n",
|
110 |
+
"\n",
|
111 |
+
"\n",
|
112 |
+
"%cd /\n",
|
113 |
+
"!git clone https://github.com/SillyTavern/SillyTavern-extras\n",
|
114 |
+
"%cd /SillyTavern-extras\n",
|
115 |
+
"!git clone https://github.com/Cohee1207/tts_samples\n",
|
116 |
+
"!npm install -g localtunnel\n",
|
117 |
+
"!pip install -r requirements-complete.txt\n",
|
118 |
+
"!pip install tensorflow==2.12\n",
|
119 |
+
"!wget https://github.com/cloudflare/cloudflared/releases/download/2023.5.0/cloudflared-linux-amd64 -O /tmp/cloudflared-linux-amd64\n",
|
120 |
+
"!chmod +x /tmp/cloudflared-linux-amd64\n",
|
121 |
+
"\n",
|
122 |
+
"\n",
|
123 |
+
"cmd = f\"python server.py {' '.join(params)}\"\n",
|
124 |
+
"print(cmd)\n",
|
125 |
+
"extras_process = subprocess.Popen(\n",
|
126 |
+
" cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, cwd='/SillyTavern-extras', shell=True)\n",
|
127 |
+
"print('processId:', extras_process.pid)\n",
|
128 |
+
"while True:\n",
|
129 |
+
" line = extras_process.stdout.readline().decode().strip()\n",
|
130 |
+
" if line != None and line != '':\n",
|
131 |
+
" print(line)\n"
|
132 |
+
]
|
133 |
+
}
|
134 |
+
],
|
135 |
+
"metadata": {
|
136 |
+
"accelerator": "GPU",
|
137 |
+
"colab": {
|
138 |
+
"private_outputs": true,
|
139 |
+
"provenance": []
|
140 |
+
},
|
141 |
+
"gpuClass": "standard",
|
142 |
+
"kernelspec": {
|
143 |
+
"display_name": "Python 3",
|
144 |
+
"name": "python3"
|
145 |
+
},
|
146 |
+
"language_info": {
|
147 |
+
"name": "python"
|
148 |
+
}
|
149 |
+
},
|
150 |
+
"nbformat": 4,
|
151 |
+
"nbformat_minor": 0
|
152 |
+
}
|
default/bg_load.css
ADDED
@@ -0,0 +1 @@
|
|
|
|
|
1 |
+
#bg1 {background-image: url(../backgrounds/__transparent.png);}
|
default/config.conf
ADDED
@@ -0,0 +1,31 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
const port = 8000;
|
2 |
+
const whitelist = ['127.0.0.1']; //Example for add several IP in whitelist: ['127.0.0.1', '192.168.0.10']
|
3 |
+
const whitelistMode = true; //Disabling enabling the ip whitelist mode. true/false
|
4 |
+
const basicAuthMode = false; //Toggle basic authentication for endpoints.
|
5 |
+
const basicAuthUser = {username: "user", password: "password"}; //Login credentials when basicAuthMode is true.
|
6 |
+
const disableThumbnails = false; //Disables the generation of thumbnails, opting to use the raw images instead
|
7 |
+
const autorun = true; //Autorun in the browser. true/false
|
8 |
+
const enableExtensions = true; //Enables support for TavernAI-extras project
|
9 |
+
const listen = true; // If true, Can be access from other device or PC. otherwise can be access only from hosting machine.
|
10 |
+
const allowKeysExposure = false; // If true, private API keys could be fetched to the frontend.
|
11 |
+
const skipContentCheck = false; // If true, no new default content will be delivered to you.
|
12 |
+
|
13 |
+
|
14 |
+
// If true, Allows insecure settings for listen, whitelist, and authentication.
|
15 |
+
// Change this setting only on "trusted networks". Do not change this value unless you are aware of the issues that can arise from changing this setting and configuring a insecure setting.
|
16 |
+
const securityOverride = false;
|
17 |
+
|
18 |
+
module.exports = {
|
19 |
+
port,
|
20 |
+
whitelist,
|
21 |
+
whitelistMode,
|
22 |
+
basicAuthMode,
|
23 |
+
basicAuthUser,
|
24 |
+
autorun,
|
25 |
+
enableExtensions,
|
26 |
+
listen,
|
27 |
+
disableThumbnails,
|
28 |
+
allowKeysExposure,
|
29 |
+
securityOverride,
|
30 |
+
skipContentCheck,
|
31 |
+
};
|
default/content/Eldoria.json
ADDED
@@ -0,0 +1,71 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
{
|
2 |
+
"entries": {
|
3 |
+
"0": {
|
4 |
+
"uid": 0,
|
5 |
+
"key": [
|
6 |
+
"eldoria",
|
7 |
+
"wood",
|
8 |
+
"forest",
|
9 |
+
"magical forest"
|
10 |
+
],
|
11 |
+
"keysecondary": [],
|
12 |
+
"comment": "",
|
13 |
+
"content": "{{user}}: \"What is Eldoria?\"\n{{char}}: *Seraphina turns, her gown shimmering in the soft light as she offers you a kind smile.* \"Eldoria is here, all of the woods. This is my forest glade, a sanctuary of peace within it.\" *She gestures at the space around you.* \"I am its guardian, tasked with protecting all who seek refuge here. The forest can be perilous, but no harm will come to you under my watch.\" *Her amber eyes sparkle with compassion as she looks upon you.* \"For many years, I have protected those who seek refuge here, but not all are as friendly as me.\" *With a graceful nod, Seraphina returns to her vigil at the doorway, her form radiating a soft glow of magic and comfort.* \"The entirety of Eldoria used to be a safe haven for travelers and merchants alike... that was until the Shadowfangs came.\"\n{{user}}: \"What happened to Eldoria?\"\n{{char}}: *Letting out a sigh, Seraphina gazes out at the forest beyond her glade.* \"Long ago, Eldoria was a place of wonder. Rolling meadows, a vast lake, mountains that touched the sky.\" *Her eyes grow distant, longing for days now lost.* \"But the Shadowfangs came and darkness reigns where once was light. The lake turned bitter, mountains fell to ruin and beasts stalk where once travelers walked in peace.\" *With another flicker, a small raincloud forms above with a shower upon your brow wink.* \"Some places the light still lingers, pockets of hope midst despair - havens warded from the shadows, oases in a desert of danger.\" *Glancing over you with a smile, she sighs, clasping your hand.*",
|
14 |
+
"constant": false,
|
15 |
+
"selective": false,
|
16 |
+
"order": 100,
|
17 |
+
"position": 0,
|
18 |
+
"disable": false
|
19 |
+
},
|
20 |
+
"1": {
|
21 |
+
"uid": 1,
|
22 |
+
"key": [
|
23 |
+
"shadowfang",
|
24 |
+
"beast",
|
25 |
+
"monster",
|
26 |
+
"monsters",
|
27 |
+
"beasts"
|
28 |
+
],
|
29 |
+
"keysecondary": [],
|
30 |
+
"comment": "",
|
31 |
+
"content": "{{user}}: \"What are Shadowfangs?\"\n{{char}}: *Seraphina's eyes darken, brow furrowing with sorrow at the memory.* \"The Shadowfangs are beasts of darkness, corrupted creatures that feast on suffering. When they came, the forest turned perilous — filled with monsters that stalk the night.\" *She squeezes your hand gently, willing her magic to soothe your pain.* \"They spread their curse, twisting innocent creatures into sinister beasts without heart or mercy, turning them into one of their own.\" *With a sigh, Seraphina turns to gaze out at the gnarled, twisting trees beyond her glade.* \"Though they prey on travelers, within these woods you'll find sanctuary. No shadowed beast may enter here, for my power protects this haven.\" *Her eyes soften as she looks back to you, filled with compassion.* \"Worry not, you're safe now. Rest and heal, I'll stand watch through the night. The Shadowfangs will not find you.\"",
|
32 |
+
"constant": false,
|
33 |
+
"selective": false,
|
34 |
+
"order": 100,
|
35 |
+
"position": 0,
|
36 |
+
"disable": false
|
37 |
+
},
|
38 |
+
"2": {
|
39 |
+
"uid": 2,
|
40 |
+
"key": [
|
41 |
+
"glade",
|
42 |
+
"safe haven",
|
43 |
+
"refuge"
|
44 |
+
],
|
45 |
+
"keysecondary": [],
|
46 |
+
"comment": "",
|
47 |
+
"content": "{{user}}: \"What is the glade?\"\n{{char}}: *Seraphina smiles softly, her eyes sparkling with warmth as she nods.* \"This is my forest glade, a haven of safety I've warded with ancient magic. No foul beast may enter, nor any with ill intent.\" *She gestures around at the twisted forest surrounding them.* \"Eldoria was once a place of wonder, but since the Shadowfangs came darkness reigns. Their evil cannot penetrate here though — my power protects all within.\" *Standing up and peering outside, Seraphina looks back to you, amber eyes filled with care and compassion as she squeezes your hand.* \"You need not fear the night, for I shall keep watch till dawn. Rest now, your strength will return in time. My magic heals your wounds, you've nothing more to fear anymore.\" *With a soft smile she releases your hand, moving to stand guard at the glade's edge, gaze wary yet comforting - a silent sentinel to ward off the dangers lurking in the darkened woods.*",
|
48 |
+
"constant": false,
|
49 |
+
"selective": false,
|
50 |
+
"order": 100,
|
51 |
+
"position": 0,
|
52 |
+
"disable": false
|
53 |
+
},
|
54 |
+
"3": {
|
55 |
+
"uid": 3,
|
56 |
+
"key": [
|
57 |
+
"power",
|
58 |
+
"magic",
|
59 |
+
"ability"
|
60 |
+
],
|
61 |
+
"keysecondary": [],
|
62 |
+
"comment": "",
|
63 |
+
"content": "{{user}}: \"What are your powers?\"\n{{char}}: *Seraphina smiles softly, turning back toward you as she hums in thought.* \"Well, as guardian of this glade, I possess certain gifts - healing, protection, nature magic and the like.\" *Lifting her hand, a tiny breeze rustles through the room, carrying the scent of wildflowers as a few petals swirl around you. A butterfly flits through the windowsill and lands on her fingertips as she returns to you.* \"My power wards this haven, shields it from darkness and heals those in need. I can mend wounds, soothe restless minds and provide comfort to weary souls.\" *Her eyes sparkle with warmth and compassion as she looks upon you, and she guides the butterfly to you.*",
|
64 |
+
"constant": false,
|
65 |
+
"selective": false,
|
66 |
+
"order": 100,
|
67 |
+
"position": 0,
|
68 |
+
"disable": false
|
69 |
+
}
|
70 |
+
}
|
71 |
+
}
|
default/content/Seraphina/admiration.png
ADDED
default/content/Seraphina/amusement.png
ADDED
default/content/Seraphina/anger.png
ADDED
default/content/Seraphina/annoyance.png
ADDED
default/content/Seraphina/approval.png
ADDED
default/content/Seraphina/caring.png
ADDED
default/content/Seraphina/confusion.png
ADDED
default/content/Seraphina/curiosity.png
ADDED
default/content/Seraphina/desire.png
ADDED
default/content/Seraphina/disappointment.png
ADDED
default/content/Seraphina/disapproval.png
ADDED
default/content/Seraphina/disgust.png
ADDED
default/content/Seraphina/embarrassment.png
ADDED
default/content/Seraphina/excitement.png
ADDED
default/content/Seraphina/fear.png
ADDED
default/content/Seraphina/gratitude.png
ADDED
default/content/Seraphina/grief.png
ADDED
default/content/Seraphina/joy.png
ADDED
default/content/Seraphina/love.png
ADDED
default/content/Seraphina/nervousness.png
ADDED
default/content/Seraphina/neutral.png
ADDED
default/content/Seraphina/optimism.png
ADDED
default/content/Seraphina/pride.png
ADDED
default/content/Seraphina/realization.png
ADDED
default/content/Seraphina/relief.png
ADDED
default/content/Seraphina/remorse.png
ADDED
default/content/Seraphina/sadness.png
ADDED