お知らせ: 本プロジェクトはバージョン v2.0.0 以降、カスタムライセンスを採用しています。商用目的でご利用の場合は、利用規約 セクションをご確認ください。

AITuberKitは、誰でも簡単にAIキャラクターとチャットできるWebアプリケーションを構築できるオープンソースのツールキットです。
豊富なAIサービス、キャラクターモデル、音声合成エンジンに対応し、高いカスタマイズ性を備えた対話機能とAITuber配信機能を中心に、様々な拡張モードを提供しています。

詳細な使用方法や設定方法については、ドキュメントサイトをご覧ください。

• 各種LLMのAPIキーを使って、AIキャラクターと簡単に会話可能
• マルチモーダル対応で、カメラからの映像やアップロードした画像を認識して回答を生成
• 直近の会話文を記憶として保持

• YouTubeの配信コメントを取得して、AIキャラクターが自動で応答
• 会話継続モードでコメントがなくても自発的に発言可能
• "#"から始まるコメントは読まれない機能

• 外部連携モード: WebSocketでサーバーアプリと連携し、より高度な機能を実現
• スライドモード: AIキャラクターがスライドを自動で発表するモード
• Realtime API: OpenAIのRealtime APIを使用した低遅延対話と関数実行
• オーディオモード: OpenAIのAudio API機能を活用した自然な音声対話
• メッセージ受信機能: 専用APIを通じて外部から指示を受け付け、AIキャラクターに発言させることが可能

• 3Dモデル: VRMファイル
• 2Dモデル: Live2Dファイル（Cubism 3以降）

• OpenAI
• Anthropic
• Google Gemini
• Azure OpenAI
• Groq
• Cohere
• Mistral AI
• Perplexity
• Fireworks
• ローカルLLM
• Dify

• VOICEVOX
• Koeiromap
• Google Text-to-Speech
• Style-Bert-VITS2
• AivisSpeech
• Aivis Cloud API
• Cartesia
• GSVI TTS
• ElevenLabs
• OpenAI
• Azure OpenAI
• にじボイス

• Node.js: ^20.0.0
• npm: ^10.0.0

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

6. 必要に応じて.envファイルを作成します。

cp .env.example .env

詳細な設定方法や使用方法については、ドキュメントサイトをご覧ください。

このリポジトリは、個人利用やローカル環境での開発はもちろん、適切なセキュリティ対策を施した上での商用利用も想定しています。ただし、Web環境にデプロイする際は以下の点にご注意ください：

• APIキーの取り扱い: バックエンドサーバーを経由してAIサービス（OpenAI, Anthropic等）やTTSサービスのAPIを呼び出す仕様となっているため、APIキーの適切な管理が必要です。

本番環境で利用する場合は、以下のいずれかの対応を推奨します：

1. バックエンドサーバーの実装: APIキーの管理をサーバーサイドで行い、クライアントからの直接的なAPIアクセスを避ける
2. 利用者への適切な説明: 各利用者が自身のAPIキーを使用する場合は、セキュリティ上の注意点について説明する
3. アクセス制限の実装: 必要に応じて、適切な認証・認可の仕組みを実装する

開発を継続するためにスポンサーの方を募集しています。
あなたの支援は、AITuberKitの開発と改善に大きく貢献します。

他、プライベートスポンサー 複数名

AITuberKitの発展にご協力いただき、ありがとうございます。コミュニティからの貢献を歓迎しています。

バグを見つけたり、新機能のアイデアがある場合は、GitHubのIssuesページからぜひ教えてください。

イシューを作成する際に、以下の情報を含めていただけると対応がスムーズになります：

• 問題や新機能の詳細な説明
• 再現手順（バグの場合）
• 期待される動作と実際の動作
• 使用環境（ブラウザ、OS、Node.jsのバージョンなど）
• スクリーンショットや動画（可能であれば）

コードの改善や新機能の追加をしたい場合は、フォークしたリポジトリで変更を加え、プルリクエストを作成してください。

• 1つのプルリクエストでは、1つの機能または修正に焦点を当てるようにしてください。
• プルリクエストの説明には、変更内容と理由を書いてください。
• マージ先のブランチは必ず develop に設定してください。
• コンフリクトは無理に解消しなくても問題ありません。開発チームが対応します。

本プロジェクトは、バージョン v2.0.0 以降、カスタムライセンスを採用しています。

• 無償利用

  • 営利目的以外での個人利用、教育目的、非営利目的での使用は無償で利用可能です。

• 商用ライセンス

  • 商用目的での使用に関しては、別途商用ライセンスの取得が必要です。
  • 詳細は、ライセンスについてをご確認ください。

• ロゴの利用規約
• VRMおよびLive2Dモデルの利用規約

本プロジェクトでは、有償での機能優先実装を受け付けています。

• 企業や個人の方から要望のあった機能を、優先的に実装することが可能です。
• 実装された機能は、本OSSプロジェクトの一部として公開されます。
• 料金は機能の複雑さや実装に要する時間に応じて個別見積もりとなります。
• この優先実装は商用ライセンスとは別の取り組みです。実装された機能を商用利用する場合は、別途商用ライセンスの取得が必要です。

詳細については、[email protected] までお問い合わせください。