🎵 gomusic

gomusic

🌟 Features Overview

🎧 Playback Support

• 🎶 Track added by song name or YouTube/Soundcloud link.
• 📻 Internet radio streaming links (24/7 playback).

⚙️ Additional Features

• 🌐 Operation across multiple Discord servers.
• 📜 Access to recent track statistics and history of play commands.
• 🔄 Playback auto-resume support for connection interruptions.

⚠️ Current Limitations

• ⏸️ Playback auto-resume feature may cause noticeable pauses at times.
• ⏩ Playback speed may sometimes slightly vary.
• 🚫 The bot cannot play YouTube live streams or region-locked videos.
• 🚫 Not every radio streams are supported.
• 🐞 Can hang or become unresponsive. It's not bug-free.

🚀 Try

You can test out in two ways:

• Ensure FFMPEG is installed on your system and added to the global PATH variable. Follow the "Create bot in Discord Developer Portal" section to set up the bot in Discord.

• 🎙️ Join the Official Discord server and use the voice and #bot-spam channels.

📝 Available Discord Commands

▶️ Playback Commands

• !play [title|url] — Parameters: song name, YouTube URL, audio streaming URL.
• !play fast [title|url] — Manually select faster parser (YouTube only).
• !play slow [title|url] — Manually select slower parser (YouTube and SoundCloud).
• !skip — Skip to the next track in the queue.
• !stop — Stop playback, clear the queue, and leave the voice channel.

📋 Advanced Playback Commands

• !list — Show the current song queue.
• !pause, !resume — Pause/resume current playback.

📊 Information Commands

• !now — Show the currently playing song. Convenient for radio streaming.
• !stats — Show track statistics with total playback duration and count.
• !log — Show recent play commands by users.

⚙️ Utility Commands

• !cache [on|off] — Enable/disable caching during playback (⚠️ experimental).
• !set-prefx [new_prefix] — Set a custom prefix for a guild to avoid collisions with other bots.
• melodix-reset-prefix — Revert to the default prefix !.

ℹ️ General Commands

• !about — Show bot information.
• !help — Show a help cheatsheet.

💡 Usage Examples

To use the play command, provide a YouTube video title or URL:

!play Never Gonna Give You Up
!play https://www.youtube.com/watch?v=dQw4w9WgXcQ
!play http://stream-uk1.radioparadise.com/aac-320

Play multiple tracks, the second track will be added to the queue (works only with links):

!play https://www.youtube.com/watch?v=dQw4w9WgXcQ https://www.youtube.com/watch?v=OorZcOzNcgE

Play a track with a predefinied parsing mode:

!play fast https://www.youtube.com/watch?v=dQw4w9WgXcQ
!play slow https://www.youtube.com/watch?v=dQw4w9WgXcQ

⚡Fast and 🐢 Slow Parsing Modes

uses two different parser packages to retrieve streaming links from YouTube and SoundCloud:

• Fast Mode: youtube by Kkdai. This parser is very fast but can sometimes be unreliable and works only for YouTube.
• Slow Mode: go-ytdlp by lrstanley. This is a Go wrapper library for the well-known yt-dlp, a powerful command-line audio/video downloader. It is more reliable but noticeably slower.

By default, tries to use the fast parser first. If it fails, it falls back to the slower one.

🔧 How to Set Up the Bot

🔗 Create a Bot in the Discord Developer Portal

To add to a Discord server, follow these steps:

1. Create an application in the Discord Developer Portal and obtain the APPLICATION_ID (in the General section).
2. In the Bot section, enable PRESENCE INTENT, SERVER MEMBERS INTENT, and MESSAGE CONTENT INTENT.
3. Use the following link to authorize the bot: discord.com/oauth2/authorize?client_id=YOUR_APPLICATION_ID&scope=bot&permissions=36727824
   • Replace YOUR_APPLICATION_ID with your Bot's Application ID from step 1.
4. Select a server and click "Authorize".
5. Grant the necessary permissions for to function correctly (access to text and voice channels).

🛠️ Building from Sources

• bash-and-run.bat (or .sh for Linux): Build the debug version and execute.
• build-release.bat (or .sh for Linux): Build the release version.
• build-dist-assemble: Build the release version and assemble it as a distribution package (Windows only).

Rename .env.example to .env and store your Discord Bot Token in the DISCORD_TOKEN variable. Install FFMPEG and add it to global PATH variable. Install yt-dlp and add it to global PATH variable.

🐳 Docker Deployment

For Docker deployment, refer to docker/README.md for specific instructions.

📝 Environment Variables

You can configure using environment variables by creating a .env file in your project root directory. The following variables should be set in your .env file:

# Discord Bot Token (Required)
DISCORD_TOKEN=your-discord-bot-token

# Encoding options
ENCODE_VOLUME=128
ENCODE_CHANNELS=2
ENCODE_FRAME_RATE=48000
ENCODE_FRAME_DURATION=20
ENCODE_BITRATE=96
ENCODE_COMPRESSION_LEVEL=10
ENCODE_PACKET_LOSS=1
ENCODE_BUFFERED_FRAMES=400
ENCODE_VBR=true
ENCODE_START_TIME=0s
ENCODE_VOLUME_FLOAT=1.0
ENCODE_RECONNECT_AT_EOF=1
ENCODE_RECONNECT_STREAMED=1
ENCODE_RECONNECT_ON_NETWORK_ERROR=1
ENCODE_RECONNECT_ON_HTTP_ERROR="4xx,5xx"
ENCODE_RECONNECT_DELAY_MAX=5
ENCODE_FFMPEG_BINARY_PATH=""
ENCODE_ENCODING_LINE_LOG=true
ENCODE_USER_AGENT="Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
ENCODE_RAW_OUTPUT=true

🆘 Support

For any questions, get support in the Official Discord server.

📜 License

is licensed under the MIT License.