README_zh.md

【日本語】｜ 【英語】｜ 【韓語】

概覽

此存儲庫主要具有以下2個功能：

1. 與AI角色對話
2. AITuber直播

我在下面的文章中寫了詳細的使用指南：

開發環境

此項目在以下環境中開發：

• Node.js: ^20.0.0
• npm: 10.8.1

共同準備

1. 將存儲庫克隆到本地。

git clone https://github.com/tegnike/aituber-kit.git

2. 打開文件夾。

cd aituber-kit

3. 安裝包。

npm install

4. 以開發模式啟動應用程序。

npm run dev

5. 打開URL http://localhost:3000

與AI角色對話

• 這是與AI角色對話的功能。
• 它是此存儲庫的基礎pixiv/ChatVRM的擴展功能。
• 只要您有各種LLM的API密鑰，就可以相對輕鬆地嘗試。
• 最近的對話句子作為記憶保留。
• 它是多模態的，能夠識別來自攝像頭的圖像或上傳的圖像來生成回應。

使用方法

1. 在設置屏幕中輸入各種LLM的API密鑰。
   • OpenAI
   • Anthropic
   • Google Gemini
   • Groq
   • Local LLM（不需要API密鑰，但需要運行本地API服務器。）
   • Dify Chatbot（不需要API密鑰，但需要運行本地API服務器。）
2. 如有必要，編輯角色的設置提示。
3. 如有需要，加載VRM文件和背景文件。
4. 選擇語音合成引擎並根據需要配置語音設置。
   • 對於VOICEVOX，您可以從多個選項中選擇發言者。需要事先運行VOICEVOX應用程序。
   • 對於Koeiromap，您可以細微調整語音。需要API密鑰。
   • 對於Google TTS，還可以選擇日語以外的語言。需要憑證信息。
   • 對於Style-Bert-VITS2，需要運行本地API服務器。
   • 對於GSVI TTS，需要運行本地API服務器。
   • ElevenLabs支持多种语言选择。请输入API密钥。
5. 從輸入表單開始與角色對話。也可以使用麥克風輸入。

AITuber直播

• 可以檢索YouTube直播評論並讓角色發言。
• 需要YouTube API密鑰。
• 以「#」開頭的評論不會被讀取。

使用方法

1. 在設置屏幕中打開YouTube模式。
2. 輸入您的YouTube API密鑰和YouTube Live ID。
3. 與"與AI角色對話"相同的方式配置其他設置。
4. 開始在YouTube上直播並確認角色對評論的反應。
5. 開啟会話継続模式，在沒有評論時，AI可以自動發言。

其他功能

外部整合模式（β版本）

• 您可以通過WebSocket向服務器應用程序發送消息並獲得響應。
• 與上述兩者不同，它不在前端應用程序中完成，因此難度略高。
• ⚠ 此模式目前未完全維護，可能無法正常運行。

使用方法

1. 啟動服務器應用程序並打開 ws://127.0.0.1:8000/ws 端點。
2. 在設置屏幕中打開WebSocket模式。
3. 與"與AI角色對話"相同的方式配置其他設置。
4. 等待服務器應用程序的消息並確認角色的反應。

相關

• 您可以嘗試我創建的服務器應用程序存儲庫。tegnike/aituber-server
• 請閱讀"與美少女一起開發吧！！【Open Interpreter】"以獲得詳細設置。

幻燈片模式

• 這是AI角色自動展示幻燈片的模式。
• 您需要提前準備幻燈片和腳本文件。

使用方法

1. 進行到可以與AI角色互動的階段。
2. 將幻燈片文件夾和腳本文件放在指定的文件夾中。
3. 在設置屏幕中打開幻燈片模式。
4. 按下開始幻燈片按鈕開始演示。

小貼士

VRM模型和背景固定方法

• 在 public/AvatarSample_B.vrm 更改VRM模型數據。請不要更改名稱。
• 在 public/bg-c.jpg 更改背景圖片。請不要更改名稱。

設置環境變量

• 某些配置值可以從 .env 文件內容中參考。
• 如果在設置屏幕中輸入，則該值優先。

其他

• 可以在設置屏幕中重置對話歷史。
• 各種設置存儲在瀏覽器中。
• 代码块中的元素不会被TTS读取。

尋求贊助

我們正在尋求贊助者以繼續我們的開發工作。
您的支持將極大地促進AITuber套件的開發和改進。

我們的支持者（按支持順序排列）

以及多位匿名贊助者

使用協議

• 許可證遵循pixiv/ChatVRM，使用MIT許可證。
• 商標使用協議
• VRM模型使用協議