TopazBot - RTSP Discord Music bot for TopazChat

日本語README

🌟 Overview

TopazBot is a high-quality, low-latency Discord music bot that utilizes TopazChat’s RTSP stream. It runs on servers like Linux and provides streamed audio to your Discord server.

Attention!!

“TopazBot” is under the MIT license, but “TopazChat” is not for commercial use.

✨ Key Features

• 🧠 High Quality: Stereo, high-fidelity, low-latency stream playback.
• 🔒 Secure: Safe communication with Discord signature verification.
• 🌐 Multi-format Support: Flexible stream processing with ffmpeg.

💎 About TopazChat

📝 Details

TopazChat is a high-quality, low-latency RTSP server. It is free for personal use.

TopazChat Download

The costs for TopazChat are covered by the developer, Hirotoshi Yoshitaka @TyounanMOTI.

Please consider donating to help with server maintenance and data transfer costs for audio/video streaming! → FANBOX

All sponsors of TopazChat are listed in SPONSORS.txt.

💬 Community

• TopazChat Discord Server

Join: https://discord.com/invite/fCMcJ8A

🚀 Quick Start

There are two ways to get started with TopazBot.

1. Use the Public Bot

This is the easiest way. You can add the bot to your Discord server using the link below:

Click here to add the bot

2. Self-Hosting

You can host the bot on your own server.

📋 Prerequisites

• Linux Server
• FFmpeg (RTSP-enabled)
• Node.js 22.x
• npm or yarn
• Discord Bot Token
• TopazChat Stream

📦 Dependencies

This library requires one dependency from each of the categories below to support various platforms.

The dependencies are listed in order of performance preference.

If you cannot install one of the options, try installing another.

🐧 Debian or Ubuntu

node & npm:

• node: >=22
• npm: >=6

discord.js (npm install)

• discord.js: ^14.21.0

@discordjs/voice (npm install):

• @discordjs/voice: ^0.18.0

@discordjs/opus (npm install):

• @discordjs/opus: “^0.10.0”

Encryption Libraries (npm install):

• sodium-native: ^5.0.6

Opus Libraries (npm install):

• @discordjs/opus: ^0.10.0

FFmpeg:

• FFmpeg (Please install on your server, e.g., apt install ffmpeg)

pm2 (npm install): [Optional]

• pm2

🛠️ Installation

# Clone the repository
git clone https://github.com/emerauda/TopazBot.git topazbot
cd topazbot

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env
# Edit the .env file and set the required environment variables

⚙️ Configuration

Set the following environment variable in your .env file:

DISCORD_TOKEN=your_discord_bot_token

🚀 Deployment

# Build
npm run build

# Start
npm run start

# Register commands
npm run register

# Start the program using pm2
npm i pm2 -g
pm2 start npm -n TopazBot -- start

🎮 Command List

TopazBot supports the following slash commands.

▶️ /play

• Description: Plays the RTSP stream from TopazChat using the specified stream key.
• Usage: /play StreamKey: <your_stream_key>
• Parameters:
  • StreamKey (required): Your TopazChat stream key.

🔄 /resync

• Description: Attempts to reconnect if the connection is unstable or the stream is interrupted.
• Usage: /resync

⏹️ /stop

• Description: Stops the current stream playback and disconnects from the voice channel.
• Usage: /stop

📜 Legal

• Terms of Service
• Privacy Policy

🏗️ Architecture

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

🔧 Tech Stack

🧪 Development

📝 Scripts

🔍 Debugging

# Start local development server
npm run dev

# Run tests
npm test

# Generate coverage report
npm run test:coverage

The coverage report can be viewed at coverage

📂 Code structure

The code for this bot is specific to TopazChat.

Here is the code I used for reference: discordjs-japan/Playing Audio (in Japanese)

Created by Discord.js Japan user Group

🤝 Contributing to TopazBot

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please read our Contributing Guidelines for more details on the process and what we expect.

❤️ Donations

📻 TopazBot

Please consider donating to help maintain the public TopazBot server.

• TopazBot GitHub Sponsors

💎 TopazChat

The developer of TopazChat, Hirotoshi Yoshitaka, is seeking donations to cover server maintenance and data transfer costs.

• TopazChat FANBOX

🙏 Credits

📻 TopazBot

• Aoi Emerauda @emerauda

💎 TopazChat

• Hirotoshi Yoshitaka @TyounanMOTI TopazChat Developer

📄 License

This project is released under the MIT License. See the LICENSE file for details.

👥 Team

📞 Support

• 🐛 Bug Reports: Issues
• 💡 Feature Requests: Discussions
• 📧 Contact: aoi@emerauda.com

🌟 Star History

📊 Statistics