Merge pull request #121 from tegnike/feature/update-documents3

ドキュメント更新
tegnike · Aug 7, 2024 · b1136eb · b1136eb
2 parents c6ff927 + 1b092dd
commit b1136eb
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,9 @@
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/tegnike/aituber-kit"></a>
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/tegnike/aituber-kit"></a>
  <img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/tegnike/aituber-kit?sort=semver&color=orange">
+</p>
+<p align="center">
+ <a href="https://x.com/tegnike"><img alt="X (Twitter)" src="https://img.shields.io/badge/X-tegnike-1DA1F2?logo=x&style=flat&logoColor=white"/></a>
  <a href="https://discord.gg/T96PTvrs"><img alt="Discord" src="https://img.shields.io/badge/Discord-AITuberKit-7289DA?logo=discord&style=flat&logoColor=white"/></a>
  <a href="https://github.com/sponsors/tegnike"><img alt="GitHub Sponsor" src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=flat&logo=github"/></a>
 </p>
@@ -22,7 +25,7 @@
 
 1. AIキャラとの対話
 2. AITuber配信
-3. 外部連携モード
+3. 外部連携モード（β版）
 
 下記の記事に詳細な使用方法を記載しました。
 
@@ -98,10 +101,11 @@ npm run dev
 4. Youtubeの配信を開始し、キャラクターがコメントに反応するのを確認します。
 5. 会話継続モードをONにすると、コメントが無いときにAIが自ら発言することができます。
 
-## 外部連携モード
+## 外部連携モード（β版）
 
 - WebSocketでサーバーアプリにメッセージを送信して、レスポンスを取得することができます。
 - 上記2つと異なり、フロントアプリで完結しないため少し難易度が高いです。
+- ⚠ メンテナンスできていないため、動かない可能性があります。
 
 ### 使用方法
 

diff --git a/docs/README_en.md b/docs/README_en.md
@@ -1,9 +1,13 @@
 <h1 align="center">
  <img style="max-width: 100%;" src="./logo.png">
 </h1>
+
 <p align="center">
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/tegnike/aituber-kit"></a>
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/tegnike/aituber-kit"></a>
+</p>
+<p align="center">
+ <a href="https://x.com/tegnike"><img alt="X (Twitter)" src="https://img.shields.io/badge/X-tegnike-1DA1F2?logo=x&style=flat&logoColor=white"/></a>
  <img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/tegnike/aituber-kit?sort=semver&color=orange">
  <a href="https://discord.gg/T96PTvrs"><img alt="Discord" src="https://img.shields.io/badge/Discord-AITuberKit-7289DA?logo=discord&style=flat&logoColor=white"/></a>
  <a href="https://github.com/sponsors/tegnike"><img alt="GitHub Sponsor" src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=flat&logo=github"/></a>
@@ -21,7 +25,7 @@ This repository has the following 3 features:
 
 1. Conversation with AI character
 2. AITuber streaming
-3. External integration mode
+3. External integration mode (β version)
 
 I've written a detailed usage guide in the article below:
 
@@ -97,10 +101,11 @@ npm run dev
 4. Start streaming on YouTube and confirm that the character reacts to comments.
 5. Turn on the conversation continuity mode to be able to speak even if there are no comments.
 
-## External Integration Mode
+## External Integration Mode (β version)
 
 - You can send messages to the server app via WebSocket and get a response.
 - Unlike the above two, it does not complete within the front-end app, so the difficulty level is a bit higher.
+- ⚠ This mode is not maintained, so it may not work.
 
 ### Usage
 

diff --git a/docs/README_ko.md b/docs/README_ko.md
@@ -5,6 +5,9 @@
 <p align="center">
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/tegnike/aituber-kit"></a>
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/tegnike/aituber-kit"></a>
+</p>
+<p align="center">
+ <a href="https://x.com/tegnike"><img alt="X (Twitter)" src="https://img.shields.io/badge/X-tegnike-1DA1F2?logo=x&style=flat&logoColor=white"/></a>
  <img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/tegnike/aituber-kit?sort=semver&color=orange">
  <a href="https://discord.gg/T96PTvrs"><img alt="Discord" src="https://img.shields.io/badge/Discord-AITuberKit-7289DA?logo=discord&style=flat&logoColor=white"/></a>
  <a href="https://github.com/sponsors/tegnike"><img alt="GitHub Sponsor" src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=flat&logo=github"/></a>
@@ -22,7 +25,7 @@
 
 1. AI 캐릭터와 대화
 2. AITuber 스트리밍
-3. 외부 통합 모드
+3. 외부 통합 모드（베타 버전）
 
 아래 기사에 자세한 사용 방법을 작성했습니다.
 
@@ -98,10 +101,11 @@ npm run dev
 4. YouTube에서 스트리밍을 시작하고 캐릭터가 댓글에 반응하는지 확인합니다.
 5. 대화 연속 모드를 켜면 댓글이 없어도 AI가 스스로 발언할 수 있습니다.
 
-## 외부 통합 모드
+## 외부 통합 모드（베타 버전）
 
 - WebSocket을 통해 서버 앱에 메시지를 보내고 응답을 받을 수 있습니다.
 - 위의 두 가지와 달리 프론트엔드 앱 내에서 완료되지 않으므로 난이도가 약간 높습니다.
+- ⚠ 이 모드는 지속적으로 유지되지 않으므로 작동하지 않을 수 있습니다.
 
 ### 사용 방법
 

diff --git a/docs/README_zh.md b/docs/README_zh.md
@@ -5,6 +5,9 @@
 <p align="center">
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/tegnike/aituber-kit"></a>
  <a href="https://github.com/tegnike/aituber-kit"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/tegnike/aituber-kit"></a>
+</p>
+<p align="center">
+ <a href="https://x.com/tegnike"><img alt="X (Twitter)" src="https://img.shields.io/badge/X-tegnike-1DA1F2?logo=x&style=flat&logoColor=white"/></a>
  <img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/tegnike/aituber-kit?sort=semver&color=orange">
  <a href="https://discord.gg/T96PTvrs"><img alt="Discord" src="https://img.shields.io/badge/Discord-AITuberKit-7289DA?logo=discord&style=flat&logoColor=white"/></a>
  <a href="https://github.com/sponsors/tegnike"><img alt="GitHub Sponsor" src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=flat&logo=github"/></a>
@@ -22,7 +25,7 @@
 
 1. 與AI角色對話
 2. AITuber直播
-3. 外部整合模式
+3. 外部整合模式（β版本）
 
 我在下面的文章中寫了詳細的使用指南：
 
@@ -98,10 +101,11 @@ npm run dev
 4. 開始在YouTube上直播並確認角色對評論的反應。
 5. 開啟会話継続模式，在沒有評論時，AI可以自動發言。
 
-## 外部整合模式
+## 外部整合模式（β版本）
 
 - 您可以通過WebSocket向服務器應用程序發送消息並獲得響應。
 - 與上述兩者不同，它不在前端應用程序中完成，因此難度略高。
+- ⚠ 此模式不受支持，可能无法正常运行。
 
 ### 使用方法
 

diff --git a/locales/en/translation.json b/locales/en/translation.json
@@ -1,6 +1,6 @@
 {
  "Settings": "Settings",
- "ExternalConnectionMode": "External Connection Mode (WebSocket)",
+ "ExternalConnectionMode": "External Connection Mode (WebSocket, β version)",
  "YoutubeMode": "YouTube Mode",
  "YoutubeInfo": "The first character of the comment is '#', it is ignored.",
  "YoutubeAPIKey": "YouTube API Key",

diff --git a/locales/ja/translation.json b/locales/ja/translation.json
@@ -1,6 +1,6 @@
 {
  "Settings": "設定",
- "ExternalConnectionMode": "外部連携モード（WebSocket）",
+ "ExternalConnectionMode": "外部連携モード（WebSocket, β版）",
  "YoutubeMode": "YouTubeモード",
  "YoutubeInfo": "先頭が「#」のコメントは無視されます。",
  "YoutubeAPIKey": "YouTube API キー",

diff --git a/locales/ko/translation.json b/locales/ko/translation.json
@@ -1,6 +1,6 @@
 {
  "Settings": "설정",
- "ExternalConnectionMode": "외부 연동 모드 (WebSocket)",
+ "ExternalConnectionMode": "외부 연동 모드 (WebSocket, 베타 버전)",
  "YoutubeMode": "YouTube 모드",
  "YoutubeInfo": "처음에 '#'이 있는 댓글은 무시됩니다.",
  "YoutubeAPIKey": "YouTube API 키",

diff --git a/locales/zh/translation.json b/locales/zh/translation.json
@@ -1,6 +1,6 @@
 {
  "Settings": "設定",
- "ExternalConnectionMode": "外部連線模式 (WebSocket)",
+ "ExternalConnectionMode": "外部連線模式 (WebSocket, β版本）",
  "YoutubeMode": "YouTube 模式",
  "YoutubeInfo": "YouTube 直播 ID 是直播 ID 而不是頻道 ID",
  "YoutubeAPIKey": "YouTube API 金鑰",