TopazBot - RTSP Discord Music bot for TopazChat

🌟 概要
TopazBotは、TopazChatのRTSPストリームをDiscordのボイスチャンネルに中継する、高音質・低遅延のミュージックボットです。Linuxなどのサーバーで動作します。
注意!!
「TopazBot」はMITライセンスで公開されていますが、「TopazChat」は商用利用が禁止されています。
✨ 主な機能
- 🧠 高品質: ステレオ・高音質・低遅延のストリーム再生
- 🔒 セキュア: DAVE (Discord Audio Video Encryption) による音声のエンドツーエンド暗号化
- 🌐 多フォーマット対応: FFmpegによる柔軟なストリーム処理
💎 TopazChatについて
📝 詳細
TopazChatは、高品質・低遅延のRTSPサーバです。個人での利用は無料です。
TopazChatの費用は、開発者のよしたかさん@TyounanMOTIが負担しています。
サーバーの維持費や音声・動画配信のデータ転送料のために寄付をお願いします!→FANBOX
TopazChatのすべてのスポンサーは、SPONSORS.txtに記載されています。
💬 コミュニティ
- TopazChat Discord Server
参加はこちら: https://discord.com/invite/fCMcJ8A
🚀 クイックスタート
TopazBotを導入するには、2つの方法があります。
1. 公開Botを利用する
最も簡単な方法です。以下のリンクからあなたのDiscordサーバーにBotを追加できます。
2. セルフホストで利用する
ご自身でサーバーを用意して、Botを運用する方法です。
📋 前提条件
- Linux サーバー
- FFmpeg (RTSP対応版)
- Node.js 22.x
- npm または yarn
- Discord Bot Token
- TopazChatストリーム
📦 依存関係
さまざまなプラットフォームに対応するため、以下の各カテゴリーから1つずつ依存関係をインストールしてください。
依存関係は、パフォーマンスの観点で推奨される順に記載しています。
いずれかがインストールできない場合は、別の選択肢を試してください。
🐧 Debian or Ubuntu
node & npm:
node: >=22npm: >=10
discord.js (npm install)
discord.js: ^14.26.5
@discordjs/voice (npm install):
@discordjs/voice: ^0.19.2
@discordjs/opus (npm install):
@discordjs/opus: “^0.10.0”
DAVE暗号化 (npm install):
@snazzah/davey: ^0.1.12
Encryption Libraries (npm install):
sodium-native: ^5.1.0
Opus Libraries (npm install):
@discordjs/opus: ^0.10.0
FFmpeg:
FFmpeg(apt install ffmpegなどでサーバーにインストールしてください)
pm2 (npm install): [オプション]
pm2
🛠️ インストール
# リポジトリをクローン
git clone https://github.com/emerauda/TopazBot.git topazbot
cd topazbot
# 依存関係をインストール
npm install
# 環境変数を設定
cp .env.example .env
# .envファイルを編集して必要な環境変数を設定
⚙️ 設定
.envファイルに以下の環境変数を設定します:
# Discord Bot設定
DISCORD_TOKEN=your_discord_bot_token
# RTSPサーバー設定(オプション)
# デフォルト: rtsp://topaz.chat/live
RTSP_SERVER_URL=rtsp://topaz.chat/live
設定オプション:
| 変数 | 必須 | デフォルト | 説明 |
|---|---|---|---|
DISCORD_TOKEN |
Yes | - | Discordボットトークン |
RTSP_SERVER_URL |
No | rtsp://topaz.chat/live |
RTSPサーバーのベースURL |
USE_EXTERNAL_OPUS |
No | 1 |
1 = OggOpus出力(推奨)、0 = AAC ADTSフォールバック |
INPUT_IS_OPUS |
No | 0 |
1 = ソースが実際にOpusを配信している場合のみ無変換コピー(TopazChatはAACのため 0 を推奨。誤設定時は自動的に再エンコードへ切り替え) |
FORCE_OPUS_REENCODE |
No | 0 |
1 = INPUT_IS_OPUS=1でも強制的にlibopusで再エンコード |
LOW_LATENCY |
No | 0 |
1 = 低遅延FFmpegフラグを有効化 (nobuffer, analyzeduration=0) |
OPUS_BITRATE |
No | 192k |
Opusビットレート |
AAC_BITRATE |
No | OPUS_BITRATE |
AACフォールバック時のビットレート (USE_EXTERNAL_OPUS=0) |
CHANNEL_FIX_MODE |
No | none |
none / swap / left / right / mix(再エンコード時のみ有効) |
DOWNMIX_MONO |
No | 0 |
1 = 入力をモノラルにダウンミックス(-ac 1、再エンコード時のみ有効) |
COPY_WITH_DISCARDCORRUPT |
No | 0 |
1 = copyモードでも破損フレーム破棄/PTS再生成を行う |
PLAY_WAIT_MS |
No | 2000 / 300 |
再生開始後の安定化待機時間(低遅延時の既定: 300) |
RESUME_WAIT_MS |
No | 3000 / 500 |
自動再開(リトライ)前の待機時間(低遅延時の既定: 500) |
DEBUG_FFMPEG |
No | 0 |
1 = FFmpegの起動引数とstderrをログ出力 |
再生時には ${RTSP_SERVER_URL}/${streamkey} というURLでストリームにアクセスします。
🚀 デプロイ
# ビルド
npm run build
# 起動
npm run start
# コマンド登録
npm run register
# pm2でBotを起動
npm i pm2 -g
pm2 start npm -n TopazBot -- start
🎮 コマンド一覧
TopazBotは以下のスラッシュコマンドに対応しています。
▶️ /play
- 説明: 指定されたストリームキーを使用して、TopazChatからのRTSPストリームを再生します。
- 使い方:
/play StreamKey: <あなたのストリームキー> - パラメータ:
StreamKey(必須): TopazChatのストリームキー。
🔄 /resync
- 説明: 接続が不安定な場合や、ストリームが途切れた際に再接続を試みます。
- 使い方:
/resyncまたは/resync StreamKey: <あなたのストリームキー> - パラメータ:
StreamKey(任意): 再同期するストリームキー。省略時は直前に再生したものを使用。
⏹️ /stop
- 説明: 現在のストリーム再生を停止し、ボイスチャンネルから切断します。
- 使い方:
/stop
🎚️ 再生の挙動
- 自動再開: 配信が中断しても(配信者の再起動など)、ボットは接続を維持し、ストリーム復帰時に自動で再生を再開します。
- 自動切断: 再生が30分間成功しない場合(配信者が戻らない等)、自動でボイスチャンネルから退出します。正常に再生が続いている限り切断されることはありません。
- ストリーム切替: 再生中に別のストリームキーで
/playを実行すると、新しいストリームに切り替わります。 - 失敗時の挙動: 初回の再生に失敗した場合は、エラーを報告してボイスチャンネルから退出します。
- グレースフルシャットダウン: SIGINT/SIGTERM(
pm2 stop/pm2 restartなど)で全セッションを後始末してから終了します。FFmpegプロセスや接続は残りません。
📜 利用規約とプライバシーポリシー
🏗️ アーキテクチャ
graph TD
subgraph "Discord Server"
User
DiscordVoiceChannel[Discord Voice Channel]
end
subgraph "Your Server (VPS)"
TopazBot
FFmpeg
end
subgraph "TopazChat Server"
TopazChat
end
User -- "/play" --> TopazBot
TopazBot -- "RTSP Stream Request" --> TopazChat
TopazChat -- "RTSP Stream" --> FFmpeg
FFmpeg -- "Opus Audio" --> TopazBot
TopazBot -- "Sends Audio" --> DiscordVoiceChannel
🔧 技術スタック
| カテゴリ | 技術 | バージョン |
|---|---|---|
| 言語 | TypeScript | ^6.0.3 |
| ランタイム | Node.js | >=22.x |
| フレームワーク | discord.js | ^14.26.5 |
| 音声処理 | @discordjs/voice | ^0.19.2 |
| DAVE暗号化 | @snazzah/davey | ^0.1.12 |
| メディア処理 | FFmpeg | - |
| RTSPサーバー | TopazChat | - |
| Opusライブラリ | @discordjs/opus | ^0.10.0 |
| 暗号化 | sodium-native | ^5.1.0 |
| パッケージ管理 | npm | >=10 |
| テスト | Jest | ^30.4.2 |
| リンター | ESLint | ^10.7.0 |
| フォーマッター | Prettier | ^3.9.5 |
🧪 開発
📝 スクリプト
| コマンド | 説明 |
|---|---|
npm run build |
TypeScriptをビルド |
npm run start |
ビルドしてBotを起動 |
npm run dev |
ts-nodeで開発モード起動 |
npm run register |
Discordスラッシュコマンドを登録 |
npm run lint |
ESLintを実行 |
npm run lint:fix |
ESLint自動修正を実行 |
npm run format |
Prettierフォーマットを適用 |
npm run format:check |
Prettierフォーマットをチェック |
npm run typecheck |
型チェックのみ実行(ビルドなし) |
npm run test |
テストを実行 |
npm run test:watch |
テストをウォッチモードで実行 |
npm run test:coverage |
カバレッジ付きテストを実行 |
🔍 デバッグ
# 開発モードで起動
npm run dev
# テスト実行
npm test
# カバレッジレポート生成
npm run test:coverage
カバレッジレポートは Codecov で確認可能
📂 コード構成
このボットのコードはTopazChat向けに最適化されていますが、RTSP_SERVER_URL 環境変数で他のRTSPサーバーにも接続できます。
参考にしたコード: discordjs-japan/音声を再生する
🤝 コントリビューション
オープンソースコミュニティが学び・創造・インスピレーションの場であり続けられるのは、コントリビューションのおかげです。皆さまの貢献を心より歓迎します。
このプロジェクトを改善する提案があれば、リポジトリをフォークしてプルリクエストを作成してください。”enhancement” タグを付けてIssueを立てるだけでも歓迎です。 プロジェクトへのスターもお忘れなく!ありがとうございます!
- プロジェクトをフォークする
- 機能ブランチを作成する (
git checkout -b feature/AmazingFeature) - 変更をコミットする (
git commit -m 'Add some AmazingFeature') - ブランチにプッシュする (
git push origin feature/AmazingFeature) - プルリクエストを開く
プロセスや期待されることの詳細については、コントリビューションガイドラインをお読みください。
❤️ 寄付
📻 TopazBot
公開TopazBotサーバーの維持のため、ご支援をお願いしています。
- TopazBot GitHub Sponsors
💎 TopazChat
TopazChatのサーバー維持費やデータ転送料をまかなうため、開発者のよしたかさんが寄付を募っています。
- TopazChat FANBOX
🙏 クレジット
📻 TopazBot
- Aoi Emerauda @emerauda
💎 TopazChat
- よしたか様 @TyounanMOTI TopazChat開発者
📄 ライセンス
このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルをご覧ください。
👥 チーム
📞 サポート
- 🐛 バグレポート: Issues
- 💡 機能要望: Discussions
- 📧 お問い合わせ: aoi@emerauda.com