Nocigar commited on
Commit
48e9476
1 Parent(s): 710aba8

Upload 8 files

Browse files
.github/close-label.yml ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ 🐛 Bug: ✅ Fixed
2
+ 🦄 Feature Request: ✅ Implemented
.github/issue-auto-comments.yml ADDED
@@ -0,0 +1,62 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ comment:
2
+ footer: |
3
+ ---
4
+ > I am a bot, and this is an automated message 🤖
5
+ labels:
6
+ - name: ✖️ Invalid
7
+ labeled:
8
+ issue:
9
+ action: close
10
+ body: >
11
+ Hello @{{ issue.user.login }} your ticket has been marked as invalid.
12
+ Please ensure you follow the issue template, provide all requested info,
13
+ and be sure to check the docs + previous issues prior to raising tickets.
14
+ pr:
15
+ body: Thank you @{{ pull_request.user.login }} for suggesting this. Please follow the pull request templates.
16
+ action: close
17
+
18
+ - name: 👩‍💻 Good First Issue
19
+ labeled:
20
+ issue:
21
+ body: >
22
+ This issue has been marked as a good first issue for first-time contributors to implement!
23
+ This is a great way to support the project, while also improving your skills, you'll also be credited as a contributor once your PR is merged.
24
+ If you're new to SillyTavern [here are a collection of resources](https://docs.sillytavern.app/)
25
+ If you need any support at all, feel free to reach out via [Discord](https://discord.gg/sillytavern).
26
+
27
+ - name: ❌ wontfix
28
+ labeled:
29
+ issue:
30
+ action: close
31
+ body: >
32
+ This ticked has been marked as 'wontfix', which usually means it is out-of-scope, or not feasible at this time.
33
+ You can still fork the project and make the changes yourself.
34
+
35
+ - name: ✅ Fixed
36
+ labeled:
37
+ issue:
38
+ body: >
39
+ Hello @{{ issue.user.login }}! It looks like all or part of this issue has now been implemented.
40
+
41
+
42
+ - name: ‼️ High Priority
43
+ labeled:
44
+ issue:
45
+ body: >
46
+ This ticket has been marked as high priority, and has been bumped to the top of the priority list.
47
+ You should expect an implementation to be pushed out soon. Thank you for your patience.
48
+
49
+ - name: 💀 Spam
50
+ labeled:
51
+ issue:
52
+ action: close
53
+ locking: lock
54
+ lock_reason: spam
55
+ body: >
56
+ This issue has been identified as spam, and is now locked.
57
+ Users who repeatedly raise spam issues may be blocked or reported.
58
+
59
+ - name: ⛔ Don't Merge
60
+ labeled:
61
+ pr:
62
+ body: This PR has been temporarily blocked from merging.
.github/labeler.yml ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Add/remove 'critical' label if issue contains the words 'urgent' or 'critical'
2
+ #critical:
3
+ # - '(critical|urgent)'
4
+
5
+ 🪟 Windows:
6
+ - '(🪟 Windows)'
7
+
8
+ 🍎 Mac:
9
+ - '(🍎 Mac)'
10
+
11
+ 🐋 Docker:
12
+ - '(🐋 Docker)'
13
+
14
+ 📱 Termux:
15
+ - '(📱 Termux)'
16
+
17
+ 🐧 Linux:
18
+ - '(🐧 Linux)'
.github/pull_request_template.md ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ <!-- Put X in the box below to confirm -->
2
+
3
+ ## Checklist:
4
+
5
+ - [ ] I have read the [Contributing guidelines](https://github.com/SillyTavern/SillyTavern/blob/release/CONTRIBUTING.md).
.github/readme-ja_jp.md ADDED
@@ -0,0 +1,314 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [English](readme.md) | [中文](readme-zh_cn.md) | 日本語 | [Русский](readme-ru_ru.md)
2
+
3
+ ![SillyTavern-Banner](https://github.com/SillyTavern/SillyTavern/assets/18619528/c2be4c3f-aada-4f64-87a3-ae35a68b61a4)
4
+
5
+ モバイルデバイスにも適したレイアウト・マルチAPI(KoboldAI/CPP、Horde、NovelAI、Ooba、OpenAI、OpenRouter、Claude、Scale)、VN ライクな Waifu モード、Stable Diffusion、TTS、WorldInfo(伝承本)、カスタマイズ可能なUI、自動翻訳、大量のプロンプトオプション+サードパーティの拡張機能をインストールする機能
6
+
7
+ [TavernAI](https://github.com/TavernAI/TavernAI) v.1.2.8 のフォークに基づいています。
8
+
9
+ ## 重要事項
10
+
11
+ 1. 私たちは[ドキュメントウェブサイト](https://docs.sillytavern.app/) を作成し、ほとんどの質問にお答えしています。
12
+
13
+ 2. アップデートしたら使っていた拡張機能を見失いましたか?リリースバージョン 1.10.6 以降、これまで内蔵されていた拡張機能のほとんどがダウンロード可能なアドオンに変更されました。ダウンロードは、拡張機能パネル(トップバーのスタックドブロックアイコン)にある内蔵の "Download Extensions and Assets" メニューから行えます。
14
+
15
+ ### Cohee、RossAscends、SillyTavern コミュニティがお届けします
16
+
17
+ ### SillyTavern または TavernAI とは何ですか?
18
+
19
+ SillyTavern は、あなたのコンピュータ(および Android スマホ)にインストールできるユーザーインターフェイスで、テキスト生成 AI と対話したり、あなたやコミュニティが作成したキャラクターとチャットやロールプレイをすることができます。
20
+
21
+ SillyTavern は TavernAI 1.2.8 のフォークで、より活発な開発が行われており、多くの主要な機能が追加されています。現時点では、これらは完全に独立したプログラムと考えることができます。
22
+
23
+ ### ブランチ
24
+
25
+ SillyTavern は、すべてのユーザーにスムーズな体験を保証するために、2 つのブランチシステムを使用して開発されています。
26
+
27
+ * release -🌟 **ほとんどのユーザーにお勧め。** これは最も安定した推奨ブランチで、メジャーリリースがプッシュされた時のみ更新されます。大半のユーザーに適しています。
28
+ * staging - ⚠️ **カジュアルな使用にはお勧めしない。** このブランチには最新の機能がありますが、いつ壊れるかわからないので注意してください。パワーユーザーとマニア向けです。
29
+
30
+ git CLI の使い方に慣れていなかったり、ブランチが何なのかわからなかったりしても、心配はいりません!releaseブランチが良い選択肢となります。
31
+
32
+ ### Tavern 以外に何が必要ですか?
33
+
34
+ Tavern は単なるユーザーインターフェイスなので、それだけでは何もできません。ロールプレイキャラクターとして機能する AI システムのバックエンドにアクセスする必要があります。様々なバックエンドがサポートされています。リストはこちらです: OpenAPI API (GPT)、KoboldAI (ローカルまたは Google Colab 上で動作)、その他。詳しくは [FAQ](https://docs.sillytavern.app/usage/faq/) をご覧ください。
35
+
36
+ ### Tavern を実行するには、ハイスペックなPCが必要ですか?
37
+
38
+ Tavern は単なるフロントエンドのUIであり、必要なハードウェアはごくわずかです。パワフルである必要があるのは、AI システムのバックエンドです。
39
+
40
+ ## モバイルサポート
41
+
42
+ > **注**
43
+
44
+ > **このフォークは Termux を使って Android スマホで実行できます。ArroganceComplex#2659 のガイドを参照してください:**
45
+
46
+ <https://rentry.org/STAI-Termux>
47
+
48
+ ## ご質問やご提案
49
+
50
+ ### コミュニティ Discord サーバーを開設しました
51
+
52
+ サポートを受けたり、作成したキャラを共有したり、コミュニティの作ったキャラと遊びたいですか?:
53
+
54
+ ### [参加](https://discord.gg/RZdyAEUPvj)
55
+
56
+ ***
57
+
58
+ 開発者と直接連絡:
59
+
60
+ * Discord: cohee または rossascends
61
+ * Reddit: /u/RossAscends または /u/sillylossy
62
+ * [GitHub issue を投稿](https://github.com/SillyTavern/SillyTavern/issues)
63
+
64
+ ## このバージョンには以下のコードが含まれます
65
+
66
+ * 大幅に修正された TavernAI 1.2.8 (コードの 50% 以上が書き換えまたは最適化されています)
67
+ * スワイプ
68
+ * グループチャット: キャラクター同士が会話できるマルチボットルーム
69
+ * チャットチェックポイント / ブランチ
70
+ * 高度なKoboldAI / TextGen生成設定と、コミュニティが作成した多くのプリセット
71
+ * ワールド情報サポート: 豊富な伝承を作成したり、キャ��クターカードにトークンを保存したりできます
72
+ * [OpenRouter](https://openrouter.ai) 各種 API(Claude、GPT-4/3.5 など)の接続
73
+ * [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui) API 接続
74
+ * [AI Horde](https://horde.koboldai.net/) 接続
75
+ * プロンプト生成フォーマットの調整
76
+
77
+ ## 拡張機能
78
+
79
+ SillyTavern は拡張できるようになっており、[SillyTavern Extras API](https://github.com/SillyTavern/SillyTavern-extras) でいくつかの追加AIモジュールをホストしています
80
+
81
+ * 作者ノート/キャラクターバイアス
82
+ * キャラクターの感情表現(スプライト)
83
+ * チャット履歴の自動サマリー
84
+ * チャットに画像を送り、AI が内容を解釈する
85
+ * Stable Diffusion 画像生成 (5 つのチャット関連プリセットと 'free mode')
86
+ * AI 応答メッセージの音声合成(ElevenLabs、Silero、または OS のシステム TTS 経由)
87
+
88
+ 含まれている拡張機能の完全なリストとその使い方のチュートリアルは [Docs](https://docs.sillytavern.app/) にあります。
89
+
90
+ ## RossAscends による UI/CSS/クオリティオブライフの調整
91
+
92
+ * iOS 用に最適化されたモバイル UI で、ホーム画面へのショートカット保存とフルスクリーンモードでの起動をサポート。
93
+ * ホットキー
94
+ * Up = チャットの最後のメッセージを編集する
95
+ * Ctrl+Up = チャットで最後のユーザーメッセージを編集する
96
+ * Left = 左スワイプ
97
+ * Right = 右スワイプ (注: チャットバーに何か入力されている場合、スワイプホットキーが無効になります)
98
+ * Ctrl+Left = ローカルに保存された変数を見る(ブラウザのコンソールウィンドウにて)
99
+ * Enter (チャットバー選択時) = AI にメッセージを送る
100
+ * Ctrl+Enter = 最後の AIのレスポンスを再生成する
101
+
102
+ * ユーザー名の変更と文字の削除でページが更新されなくなりました。
103
+
104
+ * ページロード時に API に自動的に接続するかどうかを切り替えます。
105
+ * ページの読み込み時に、最近見た文字を自動的に読み込むかどうかを切り替えます。
106
+ * より良いトークンカウンター - 保存されていないキャラクターに対して機能し、永続的なトークンと一時的なトークンの両方を表示する。
107
+
108
+ * より良い過去のチャット
109
+ * 新しいチャットのファイル名は、"(文字) - (作成日)" という読みやすい形式で保存されます
110
+ * チャットのプレビューが 40 文字から 300 文字に増加。
111
+ * 文字リストの並べ替えに複数のオプション(名前順、作成日順、チャットサイズ順)があります。
112
+
113
+ * デフォルトでは、左右の設定パネルはクリックすると閉じます。
114
+ * ナビパネルのロックをクリックすると、パネルが開いたままになり、この設定はセッションをまたいで記憶されます。
115
+ * ナビパネルの開閉状態もセッションをまたいで保存されます。
116
+
117
+ * カスタマイズ可能なチャット UI:
118
+ * 新しいメッセージが届いたときにサウンドを再生する
119
+ * 丸型、長方形のアバタースタイルの切り替え
120
+ * デスクトップのチャットウィンドウを広くする
121
+ * オプションの半透明ガラス風パネル
122
+ * 'メインテキスト'、'引用テキスト'、'斜体テキスト'のページカラーをカスタマイズ可能。
123
+ * カスタマイズ可能な UI 背景色とぼかし量
124
+
125
+ ## インストール
126
+
127
+ *注: このソフトウェアはローカルにインストールすることを目的としており、colab や他のクラウドノートブックサービス上では十分にテストされていません。*
128
+
129
+ > **警告**
130
+
131
+ > WINDOWS が管理しているフォルダ(Program Files、System32 など)にはインストールしないでください
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 Desktop](https://central.github.com/deployments/desktop/desktop/latest/win32) をインストールする
144
+ 3. Windows エクスプローラーを開く (`Win+E`)
145
+ 4. Windows によって制御または監視されていないフォルダを参照または作成する。(例: C:\MySpecialFolder\)
146
+ 5. 上部のアドレスバーをクリックし、`cmd` と入力して Enter キーを押し、そのフォルダーの中にコマンドプロンプトを開きます。
147
+ 6. 黒いボックス(コマンドプロンプト)がポップアップしたら、そこに以下のいずれかを入力し、Enter を押します:
148
+
149
+ * Release ブランチの場合: `git clone https://github.com/SillyTavern/SillyTavern -b release`
150
+ * Staging ブランチの場合: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
151
+
152
+ 7. すべてをクローンしたら、`Start.bat` をダブルクリックして、NodeJS に要件をインストールさせる。
153
+ 8. サーバーが起動し、SillyTavern がブラウザにポップアップ表示されます。
154
+
155
+ ZIP ダウンロードによるインストール(推奨しない)
156
+
157
+ 1. [NodeJS](https://nodejs.org/en) をインストールする(最新の LTS 版を推奨)
158
+ 2. GitHub のリポジトリから zip をダウンロードする。(`ソースコード(zip)` は [Releases](https://github.com/SillyTavern/SillyTavern/releases/latest) から入手)
159
+ 3. お好きなフォルダに解凍してください
160
+ 4. `Start.bat` をダブルクリックまたはコマンドラインで実行する。
161
+ 5. サーバーが準備できれば、ブラウザのタブを開きます。
162
+
163
+ ### Linux
164
+
165
+ 1. `node -v` を実行して、Node.js v18 以上(最新の [LTS バージョン](https://nodejs.org/en/download/) を推奨)がインストールされていることを確認してください。
166
+ または、[Node Version Manager](https://github.com/nvm-sh/nvm#installing-and-updating) スクリプトを使用して、迅速かつ簡単に Node のインストールを管理します。
167
+ 2. `start.sh` スクリプトを実行する。
168
+ 3. お楽しみください。
169
+
170
+ ## API キー管理
171
+
172
+ SillyTavern は API キーをサーバーディレクトリの `secrets.json` ファイルに保存します。
173
+
174
+ デフォルトでは、入力後にページをリロードしても、フロントエンドには表示されません。
175
+
176
+ API ブロックのボタンをクリックして、キーを閲覧できるようにする:
177
+
178
+ 1. ファイル `config.yaml` で `allowKeysExposure` の値を `true` に設定する。
179
+ 2. SillyTavern サーバを再起動します。
180
+
181
+ ## リモート接続
182
+
183
+ SillyTavern をスマホで使用しながら、同じ Wifi ネットワーク上で ST サーバーを PC で実行したい場合に使用します。
184
+
185
+ しかし、これはどこからでもリモート接続を許可するために使用することができます。
186
+
187
+ **重要: SillyTavern はシングルユーザーのプログラムなので、ログインすれば誰でもすべてのキャラクターとチャットを見ることができ、UI 内で設定を変更することができます。**
188
+
189
+ ### 1. ホワイトリスト IP の管理
190
+
191
+ * SillyTavern のベースインストールフォルダ内に `whitelist.txt` という新しいテキストファイルを作成します。
192
+ * テキストエディタでこのファイルを開き、接続を許可したい IP のリストを追加します。
193
+
194
+ *個々の IP とワイルドカード IP 範囲の両方が受け入れられる。例:*
195
+
196
+ ```txt
197
+ 192.168.0.1
198
+ 192.168.0.20
199
+ ```
200
+
201
+ または
202
+
203
+ ```txt
204
+ 192.168.0.*
205
+ ```
206
+
207
+ (上記のワイルドカード IP 範囲は、ローカルネットワーク上のどのデバイスでも)
208
+
209
+ CIDR マスクも受け付ける(例:10.0.0.0/24)。
210
+
211
+ * `whitelist.txt` ファイルを保存する。
212
+ * TAI サーバーを再起動する。
213
+
214
+ これでファイルに指定された IP を持つデバイスが接続できるようになります。
215
+
216
+ *注: `config.yaml` にも `whitelist` 配列があり、同じように使うことができるが、`whitelist.txt` が存在する場合、この配列は無視される。*
217
+
218
+ ### 2. ST ホストマシンの IP の取得
219
+
220
+ ホワイトリストの設定後、ST ホストデバイスの IP が必要になります。
221
+
222
+ ST ホストデバイスが同じ無線 LAN ネットワーク上にある場合、ST ホストの内部無線 LAN IP を使用します:
223
+
224
+ * Windows の場合: ウィンドウズボタン > 検索バーに `cmd.exe` と入力 > コンソールに `ipconfig` と入力して Enter > `IPv4` のリストを探す。
225
+
226
+ 同じネットワーク上にいない状態で、ホストしているSTに接続したい場合は、STホスト機器のパブリックIPが必要です。
227
+
228
+ * ST ホストデバイスを使用中に、[このページ](https://whatismyipaddress.com/)にアクセスし、`IPv4` を探してください。これはリモートデバイスからの接続に使用するものです。
229
+
230
+ ### 3. リモートデバイスを ST ホストマシンに接続します。
231
+
232
+ 最終的に使用する IP が何であれ、その IP アドレスとポート番号をリモートデバイスのウェブブラウザに入力します。
233
+
234
+ 同じ無線 LAN ネットワーク上の ST ホストの典型的なアドレスは以下のようになります:
235
+
236
+ `http://192.168.0.5:8000`
237
+
238
+ http:// を使用し、https:// は使用しないでください
239
+
240
+ ### ST をすべての IP に開放する
241
+
242
+ これはお勧めしませんが、`config.yaml` を開き、`whitelistMode` を `false` に変更してください。
243
+
244
+ SillyTavern のベースインストールフォルダにある `whitelist.txt` が存在する場合は削除(または名前の変更)する必要があります。
245
+
246
+ これは通常安全ではないので、これを行う際にはユーザー名とパスワードを設定する必要があります。
247
+
248
+ ユーザー名とパスワードは `config.yaml` で設定します。
249
+
250
+ ST サーバを再起動すると、ユーザ名とパスワードさえ知っていれば、IP に関係なくどのデバイスでも ST サーバに接続できるようになる。
251
+
252
+ ### まだ接続できませんか?
253
+
254
+ * `config.yaml` で見つかったポートに対して、インバウンド/アウトバウンドのファイアウォールルールを作成します。これをルーターのポートフォワーディングと間違えないでください。そうしないと、誰かがあなたのチャットログを見つける可能性があり、それはマジで止めましょう。
255
+ * 設定 > ネットワークとインターネット > イーサネットで、プライベートネットワークのプロファイルタイプを有効にします。そうしないと、前述のファイアウォールルールを使っても接続できません。
256
+
257
+ ## パフォーマンスに問題がありますか?
258
+
259
+ ユーザー設定パネルでブラー効果なし(高速 UI)モードを有効にしてみてください。
260
+
261
+ ## このプロジェクトが気に入りました!どうすれば貢献できますか?
262
+
263
+ ### やるべきこと
264
+
265
+ 1. プルリクエストを送る
266
+ 2. 確立されたテンプレートを使って機能提案と課題レポートを送る
267
+ 3. 何か質問する前に、readme ファイルや組み込みのドキュメントを読んでください
268
+
269
+ ### やるべきではないこと
270
+
271
+ 1. 金銭の寄付を申し出る
272
+ 2. 何の脈絡もなくバグ報告を送る
273
+ 3. すでに何度も回答されている質問をする
274
+
275
+ ## 古い背景画像はどこにありますか?
276
+
277
+ 100% オリジナルコンテンツのみのポリシーに移行しているため、古い背景画像はこのリポジトリから削除されました。
278
+
279
+ アーカイブはこちら:
280
+
281
+ <https://files.catbox.moe/1xevnc.zip>
282
+
283
+ ## スクリーンショット
284
+
285
+ <img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649245-8061c60f-63dc-488e-9325-f151b7a3ec2d.png">
286
+ <img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649856-fbdeef05-d727-4d5a-be80-266cbbc6b811.png">
287
+
288
+ ## ライセンスとクレジット
289
+
290
+ **このプログラムは有用であることを願って配布されていますが、いかなる保証もありません;
291
+ また、商品性または特定目的への適合性についての黙示の保証もありません。
292
+ 詳細は GNU Affero General Public License をご覧ください。**
293
+
294
+ * Humi によるTAI Base: 不明ライセンス
295
+ * Cohee の修正と派生コード: AGPL v3
296
+ * RossAscends の追加: AGPL v3
297
+ * CncAnon の TavernAITurbo 改造の一部: 不明ライセンス
298
+ * kingbri のさまざまなコミットと提案 (<https://github.com/bdashore3>)
299
+ * city_unit の拡張機能と様々な QoL 機能 (<https://github.com/city-unit>)
300
+ * StefanDanielSchwarz のさまざまなコミットとバグ報告 (<https://github.com/StefanDanielSchwarz>)
301
+ * PepperTaco の作品にインスパイアされた Waifu モード (<https:/fugithub.com/peppertaco/Tavern/>)
302
+ * ピグマリオン大学の皆さん、素晴らしいテスターとしてクールな機能を提案してくれてありがとう!
303
+ * TextGen のプリセットをコンパイルしてくれた obabooga に感謝
304
+ * KAI Lite の KoboldAI プリセット: <https://lite.koboldai.net/>
305
+ * Google による Noto Sans フォント(OFLライセンス)
306
+ * Font Awesome によるアイコンテーマ <https://fontawesome.com> (アイコン: CC BY 4.0、フォント: SIL OFL 1.1、コード: MIT License)
307
+ * ZeldaFan0225 による AI Horde クライアントライブラリ: <https://github.com/ZeldaFan0225/ai_horde>
308
+ * AlpinDale による Linux 起動スクリプト
309
+ * FAQ を提供してくれた paniphons に感謝
310
+ * 10K ディスコード・ユーザー記念背景 by @kallmeflocc
311
+ * デフォルトコンテンツ(キャラクターと伝承書)の提供: @OtisAlejandro、@RossAscends、@kallmeflocc
312
+ * @doloroushyeonse による韓国語翻訳
313
+ * k_euler_a による Horde のサポート <https://github.com/Teashrock>
314
+ * [@XXpE3](https://github.com/XXpE3) による中国語翻訳、中国語 ISSUES の連絡先は @XXpE3
.github/readme-ru_ru.md ADDED
@@ -0,0 +1,359 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <a name="readme-top"></a>
2
+
3
+ [English](readme.md) | [中文](readme-zh_cn.md) | [日本語](readme-ja_jp.md) | Русский
4
+
5
+ ![][cover]
6
+
7
+ Мобайл-френдли интерфейс, поддержка множества API (KoboldAI/CPP, Horde, NovelAI, Ooba, OpenAI, OpenRouter, Claude, Scale), ВН-образный режим Вайфу, Stable Diffusion, TTS, поддержка миров (лорбуков), кастомизируемый UI, автоперевод, тончайшая настройка промптов + возможность устанавливать расширения.
8
+
9
+ Основано на форке [TavernAI](https://github.com/TavernAI/TavernAI) версии 1.2.8
10
+
11
+ ## Важные новости!
12
+
13
+ 1. Чтобы помочь вам быстрее разобраться в SillyTavern, мы создали [сайт с документацией](https://docs.sillytavern.app/). Ответы на большинство вопросов можно найти там.
14
+
15
+ 2. Почему пропали расширения после апдейта? Начиная с версии 1.10.6, большинство встроенных расширений были конвертированы в формат загружаемых аддонов. Их можно установить обратно через меню "Download Extensions and Assets" на панели расширений (значок с тремя кубиками сверху).
16
+
17
+ 3. Не поддерживается следующая платформа: android arm LEtime-web. 32-битный Android требует внешнюю зависимость, которую нельзя установить посредством npm. Для её установки потребуется следующая команда: `pkg install esbuild`. После этого продолжайте установку по общей инструкции.
18
+
19
+ ### Разрабатывается Cohee, RossAscends и всем сообществом SillyTavern
20
+
21
+ ### Что такое SillyTavern и TavernAI?
22
+
23
+ SillyTavern — это интерфейс, который устанавливается на ПК (и на Android), который даёт возможность общаться с генеративным ИИ и чатиться/ролеплеить с вашими собственными персонажами или персонажами других пользователей.
24
+
25
+ SillyTavern — это форк версии TavernAI 1.2.8, который разрабатывается более активно и имеет множество новых функций. Сейчас уже можно сказать, что это две отдельные и абсолютно самостоятельные программы.
26
+
27
+ ## Скриншоты
28
+
29
+ <img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/e902c7a2-45a6-4415-97aa-c59c597669c1">
30
+ <img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/f8a79c47-4fe9-4564-9e4a-bf247ed1c961">
31
+
32
+ ### Ветки
33
+
34
+ SillyTavern разрабатывается в двух ветках, чтобы всем категориям пользователей было удобно.
35
+
36
+ * release -🌟 **Рекомендовано для большинства пользователей.** Самая стабильная ветка, рекомендуем именно её. Обновляется только в момент крупных релизов. Подходит для большей части пользователей.
37
+ * staging - ⚠️ **Не рекомендуется для повседневного использования.** В этой ветке весь самый свежий и новый функционал, но будьте аккуратны, поскольку сломаться может в любом месте и в любое время. Только для продвинутых пользователей и энтузиастов.
38
+
39
+ Если вы не умеете обращаться с git через командную строку, или не знаете, что такое ветка, то не переживайте! Наилучшим вариантом всегда остаётся ветка release.
40
+
41
+ ### Что ещё нужно, кроме SillyTavern?
42
+
43
+ Сама по себе SillyTavern бесполезна, ведь это просто интерфейс. Вам потребуется доступ к бэкенду с ИИ, который и будет отыгрывать выбранного вами персонажа. Поддерживаются разные виды бэкендов: OpenAPI API (GPT), KoboldAI (локально или на Google Colab), и многое другое. Больше информации в [FAQ](https://docs.sillytavern.app/usage/faq/).
44
+
45
+ ### Требуется ли для SillyTavern мощный ПК?
46
+
47
+ SillyTavern — это просто интерфейс, поэтому запустить его можно на любой картошке. Мощным должен быть бэкенд с ИИ.
48
+
49
+ ## Есть вопросы или предложения?
50
+
51
+ ### У нас появился сервер в Discord
52
+
53
+ | [![][discord-shield-badge]][discord-link] | [Вступайте в наше Discord-сообщество!](https://discord.gg/sillytavern) Задавайте вопросы, делитесь любимыми персонажами и промптами. |
54
+ | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
55
+
56
+ Также можно написать разработчикам напрямую:
57
+
58
+ * Discord: cohee или rossascends
59
+ * Reddit: [/u/RossAscends](https://www.reddit.com/user/RossAscends/) или [/u/sillylossy](https://www.reddit.com/user/sillylossy/)
60
+ * [Запостить issue на GitHub](https://github.com/SillyTavern/SillyTavern/issues)
61
+
62
+ ## Эта версия включает
63
+
64
+ * Глубоко переработанную TavernAI 1.2.8 (переписано и оптимизировано более 50% кода)
65
+ * Свайпы
66
+ * Групповые чаты: комнаты для нескольких ботов, где персонажи могут говорить друг с другом и с вами
67
+ * Чекпоинты и ветки для чатов
68
+ * Продвинутые настройки для KoboldAI / TextGen со множеством созданных сообществом пресетов
69
+ * Поддержка миров (функция "Информация о мире" / WorldInfo): создавайте свой богатый лор, или экономьте токены для карточек персонажей
70
+ * Соединение через [OpenRouter](https://openrouter.ai) для разных API (Claude, GPT-4/3.5 и других)
71
+ * Соединение с API [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui)
72
+ * Соединение с [AI Horde](https://horde.koboldai.net/)
73
+ * Настройку форматирования промптов
74
+
75
+ ## Расширения
76
+
77
+ SillyTavern поддерживает расширения, при этом некоторые из ИИ-модулей работают через [SillyTavern Extras API](https://github.com/SillyTavern/SillyTavern-extras)
78
+
79
+ * Заметки автора / Смещение характера
80
+ * Эмоции для персонажей (спрайты)
81
+ * Автоматический саммарайз (краткий пересказ) истории чата
82
+ * Возможность отправить в чат картинку, которую ИИ сможет рассмотреть и понять
83
+ * Генерация картинок в Stable Diffusion (5 пресетов для чата, плюс свободный режим)
84
+ * Text-to-speech для сообщений ИИ (с помощью ElevenLabs, Silero, или родной TTS вашей ОС)
85
+
86
+ Полный список расширений и инструкций к ним можно найти в [документации](https://docs.sillytavern.app/).
87
+
88
+ ## Улучшения от RossAscends для UI/CSS/общего удобства
89
+
90
+ * Мобильный интерфейс адаптирован для iOS, добавлена возможность сохранить ярлык на главный экран и открыть приложение в полноэкранном режиме.
91
+ * Горячие клавиши
92
+ * Up = Редактировать последнее сообщение в чате
93
+ * Ctrl+Up = Редактировать ВАШЕ последнее сообщение в чате
94
+ * Left = свайп влево
95
+ * Right = свайп вправо (ОБРАТИТЕ ВНИМАНИЕ: когда в окне ввода что-то напечатано, клавиши для свайпа не работают)
96
+ * Ctrl+Left = посмотреть локальные переменные (в консоли браузера)
97
+ * Enter (при нахождении внутри окна ввода) = отправить ваше сообщение ИИ
98
+ * Ctrl+Enter = Повторная генерация последнего ответа ИИ
99
+
100
+ * Страница больше не перезагружается при смене имени пользователя или удалении персонажа
101
+
102
+ * Отключаемая возможность автоматически соединяться с API при загрузке страницы.
103
+ * Отключаемая возможность автоматически загружать последнего открытого персонажа при загрузк�� страницы.
104
+ * Улучшенный счётчик токенов - работает с несохранёнными персонажами, отображает и перманентные, и временные токены
105
+
106
+ * Улучшенный менеджер чатов
107
+ * Файлы с новыми чатами получают читабельные названия вида "(персонаж) - (когда создано)"
108
+ * Увеличен размер превью чата с 40 символов до 300.
109
+ * Несколько вариантов сортировки списка персонажей (по имени, дате создания, размеру чата).
110
+
111
+ * Панели настроек слева и справа автоматически скрываются, если щёлкнуть за их пределы.
112
+ * При нажатии на значок замка навигационная панель будет закреплена на экране, и эта настройка сохранится между сессиями
113
+ * Сам статус панели (открыта или закрыта) также сохраняется между сессиями
114
+
115
+ * Кастомизируемый интерфейс чата:
116
+ * Настройте звук при получении нового ответа
117
+ * Переключайтесь между круглыми и прямоугольными аватарками
118
+ * Увеличенное вширь окно чата для стационарных ПК
119
+ * Возможность включать полупрозрачные панели, стилизованные под стекло
120
+ * Настраиваемые цвета для обычного текста, курсива, цитат
121
+ * Настраиваемый цвет фона и интенсивность размытия
122
+
123
+ # ⌛ Установка
124
+
125
+ > **Внимание!**
126
+ > * НЕ УСТАНАВЛИВАЙТЕ В ПАПКИ, КОТОРЫЕ КОНТРОЛИРУЕТ WINDOWS (Program Files, System32 и т.п.).
127
+ > * НЕ ЗАПУСКАЙТЕ START.BAT С ПРАВАМИ АДМИНИСТРАТОРА
128
+ > * УСТАНОВКА НА WINDOWS 7 НЕВОЗМОЖНА ИЗ-ЗА ОТСУТСТВИЯ NODEJS 18.16
129
+
130
+ ## 🪟 Windows
131
+
132
+ ## Установка через Git
133
+ 1. Установите [NodeJS](https://nodejs.org/en) (рекомендуется последняя LTS-версия)
134
+ 2. Установите [Git for Windows](https://gitforwindows.org/)
135
+ 3. Откройте Проводник (`Win+E`)
136
+ 4. Перейдите в папку, которую не контролирует Windows, или создайте её. (пример: C:\MySpecialFolder\)
137
+ 5. Откройте командную строку. Для этого нажмите на адресную строку (сверху), введите `cmd` и нажмите Enter.
138
+ 6. Когда появится чёрное окошко (командная строка), введите ОДНУ из перечисленных ниже команд:
139
+
140
+ - для ветки release: `git clone https://github.com/SillyTavern/SillyTavern -b release`
141
+ - для ветки staging: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
142
+
143
+ 7. Когда клонирование закончится, дважды щёлкните по `Start.bat`, чтобы установить зависимости для NodeJS.
144
+ 8. После этого сервер запустится, и SillyTavern откроется в вашем браузере.
145
+
146
+ ## Установка с помощью SillyTavern Launcher
147
+ 1. Установите [Git for Windows](https://gitforwindows.org/)
148
+ 2. Откройте Проводник (`Win+E`) и создайте или выберите папку, в которую будет установлен лаунчер
149
+ 3. Откройте командную строку. Для этого нажмите на адресную строку (сверху), введите `cmd` и нажмите Enter.
150
+ 4. Когда появится чёрное окошко, введите следующую команду: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git`
151
+ 5. Дважды щёлкните по `installer.bat` и выберите, что именно хотите установить
152
+ 6. После завершения установки дважды щёлкните по `launcher.bat`
153
+
154
+ ## Установка с помощью GitHub Desktop
155
+ (Тут речь про git **только** в рамках GitHub Desktop, если хотите использовать `git` в командной строке, вам также понадобится [Git for Windows](https://gitforwindows.org/))
156
+ 1. Установите [NodeJS](https://nodejs.org/en) (latest LTS version is recommended)
157
+ 2. Установите [GitHub Desktop](https://central.github.com/deployments/desktop/desktop/latest/win32)
158
+ 3. После завершения установки GitHub Desktop, нажмите `Clone a repository from the internet....` (обратите внимание: для этого шага **НЕ требуется** аккаунт на GitHub)
159
+ 4. В меню перейдите на вкладку URL, введите адрес `https://github.com/SillyTavern/SillyTavern`, и нажмите Clone. В поле Local path можно изменить директорию, в которую будет загружена SillyTavern.
160
+ 6. Чтобы запустить SillyTavern, откройте Проводник и перейдите в выбранную на предыдущем шаге папку. По умолчанию репозиторий будет склонирован сюда: `C:\Users\[Имя пользователя]\Documents\GitHub\SillyTavern`
161
+ 7. Дважды щёлкните по файлу `start.bat`. (обратите внимание: окончание `.bat` может быть скрыто настройками вашей ОС. Таким образом, имя файла будет выглядеть как "`Start`". Дважды щёлкните по нему, чтобы запустить SillyTavern)
162
+ 8. После того, как вы дважды щёлкнули по файлу, должно открыться чёрное окошко, и SillyTavern начнёт устанавливать свои зависимости.
163
+ 9. Если установка прошла успешно, то в командной строке будет вот такое, а в браузере откроется вкладка с SillyTavern:
164
+ 10. Подключайтесь к любому из [поддерживаемых API](https://docs.sillytavern.app/usage/api-connections/) и начинайте переписку!
165
+
166
+ ## 🐧 Linux и 🍎 MacOS
167
+
168
+ В MacOS и Linux всё это делается через Терминал.
169
+
170
+ 1. Установите git и nodeJS (как именно - зависит от вашей ОС)
171
+ 2. Клонируйте репозиторий
172
+
173
+ - для ветки release: `git clone https://github.com/SillyTavern/SillyTavern -b release`
174
+ - для ветки staging: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
175
+
176
+ 3. Перейдите в папку установки с помощью `cd SillyTavern`.
177
+ 4. Запустите скрипт `start.sh` с помощью одной из команд:
178
+
179
+ - `./start.sh`
180
+ - `bash start.sh`
181
+
182
+ ## Установка с помощью SillyTavern Launcher
183
+
184
+ ### Для пользователей Linux
185
+ 1. Откройте любимый терминал и установите git
186
+ 2. Загрузите Sillytavern Launcher с помощью команды: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git`
187
+ 3. Перейдите в SillyTavern-Launcher: `cd SillyTavern-Launcher`
188
+ 4. Запустите лаунчер установки: `chmod +x install.sh && ./install.sh`, затем выберите, что конкретно хотите установить
189
+ 5. После завершения установки, запустите лаунчер следующей командой: `chmod +x launcher.sh && ./launcher.sh`
190
+
191
+ ### Для пользователей Mac
192
+ 1. Откройте терминал и установите brew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
193
+ 2. Затем установите git: `brew install git`
194
+ 3. Загрузите Sillytavern Launcher: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git`
195
+ 4. Перейдите в SillyTavern-Launcher: `cd SillyTavern-Launcher`
196
+ 5. Запустите лаунчер установки: `chmod +x install.sh && ./install.sh` and choose what you wanna install
197
+ 6. После завершения установки, запустите лаунчер следующей командой: `chmod +x launcher.sh && ./launcher.sh`
198
+
199
+ ## 📱 Мобильные устройства - Установка при помощи termux
200
+
201
+ > **ОБРАТИТЕ ВНИМАНИЕ!**
202
+ >
203
+ > **На Android-телефонах SillyTavern можно запускать нативно посредством Termux. Обратитесь к гайду, написанному ArroganceComplex#2659:**
204
+ >
205
+ > * <https://rentry.org/STAI-Termux>
206
+
207
+
208
+ ## Управление ключами от API
209
+
210
+ SillyTavern сохраняет ключи от ваших API в файле `secrets.json` в папке на сервере.
211
+
212
+ По умолчанию, ключи не будут отображаться на фронте после их ввода и перезагрузки страницы.
213
+
214
+ Чтобы включить возможность отображения ключей путём нажатия кнопки в блоке API:
215
+
216
+ 1. Зайдите в файл `config.yaml` и уст��новите `allowKeysExposure` в положение `true`.
217
+ 2. Перезапустите сервер SillyTavern.
218
+
219
+ ## Удалённое подключение
220
+
221
+ В основном этим пользуются тогда, когда хотят использовать SillyTavern с телефона, запустив сервер SillyTavern на стационарном ПК в той же Wi-Fi-сети.
222
+
223
+ Однако это позволит подключаться откуда угодно, а не только вам.
224
+
225
+ **ВАЖНО: в SillyTavern не предусмотрена возможность использования программы несколькими людьми. Поэтому любой, кто подключится к вашему серверу, получит доступ ко всем вашим персонажам и чатам, а также сможет менять настройки через UI.**
226
+
227
+ ### 1. Заведение "белого списка" IP-адресов
228
+
229
+ * Создайте в корневой папке SillyTavern файл с названием `whitelist.txt`.
230
+ * Откройте файл в текстовом редакторе и внесите список IP-адресов, с которых хотите разрешить подключение.
231
+
232
+ *Принимаются как обычные IP-адреса, так и целые диапазоны, размеченные с помощью астериска. Примеры:*
233
+
234
+ ```txt
235
+ 192.168.0.1
236
+ 192.168.0.20
237
+ ```
238
+
239
+ или
240
+
241
+ ```txt
242
+ 192.168.0.*
243
+ ```
244
+
245
+ (диапазон из примера сверху позволит подключаться всем устройствам в локальной сети)
246
+
247
+ Также принимаются маски CIDR (вида 10.0.0.0/24).
248
+
249
+ * Сохраните файл `whitelist.txt`.
250
+ * Перезапустите сервер ST.
251
+
252
+ После этого устройства из белого списка смогут подключаться к вашему серверу.
253
+
254
+ *Обратите внимание: в файле `config.yaml` также имеется массив `whitelist`, который работает по тому же принципу. Однако если существует файл `whitelist.txt`, то этот массив игнорируется.*
255
+
256
+ ### 2. Получение IP хост-машины с ST
257
+
258
+ После настройки белого списка адресов, следующим шагом будет получение IP-адреса хост-машины, на которой запущена SillyTavern.
259
+
260
+ Если хост-машина находится в той же Wi-Fi-сети, то можно воспользоваться её внутренним Wi-Fi-IP-адресом:
261
+
262
+ * На Windows: нажмите Пуск > введите `cmd.exe` в поиске > в консоли введите команду `ipconfig` и нажмите Enter > найдите пункт `IPv4-адрес`.
263
+
264
+ Если вы (или кто-то другой) хотите подключаться к хост-машине из другой сети, то вам понадобится ваш публичный IP-адрес.
265
+
266
+ * Откройте [эту страницу](https://whatismyipaddress.com/) с вашей хост-машины и найдите пункт `IPv4`. На этот адрес и будет подключаться удалённое устройство.
267
+
268
+ ### 3. Соединить удалённое устройство с хост-машиной ST
269
+
270
+ Какой бы IP-адрес вы ни выбрали, вам нужно будет вводить его в адресной строке браузера вашего удалённого устройства.
271
+
272
+ Обычный адрес хост-машины, находящейся в той же Wi-Fi-сети, выглядит примерно так:
273
+
274
+ `http://192.168.0.5:8000`
275
+
276
+ НЕ используйте https://
277
+ Только http://
278
+
279
+ ### Открытие доступа до ST для всех IP-адресов
280
+
281
+ Мы не рекомендуем так делать, но вы можете открыть файл `config.yaml` и изменить `whitelistMode` на `false`.
282
+
283
+ Обязательно нужно удалить (или переименовать) файл `whitelist.txt`, если такой файл есть в корневой директории SillyTavern.
284
+
285
+ Эта практика считается небезопасной, поэтому, если вы решите так сделать, мы попросим вас установить логин и пароль.
286
+
287
+ Оба этих параметра настраиваются в `config.yaml` (username и password).
288
+
289
+ Останется только перезапустить сервер ST, и после этого к вам сможет подключитьс�� любой пользователь вне зависимости от IP-адреса его устройства. Главное, чтобы он знал логин и пароль.
290
+
291
+ ### Не получается соединиться?
292
+
293
+ * Создайте входящее/исходящее правило в вашем фаерволле для порта, указанного в `config.yaml`. НЕ ПУТАЙТЕ этот процесс с пробросом портов на роутере. Если по ошибке перепутаете, то на ваш сервер сможет забраться посторонний человек и украсть ваши логи, этого следует избегать.
294
+ * Переключите Сетевой профиль на значение "Частные". Для этого зайдите в Параметры > Сеть и Интернет > Ethernet. КРАЙНЕ важно для Windows 11, без этого не получится подключиться даже с правилом фаервола.
295
+
296
+ ## Проблемы с производительностью?
297
+
298
+ Попробуйте включить опцию "Отключить эффект размытия" в меню "Пользовательские настройки".
299
+
300
+ ## Нравится ваш проект! Как помочь?
301
+
302
+ ### ЧТО ДЕЛАТЬ
303
+
304
+ 1. Присылайте пулл реквесты
305
+ 2. Присылайте идеи и баг-репорты, оформленные по установленным шаблонам
306
+ 3. Прежде чем задавать вопросы, прочтите readme и документацию
307
+
308
+ ### ЧЕГО НЕ ДЕЛАТЬ
309
+
310
+ 1. Предлагать донаты
311
+ 2. Присылать баг-репорты безо всякого контекста
312
+ 3. Задавать вопросы, на которые уже отвечали
313
+
314
+ ## Где найти старые фоны?
315
+
316
+ Мы двигаемся в сторону 100% уникальности всего используемого контента, поэтому старые фоны были убраны из репозитория.
317
+
318
+ Они отправлены в архив, скачать их можно здесь:
319
+
320
+ <https://files.catbox.moe/1xevnc.zip>
321
+
322
+
323
+
324
+
325
+ ## Авторы и лицензии
326
+
327
+ **Мы надеемся, что эта программа принесёт людям пользу,
328
+ но мы не даём НИКАКИХ ГАРАНТИЙ; мы ни в коем случае не гарантируем того,
329
+ что программа СООТВЕТСТВУЕТ КАКИМ-ЛИБО КРИТЕРИЯМ или ПРИГОДНА ДЛЯ КАКОЙ-ЛИБО ЦЕЛИ.
330
+ Подробнее можно узнать в GNU Affero General Public License.**
331
+
332
+ * Базовая TAI от Humi: Лицензия неизвестна
333
+ * Модификации от Cohee и производная кодовая база: AGPL v3
334
+ * Дополнения RossAscends: AGPL v3
335
+ * Кусочки TavernAITurbo мода от CncAnon: Лицензия неизвестна
336
+ * Различные коммиты и предложения от kingbri (<https://github.com/bdashore3>)
337
+ * Расширения и внедрение разного рода удобств - city_unit (<https://github.com/city-unit>)
338
+ * Различные коммиты и баг-репорты от StefanDanielSchwarz (<https://github.com/StefanDanielSchwarz>)
339
+ * Режим Вайфу вдохновлён работой PepperTaco (<https://github.com/peppertaco/Tavern/>)
340
+ * Благодарность Pygmalion University за прекрасную работу по тестированию и за все предлагаемые крутые фичи!
341
+ * Благодарность oobabooga за компиляцию пресетов для TextGen
342
+ * Пресеты для KoboldAI из KAI Lite: <https://lite.koboldai.net/>
343
+ * Шрифт Noto Sans от Google (OFL license)
344
+ * Тема Font Awesome <https://fontawesome.com> (Иконки: CC BY 4.0, Шрифты: SIL OFL 1.1, Код: MIT License)
345
+ * Клиентская библиотека для AI Horde от ZeldaFan0225: <https://github.com/ZeldaFan0225/ai_horde>
346
+ * Пусковой скрипт для Linux от AlpinDale
347
+ * Благодарность paniphons за оформление документа с FAQ
348
+ * Фон в честь 10 тысяч пользователей в Discord от @kallmeflocc
349
+ * Стандартный контент (персонажи и лорбуки) предоставлен пользователями @OtisAlejandro, @RossAscends и @kallmeflocc
350
+ * Корейский перевод от @doloroushyeonse
351
+ * Поддержка k_euler_a для Horde от <https://github.com/Teashrock>
352
+ * Китайский перевод от [@XXpE3](https://github.com/XXpE3), 中文 ISSUES 可以联系 @XXpE3
353
+
354
+ <!-- LINK GROUP -->
355
+ [back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
356
+ [cover]: https://github.com/SillyTavern/SillyTavern/assets/18619528/c2be4c3f-aada-4f64-87a3-ae35a68b61a4
357
+ [discord-link]: https://discord.gg/sillytavern
358
+ [discord-shield]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
359
+ [discord-shield-badge]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge
.github/readme-zh_cn.md ADDED
@@ -0,0 +1,306 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [English](readme.md) | 中文 | [日本語](readme-ja_jp.md) | [Русский](readme-ru_ru.md)
2
+
3
+ ![image](https://github.com/SillyTavern/SillyTavern/assets/18619528/c2be4c3f-aada-4f64-87a3-ae35a68b61a4)
4
+
5
+ 移动设备界面友好,多种人工智能服务或模型支持(KoboldAI/CPP, Horde, NovelAI, Ooba, OpenAI, OpenRouter, Claude, Scale),类似 Galgame 的 老 婆 模 式,Horde SD,文本系统语音生成,世界信息(Lorebooks),可定制的界面,自动翻译,和比你所需要的更多的 Prompt。附带扩展服务,支持文本绘画生成与语音生成和基于向量数据库 的聊天信息总结。
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
+ ## 有问题或建议?
45
+
46
+ ### 我们现在有了 Discord 社区
47
+
48
+ 获取支持,或分享喜爱的角色和 Prompt:
49
+
50
+ ### [加入 Discord 社区](https://discord.gg/sillytavern)
51
+
52
+ ***
53
+
54
+ 直接与开发人员联系:
55
+
56
+ * Discord: cohee 或 rossascends
57
+ * Reddit:/u/RossAscends 或 /u/sillylossy
58
+ * [发布 GitHub 问题](https://github.com/SillyTavern/SillyTavern/issues)
59
+
60
+ ## 此版本包括
61
+
62
+ * 经过大量修改的 TavernAI 1.2.8(超过 50% 的代码经过重写或优化)
63
+ * 根据自定义规则自动重新生成消息
64
+ * 群聊:多机器人房间,供角色与你或彼此交谈
65
+ * 聊天书签/分支(复制当前状态下的对话)
66
+ * 先进的 KoboldAI / TextGen 生成设置,包含大量社区预设
67
+ * 支持世界信息(Lorebooks):创建丰富的传说
68
+ * 支持 Window AI 浏览器扩展(运行 Claude、GPT 4 等模型):<https://windowai.io/>
69
+ * [Oobabooga's TextGen WebUI](https://github.com/oobabooga/text-generation-webui) API 连接
70
+ * 连接 [AI Horde](https://horde.koboldai.net/)
71
+ * Prompt 生成格式调整
72
+ * Webp 角色卡支持(PNG 仍是内部格式)
73
+
74
+ ## 扩展
75
+
76
+ SillyTavern 支持扩展服务,一些额外的人工智能模块可通过 [SillyTavern Extras API](https://github.com/SillyTavern/SillyTavern-extras) 提供。
77
+
78
+ * 作者注释/角色偏见
79
+ * 角色情绪识别
80
+ * 聊天记录自动摘要
81
+ * 在聊天窗口发送图片,并由人工智能解释图片内容
82
+ * 文本图像生成(5 预设,以及 "自由模式")
83
+ * 聊天信息的文字转语音(通过 ElevenLabs、Silero 或操作系统的语音生成)
84
+
85
+ 扩展服务的完整功能介绍和使用教程,请参阅 [Docs](https://docs.sillytavern.app/)。
86
+
87
+ ## 界面/CSS/性能,由 RossAscends 调整并优化
88
+
89
+ * 针对 iOS 系统优化了界面,并支持将快捷方式保存到主屏幕,在全屏模式下打开。
90
+ * 热键
91
+ * 上 = 编辑聊天中的最后一条信息
92
+ * Ctrl+P = 编辑聊天中最后一条用户信息
93
+ * 左 = 向左滑动
94
+ * 右 = 向右滑动(注意:当聊天窗口输入内容时,轻扫快捷键将被禁用)
95
+ * Ctrl+左 = 查看本地存储的变量(在浏览器控制台窗口中)
96
+ * 回车(选择聊天栏)= 向人工智能发送信息
97
+ * Ctrl+Enter = 重新生成人工智能最后的回复
98
+
99
+ * 用户名更改和角色删除不再强制重新刷新页面。
100
+
101
+ * 增加在页面加载时自动连接 API 的选项。
102
+ * 增加选项,在页面加载时自动加载最近的聊天信息。
103
+ * 更好的 Tokens 计算器 - 适用于未保存的文字,并显示永久和临时 Tokens 数量
104
+
105
+ * 更好的聊天历史查询窗口
106
+ * 聊天的文件名以"(角色卡名称)+(创建时间)"的可读格式保存
107
+ * 聊天历史预览从 40 个字符增加到 300 个字符。
108
+ * 聊天历史排序有多种选择(按名称、创建日期、聊天记录大小)。
109
+
110
+ * 默认情况下,左侧和右侧弹出的设置面板会在点击其他区域时自动关闭。
111
+ * 点击导航面板上的 "锁按钮" 将保持弹出面板打开,并在不同聊天中记住此设置。
112
+ * 导航面板的打开或关闭状态也会跨聊天保存。
113
+
114
+ * 自定义聊天界面:
115
+ * 收到新消息时播放提示音
116
+ * 切换圆形或长方形头像样式
117
+ * 在台式电脑上拥有更宽的聊天窗口
118
+ * 可选的半透明玻璃效果聊天窗口
119
+ * 可定制 "主文本"、"引用文本 "和 "斜体文本 "的字体颜色。
120
+ * 可定制聊天界面的背景颜色和透明模糊程度
121
+
122
+ ## 安装
123
+
124
+ *注意:SillyTavern 用于本地安装,尚未在 Colab 或其他云服务上进行全面测试。
125
+
126
+ > **警告**
127
+
128
+ > 切勿安装到任何受 Windows 控制的系统文件夹(Program Files, System32, etc)中。
129
+
130
+ > 不要以管理员权限运行 start.bat
131
+
132
+ ### Windows
133
+
134
+ 通过 Git 安装(推荐使用,便于更新)
135
+
136
+ 附有精美图片示例的简易指南:
137
+ <https://docs.sillytavern.app/installation/windows/>
138
+
139
+ 1. 安装 [NodeJS](https://nodejs.org/en)(建议使用最新的 LTS 版本)
140
+ 2. 安装 [GitHub 客户端](https://central.github.com/deployments/desktop/desktop/latest/win32)
141
+ 3. 打开 Windows 资源管理器 (`Win+E`)
142
+ 4. 浏览或创建一个不受 Windows 控制或监控的文件夹。(例如:C:\MySpecialFolder\)
143
+ 5. 点击顶部的 "地址栏",在该文件夹内打开命令提示符,输入 `cmd`,然后按回车。
144
+ 6. 弹出黑框(CMD 命令提示符)后,键入以下其中一项并按 Enter:
145
+
146
+ * 稳定分支:`git clone https://github.com/SillyTavern/SillyTavern -b release`
147
+ * 开发分支: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
148
+
149
+ 7. 等待 Git 克隆完成后,双击文件夹中的 `Start.bat` 将启动 NodeJS 并开始自动安装需要的软件包。
150
+ 8. 然后 SillyTavern 服务就会自动启动,同时在浏览器新标签页中自动打开。
151
+
152
+ 通过压缩包下载安装(不推荐)
153
+
154
+ 1. 安装 [NodeJS](https://nodejs.org/en)(建议使用最新的 LTS 版本)
155
+ 2. 从该 GitHub 仓库下载压缩包。(从 [Releases](https://github.com/SillyTavern/SillyTavern/releases/latest) 获取 "Source code(zip)")。
156
+ 3. 将压缩包解压到您选择的文件夹中
157
+ 4. 双击或在命令行中运行 `Start.bat`。
158
+ 5. SillyTavern 服务自动为你准备好一切后,会在你的浏览器中打开一个新标签页。
159
+
160
+ ### Linux
161
+
162
+ 1.运行 `start.sh` 脚本。
163
+ 2.等待自动完成,然后开始享受
164
+
165
+ ## API 密钥管理
166
+
167
+ SillyTavern 会将 API 密钥保存在目录中的 `secrets.json` 文件内。
168
+
169
+ 默认情况下,输入密钥并重新加载页面后,密钥会自动隐藏以保证安全。
170
+
171
+ 如果要想通过点击 API 输入框旁边的按钮来查看密钥,请按照以下设置:
172
+
173
+ 1. 打开 `config.yaml` 文件,将里面的 `allowKeysExposure` 设置为 `true`。
174
+ 2. 然后重启 SillyTavern 服务。
175
+
176
+ ## 远程访问
177
+
178
+ 这通常是为那些想在手机上使用 SillyTavern 的人准备的,而他们的电脑和手机在同一个局域网中。
179
+
180
+ 不过,SillyTavern 也可以被设置为允许从任何地方进行远程访问。
181
+
182
+ **重要提示:SillyTavern 是单用户程序,因此任何人登录后都能看到所有的角色卡和聊天内容,并能更改任何设置。
183
+
184
+ ### 1.管理白名单 IP
185
+
186
+ * 在你的 SillyTavern 文件夹中新建一个文本文件,名为 `whitelist.txt`。
187
+ * 用文本编辑器打开该文件,添加你希望允许连接的 IP 地址列表。
188
+ * 接受单个 IP 地址和 IP 范围,示例:
189
+
190
+ ```
191
+ 192.168.0.1
192
+ 192.168.0.20
193
+ ```
194
+
195
+ 或者
196
+
197
+ ```
198
+ 192.168.0.*
199
+ ```
200
+
201
+ (上述 IP 范围将允许局域网中的任何设备连接)
202
+
203
+ 也接受子网掩码设置(如 10.0.0.0/24)。
204
+
205
+ * 保存`whitelist.txt`文件。
206
+ * 重启 SillyTavern 服务。
207
+
208
+ 然后,文件中设置的 IP 就可以访问 SillyTavern 了。
209
+
210
+ *注意:"config.yaml" 文件内也有一个 "whitelist" 设置,你可以用同样的方法设置它,但如果 "whitelist.txt" 文件存在,这个设置将被忽略。
211
+
212
+ ### 2.获取 SillyTavern 服务的 IP 地址
213
+
214
+ 白名单设置完成后,您需要 SillyTavern 服务的 IP 地址。
215
+
216
+ 如果 SillyTavern 服务设备在同一个局域网上,则使用安装 SillyTavern 服务的电脑的局域网 IP 地址:
217
+
218
+ * Windows:Windows 按钮 > 在搜索栏中输入 `cmd.exe` > 在打开的控制台中输入 `ipconfig`,回�� > 然后在输出中查找 `IPv4` 地址。
219
+
220
+ 如果您(或其他人)想在互联网中访问你自己的 SillyTavern 服务,则需要运行 SillyTavern 服务的设备的互联网 IP 地址。
221
+
222
+ * 使用运行 SillyTavern 的设备,访问 [this page](https://whatismyipaddress.com/) 并查找 `IPv4`。这是您从互联网访问时要用到的。
223
+
224
+ ### 3. 使用其他设备访问 SillyTavern 服务
225
+
226
+ 无论你最终使用的是什么 IP 地址,都要将该 IP 地址和端口号输入其他设备网络浏览器。
227
+
228
+ 同一局域网中的 SillyTavern 服务的典型默认地址如下:
229
+
230
+ `http://192.168.0.5:8000`
231
+
232
+ 使用 http:// 而不是 https://
233
+
234
+ ### 向所有 IP 开放您的 SillyTavern 服务
235
+
236
+ 我们不建议这样做,但您可以打开 `config.yaml` 并将里面的 `whitelistMode` 设置改为 `false`。
237
+
238
+ 你必须删除(或重命名)SillyTavern 文件夹中的 `whitelist.txt` 文件(如果有的话)。
239
+
240
+ 这通常是不安全的做法,所以我们要求在这样做时必须设置用户名和密码。
241
+
242
+ 用户名和密码在`config.yaml`文件中设置。
243
+
244
+ 重启 SillyTavern 服务后,只要知道用户名和密码,任何设备都可以访问。
245
+
246
+ ### 还是无法访问?
247
+
248
+ * 为 `config.yaml` 文件中的端口创建一条入站/出站防火墙规则。切勿将此误认为是路由器上的端口转发,否则,有人可能会发现你的聊天隐私,那就大错特错了。
249
+ * 在 "设置" > "网络和 Internet" > "以太网" 中启用 "专用网络" 配置。这对 Windows 11 非常重要,否则即使添加了上述防火墙规则也无法连接。
250
+
251
+ ### 性能问题?
252
+
253
+ 尝试在用户设置面板上关闭模糊效果(快速用户界面)模式。
254
+
255
+ ## 我喜欢你的项目!我该如何贡献自己的力量?
256
+
257
+ ### 应该
258
+
259
+ 1. 发送 Fork 请求
260
+ 2. 使用规定的模板发送功能建议和问题报告
261
+ 3. 在提出任何问题之前,请先阅读 Readme 文件和文档
262
+
263
+ #### 不应该
264
+
265
+ 1. 提供金钱捐赠
266
+ 2. 发送错误报告而不提供任何详细信息
267
+ 3. 提出已经回答过无数次的问题
268
+
269
+ ## 我在哪里可以找到以前的聊天背景图片?
270
+
271
+ 我们正在实行 100% 原创内容的政策,因此旧的背景图片已从该资源库中删除。
272
+
273
+ 不过你可以在这里找到它们的存档:
274
+
275
+ <https://files.catbox.moe/1xevnc.zip>
276
+
277
+ ## 屏幕截图
278
+
279
+ <img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649245-8061c60f-63dc-488e-9325-f151b7a3ec2d.png">
280
+ <img width="400" alt="image" src="https://user-images.githubusercontent.com/18619528/228649856-fbdeef05-d727-4d5a-be80-266cbbc6b811.png">
281
+
282
+ ## 许可证和贡献
283
+
284
+ **发布本程序是希望它能有所帮助,但不做任何保证;甚至没有明示的性能、稳定性和其他任何特定用途的可用性保证。更多详情,请参阅 GNU Affero 通用公共许可证。**
285
+
286
+ **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.**
287
+
288
+ * TAI Base by Humi: Unknown license
289
+ * Cohee's modifications and derived code: AGPL v3
290
+ * RossAscends' additions: AGPL v3
291
+ * Portions of CncAnon's TavernAITurbo mod: Unknown license
292
+ * kingbri's various commits and suggestions (<https://github.com/bdashore3>)
293
+ * StefanDanielSchwarz's various commits and bug reports (<https://github.com/StefanDanielSchwarz>)
294
+ * Waifu mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>)
295
+ * Thanks Pygmalion University for being awesome testers and suggesting cool features!
296
+ * Thanks oobabooga for compiling presets for TextGen
297
+ * KoboldAI Presets from KAI Lite: <https://lite.koboldai.net/>
298
+ * Noto Sans font by Google (OFL license)
299
+ * Icon theme by Font Awesome <https://fontawesome.com> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
300
+ * AI Horde client library by ZeldaFan0225: <https://github.com/ZeldaFan0225/ai_horde>
301
+ * Linux startup script by AlpinDale
302
+ * Thanks paniphons for providing a FAQ document
303
+ * 10K Discord Users Celebratory Background by @kallmeflocc
304
+ * Default content (characters and lore books) provided by @OtisAlejandro, @RossAscends and @kallmeflocc
305
+ * Korean translation by @doloroushyeonse
306
+ * 中文翻译由 [@XXpE3](https://github.com/XXpE3) 完成,中文 ISSUES 可以联系 @XXpE3
.github/readme.md ADDED
@@ -0,0 +1,419 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <a name="readme-top"></a>
2
+
3
+ English | [中文](readme-zh_cn.md) | [日本語](readme-ja_jp.md) | [Русский](readme-ru_ru.md)
4
+
5
+ ![][cover]
6
+
7
+ Mobile-friendly layout, Multi-API (KoboldAI/CPP, Horde, NovelAI, Ooba, OpenAI, OpenRouter, Claude, Scale), VN-like Waifu Mode, Stable Diffusion, TTS, WorldInfo (lorebooks), customizable UI, auto-translate, and more prompt options than you'd ever want or need + ability to install third-party extensions.
8
+
9
+ Based on a fork of [TavernAI](https://github.com/TavernAI/TavernAI) 1.2.8
10
+
11
+ ## Important news!
12
+
13
+ 1. We have created a [Documentation website](https://docs.sillytavern.app/) to answer most of your questions and help you get started.
14
+
15
+ 2. Missing extensions after the update? Since the 1.10.6 release version, most of the previously built-in extensions have been converted to downloadable add-ons. You can download them via the built-in "Download Extensions and Assets" menu in the extensions panel (stacked blocks icon in the top bar).
16
+
17
+ 3. Unsupported platform: android arm LEtime-web. 32-bit Android requires an external dependency that can't be installed with npm. Use the following command to install it: `pkg install esbuild`. Then run the usual installation steps.
18
+
19
+ ### Brought to you by Cohee, RossAscends, and the SillyTavern community
20
+
21
+ ### What is SillyTavern or TavernAI?
22
+
23
+ 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.
24
+
25
+ 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.
26
+
27
+ ## Screenshots
28
+
29
+ <img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/e902c7a2-45a6-4415-97aa-c59c597669c1">
30
+ <img width="400" alt="image" src="https://github.com/SillyTavern/SillyTavern/assets/61471128/f8a79c47-4fe9-4564-9e4a-bf247ed1c961">
31
+
32
+ ### Branches
33
+
34
+ SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users.
35
+
36
+ * 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.
37
+ * 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.
38
+
39
+ 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.
40
+
41
+ ### What do I need other than SillyTavern?
42
+
43
+ On its own SillyTavern 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/).
44
+
45
+ ### Do I need a powerful PC to run SillyTavern?
46
+
47
+ Since SillyTavern 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.
48
+
49
+ ## Questions or suggestions?
50
+
51
+ ### We now have a community Discord server
52
+
53
+ | [![][discord-shield-badge]][discord-link] | [Join our Discord community!](https://discord.gg/sillytavern) Get support, share favorite characters and prompts. |
54
+ | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
55
+
56
+ Or get in touch with the developers directly:
57
+
58
+ * Discord: cohee or rossascends
59
+ * Reddit: [/u/RossAscends](https://www.reddit.com/user/RossAscends/) or [/u/sillylossy](https://www.reddit.com/user/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 checkpoints / branching
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
+
75
+ ## Extensions
76
+
77
+ SillyTavern has extensibility support, with some additional AI modules hosted via [SillyTavern Extras API](https://github.com/SillyTavern/SillyTavern-extras)
78
+
79
+ * Author's Note / Character Bias
80
+ * Character emotional expressions (sprites)
81
+ * Auto-Summary of the chat history
82
+ * Sending images to chat, and the AI interpreting the content
83
+ * Stable Diffusion image generation (5 chat-related presets plus 'free mode')
84
+ * Text-to-speech for AI response messages (via ElevenLabs, Silero, or the OS's System TTS)
85
+
86
+ A full list of included extensions and tutorials on how to use them can be found in the [Docs](https://docs.sillytavern.app/).
87
+
88
+ ## UI/CSS/Quality of Life tweaks by RossAscends
89
+
90
+ * Mobile UI optimized for iOS, and supports saving a shortcut to the home screen and opening in fullscreen mode.
91
+ * HotKeys
92
+ * Up = Edit last message in chat
93
+ * Ctrl+Up = Edit last USER message in chat
94
+ * Left = swipe left
95
+ * Right = swipe right (NOTE: swipe hotkeys are disabled when the chat bar has something typed into it)
96
+ * Ctrl+Left = view locally stored variables (in the browser console window)
97
+ * Enter (with chat bar selected) = send your message to AI
98
+ * Ctrl+Enter = Regenerate the last AI response
99
+
100
+ * User Name Changes and Character Deletion no longer force the page to refresh.
101
+
102
+ * Toggle option to automatically connect to API on page load.
103
+ * Toggle option to automatically load the most recently viewed character on page load.
104
+ * Better Token Counter - works on unsaved characters, and shows both permanent and temporary tokens.
105
+
106
+ * Better Past Chats View
107
+ * New Chat filenames are saved in a readable format of "(character) - (when it was created)"
108
+ * Chat preview increased from 40 characters to 300.
109
+ * Multiple options for characters list sorting (by name, creation date, chat sizes).
110
+
111
+ * By default the left and right settings panel will close when you click away from it.
112
+ * Clicking the Lock on the nav panel will hold the panel open, and this setting be remembered across sessions.
113
+ * Nav panel status of open or closed will also be saved across sessions.
114
+
115
+ * Customizable chat UI:
116
+ * Play a sound when a new message arrives
117
+ * Switch between round or rectangle avatar styles
118
+ * Have a wider chat window on the desktop
119
+ * Optional semi-transparent glass-like panels
120
+ * Customizable page colors for 'main text', 'quoted text', and 'italics text'.
121
+ * Customizable UI background color and blur amount
122
+
123
+ # ⌛ Installation
124
+
125
+ > \[!WARNING]
126
+ > * DO NOT INSTALL INTO ANY WINDOWS CONTROLLED FOLDER (Program Files, System32, etc).
127
+ > * DO NOT RUN START.BAT WITH ADMIN PERMISSIONS
128
+ > * INSTALLATION ON WINDOWS 7 IS IMPOSSIBLE AS IT CAN NOT RUN NODEJS 18.16
129
+
130
+ ## 🪟 Windows
131
+
132
+ ## Installing via Git
133
+ 1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended)
134
+ 2. Install [Git for Windows](https://gitforwindows.org/)
135
+ 3. Open Windows Explorer (`Win+E`)
136
+ 4. Browse to or Create a folder that is not controlled or monitored by Windows. (ex: C:\MySpecialFolder\)
137
+ 5. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter.
138
+ 6. Once the black box (Command Prompt) pops up, type ONE of the following into it and press Enter:
139
+
140
+ - for Release Branch: `git clone https://github.com/SillyTavern/SillyTavern -b release`
141
+ - for Staging Branch: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
142
+
143
+ 7. Once everything is cloned, double-click `Start.bat` to make NodeJS install its requirements.
144
+ 8. The server will then start, and SillyTavern will pop up in your browser.
145
+
146
+ ## Installing via SillyTavern Launcher
147
+ 1. On your keyboard: press **`WINDOWS + R`** to open Run dialog box. Then, run the following command to install git:
148
+ ```shell
149
+ cmd /c winget install -e --id Git.Git
150
+ ```
151
+ 2. On your keyboard: press **`WINDOWS + E`** to open File Explorer, then navigate to the folder where you want to install the launcher. Once in the desired folder, type `cmd` into the address bar and press enter. Then, run the following command:
152
+ ```shell
153
+ git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher && start installer.bat
154
+ ```
155
+
156
+ ## Installing via GitHub Desktop
157
+ (This allows git usage **only** in GitHub Desktop, if you want to use `git` on the command line too, you also need to install [Git for Windows](https://gitforwindows.org/))
158
+ 1. Install [NodeJS](https://nodejs.org/en) (latest LTS version is recommended)
159
+ 2. Install [GitHub Desktop](https://central.github.com/deployments/desktop/desktop/latest/win32)
160
+ 3. After installing GitHub Desktop, click on `Clone a repository from the internet....` (Note: You **do NOT need** to create a GitHub account for this step)
161
+ 4. On the menu, click the URL tab, enter this URL `https://github.com/SillyTavern/SillyTavern`, and click Clone. You can change the Local path to change where SillyTavern is going to be downloaded.
162
+ 6. To open SillyTavern, use Windows Explorer to browse into the folder where you cloned the repository. By default, the repository will be cloned here: `C:\Users\[Your Windows Username]\Documents\GitHub\SillyTavern`
163
+ 7. Double-click on the `start.bat` file. (Note: the `.bat` part of the file name might be hidden by your OS, in that case, it will look like a file called "`Start`". This is what you double-click to run SillyTavern)
164
+ 8. After double-clicking, a large black command console window should open and SillyTavern will begin to install what it needs to operate.
165
+ 9. After the installation process, if everything is working, the command console window should look like this and a SillyTavern tab should be open in your browser:
166
+ 10. Connect to any of the [supported APIs](https://docs.sillytavern.app/usage/api-connections/) and start chatting!
167
+
168
+ ## 🐧 Linux & 🍎 MacOS
169
+
170
+ For MacOS / Linux all of these will be done in a Terminal.
171
+
172
+ 1. Install git and nodeJS (the method for doing this will vary depending on your OS)
173
+ 2. Clone the repo
174
+
175
+ - for Release Branch: `git clone https://github.com/SillyTavern/SillyTavern -b release`
176
+ - for Staging Branch: `git clone https://github.com/SillyTavern/SillyTavern -b staging`
177
+
178
+ 3. `cd SillyTavern` to navigate into the install folder.
179
+ 4. Run the `start.sh` script with one of these commands:
180
+
181
+ - `./start.sh`
182
+ - `bash start.sh`
183
+
184
+ ## Installing via SillyTavern Launcher
185
+
186
+ ### For Linux users
187
+ 1. Open your favorite terminal and install git
188
+ 2. Git clone the Sillytavern-Launcher with:
189
+ ```shell
190
+ git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher
191
+ ```
192
+ 3. Start the installer.sh with:
193
+ ```shell
194
+ chmod +x install.sh && ./install.sh
195
+ ```
196
+ 4. After installation start the launcher.sh with:
197
+ ```shell
198
+ chmod +x launcher.sh && ./launcher.sh
199
+ ```
200
+
201
+ ### For Mac users
202
+ 1. Open a terminal and install brew with:
203
+ ```shell
204
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
205
+ ```
206
+ 2. Install git with:
207
+ ```shell
208
+ brew install git
209
+ ```
210
+ 3. Git clone the Sillytavern-Launcher with:
211
+ ```shell
212
+ git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher
213
+ ```
214
+ 4. Start the installer.sh with:
215
+ ```shell
216
+ chmod +x install.sh && ./install.sh
217
+ ```
218
+ 5. After installation start the launcher.sh with:
219
+ ```shell
220
+ chmod +x launcher.sh && ./launcher.sh
221
+ ```
222
+
223
+ ## 🐋 Installing via Docker
224
+
225
+ These instructions assume you have installed Docker, are able to access your command line for the installation of containers, and familiar with their general operation.
226
+
227
+ ### Building the image yourself
228
+
229
+ We have a comprehensive guide on using SillyTavern in Docker [here](http://docs.sillytavern.app/installation/docker/) which covers installations on Windows, macOS and Linux! Give it a read if you wish to build the image yourself.
230
+
231
+ ### Using the GitHub Container Registry (easiest)
232
+
233
+ You will need two mandatory directory mappings and a port mapping to allow SillyTavern to function. In the command, replace your selections in the following places:
234
+
235
+ #### Container Variables
236
+
237
+ ##### Volume Mappings
238
+
239
+ - [config] - The directory where SillyTavern configuration files will be stored on your host machine
240
+ - [data] - The directory where SillyTavern user data (including characters) will be stored on your host machine
241
+ - [plugins] - (optional) The directory where SillyTavern server plugins will be stored on your host machine
242
+
243
+ ##### Port Mappings
244
+
245
+ - [PublicPort] - The port to expose the traffic on. This is mandatory, as you will be accessing the instance from outside of its virtual machine container. DO NOT expose this to the internet without implementing a separate service for security.
246
+
247
+ ##### Additional Settings
248
+
249
+ - [DockerNet] - The docker network that the container should be created with a connection to. If you don't know what it is, see the [official Docker documentation](https://docs.docker.com/reference/cli/docker/network/).
250
+ - [version] - On the right-hand side of this GitHub page, you'll see "Packages". Select the "sillytavern" package and you'll see the image versions. The image tag "latest" will keep you up-to-date with the current release. You can also utilize "staging" and "release" tags that point to the nightly images of the respective branches, but this may not be appropriate, if you are utilizing extensions that could be broken, and may need time to update.
251
+
252
+ #### Install command
253
+
254
+ 1. Open your Command Line
255
+ 2. Run the following command
256
+
257
+ `docker create --name='sillytavern' --net='[DockerNet]' -p '8000:8000/tcp' -v '[plugins]':'/home/node/app/plugins':'rw' -v '[config]':'/home/node/app/config':'rw' -v '[data]':'/home/node/app/data':'rw' 'ghcr.io/sillytavern/sillytavern:[version]'`
258
+
259
+ > Note that 8000 is a default listening port. Don't forget to use an appropriate port if you change it in the config.
260
+
261
+ ## 📱 Mobile - Installing via termux
262
+
263
+ > \[!NOTE]
264
+ > **SillyTavern can be run natively on Android phones using Termux. Please refer to this guide by ArroganceComplex#2659:**
265
+ > * <https://rentry.org/STAI-Termux>
266
+
267
+
268
+ ## API keys management
269
+
270
+ SillyTavern saves your API keys to a `secrets.json` file in the user data directory (`/data/default-user/secrets.json` is the default path).
271
+
272
+ By default, they will not be exposed to a frontend after you enter them and reload the page.
273
+
274
+ In order to enable viewing your keys by clicking a button in the API block:
275
+
276
+ 1. Set the value of `allowKeysExposure` to `true` in `config.yaml` file.
277
+ 2. Restart the SillyTavern server.
278
+
279
+ ## Remote connections
280
+
281
+ 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.
282
+
283
+ However, it can be used to allow remote connections from anywhere as well.
284
+
285
+ **IMPORTANT: Refer to the official guide if you want to configure SillyTavern user accounts with (optional) password protection: [Users](https://docs.sillytavern.app/installation/st-1.12.0-migration-guide/#users).**
286
+
287
+ ### 1. Managing whitelisted IPs
288
+
289
+ * Create a new text file inside your SillyTavern base install folder called `whitelist.txt`.
290
+ * Open the file in a text editor, and add a list of IPs you want to be allowed to connect.
291
+
292
+ *Both individual IPs and wildcard IP ranges are accepted. Examples:*
293
+
294
+ ```txt
295
+ 192.168.0.1
296
+ 192.168.0.20
297
+ ```
298
+
299
+ or
300
+
301
+ ```txt
302
+ 192.168.0.*
303
+ ```
304
+
305
+ (the above wildcard IP range will allow any device on the local network to connect)
306
+
307
+ CIDR masks are also accepted (eg. 10.0.0.0/24).
308
+
309
+ * Save the `whitelist.txt` file.
310
+ * Restart your ST server.
311
+
312
+ Now devices which have the IP specified in the file will be able to connect.
313
+
314
+ *Note: `config.yaml` also has a `whitelist` array, which you can use in the same way, but this array will be ignored if `whitelist.txt` exists.*
315
+
316
+ ### 2. Getting the IP for the ST host machine
317
+
318
+ After the whitelist has been setup, you'll need the IP of the ST-hosting device.
319
+
320
+ If the ST-hosting device is on the same wifi network, you will use the ST-host's internal wifi IP:
321
+
322
+ * For Windows: windows button > type `cmd.exe` in the search bar > type `ipconfig` in the console, hit Enter > look for `IPv4` listing.
323
+
324
+ 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.
325
+
326
+ * While using the ST-hosting device, access [this page](https://whatismyipaddress.com/) and look for `IPv4`. This is what you would use to connect from the remote device.
327
+
328
+ ### 3. Connect the remote device to the ST host machine
329
+
330
+ 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.
331
+
332
+ A typical address for an ST host on the same wifi network would look like this:
333
+
334
+ `http://192.168.0.5:8000`
335
+
336
+ Use http:// NOT https://
337
+
338
+ ### Opening your ST to all IPs
339
+
340
+ We do not recommend doing this, but you can open `config.yaml` and change `whitelistMode` to `false`.
341
+
342
+ You must remove (or rename) `whitelist.txt` in the SillyTavern base install folder if it exists.
343
+
344
+ This is usually an insecure practice, so we require you to set a username and password when you do this.
345
+
346
+ The username and password are set in `config.yaml`.
347
+
348
+ 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.
349
+
350
+ ### Still Unable To Connect?
351
+
352
+ * Create an inbound/outbound firewall rule for the port found in `config.yaml`. Do NOT mistake this for port-forwarding on your router, otherwise, someone could find your chat logs and that's a big no-no.
353
+ * 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.
354
+
355
+ ## Performance issues?
356
+
357
+ Try enabling the No Blur Effect (Fast UI) mode on the User settings panel.
358
+
359
+ ## I like your project! How do I contribute?
360
+
361
+ ### DO's
362
+
363
+ 1. Send pull requests
364
+ 2. Send feature suggestions and issue reports using established templates
365
+ 3. Read the readme file and built-in documentation before asking anything
366
+
367
+ ### DONT's
368
+
369
+ 1. Offer monetary donations
370
+ 2. Send bug reports without providing any context
371
+ 3. Ask the questions that were already answered numerous times
372
+
373
+ ## Where can I find the old backgrounds?
374
+
375
+ We're moving to a 100% original content only policy, so old background images have been removed from this repository.
376
+
377
+ You can find them archived here:
378
+
379
+ <https://files.catbox.moe/1xevnc.zip>
380
+
381
+
382
+
383
+
384
+ ## License and credits
385
+
386
+ **This program is distributed in the hope that it will be useful,
387
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
388
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
389
+ GNU Affero General Public License for more details.**
390
+
391
+ * TAI Base by Humi: MIT
392
+ * Cohee's modifications and derived code: AGPL v3
393
+ * RossAscends' additions: AGPL v3
394
+ * Portions of CncAnon's TavernAITurbo mod: Unknown license
395
+ * kingbri's various commits and suggestions (<https://github.com/bdashore3>)
396
+ * city_unit's extensions and various QoL features (<https://github.com/city-unit>)
397
+ * StefanDanielSchwarz's various commits and bug reports (<https://github.com/StefanDanielSchwarz>)
398
+ * Waifu mode inspired by the work of PepperTaco (<https://github.com/peppertaco/Tavern/>)
399
+ * Thanks Pygmalion University for being awesome testers and suggesting cool features!
400
+ * Thanks oobabooga for compiling presets for TextGen
401
+ * KoboldAI Presets from KAI Lite: <https://lite.koboldai.net/>
402
+ * Noto Sans font by Google (OFL license)
403
+ * Icon theme by Font Awesome <https://fontawesome.com> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
404
+ * AI Horde client library by ZeldaFan0225: <https://github.com/ZeldaFan0225/ai_horde>
405
+ * Linux startup script by AlpinDale
406
+ * Thanks paniphons for providing a FAQ document
407
+ * 10K Discord Users Celebratory Background by @kallmeflocc
408
+ * Default content (characters and lore books) provided by @OtisAlejandro, @RossAscends and @kallmeflocc
409
+ * Korean translation by @doloroushyeonse
410
+ * k_euler_a support for Horde by <https://github.com/Teashrock>
411
+ * Chinese translation by [@XXpE3](https://github.com/XXpE3), 中文 ISSUES 可以联系 @XXpE3
412
+ * Docker guide by [@mrguymiah](https://github.com/mrguymiah) and [@Bronya-Rand](https://github.com/Bronya-Rand)
413
+
414
+ <!-- LINK GROUP -->
415
+ [back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
416
+ [cover]: https://github.com/SillyTavern/SillyTavern/assets/18619528/c2be4c3f-aada-4f64-87a3-ae35a68b61a4
417
+ [discord-link]: https://discord.gg/sillytavern
418
+ [discord-shield]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
419
+ [discord-shield-badge]: https://img.shields.io/discord/1100685673633153084?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge