Music

Description

User Guide

An audio player for your voice channels: the bot joins your channel, plays through the tracks in a queue and announces what it is playing. Usable by all members.

What it does

• Joins your voice channel and starts playback.
• Stacks requests in a queue per server.
• Adds an entire playlist with a single command.
• Announces each track (title, author, thumbnail) in the channel where the request was made.
• Lets you skip, pause, resume, stop and set the volume.
• Leaves the voice channel automatically once the queue is empty.

Quick start (Admin)

1. No configuration is needed: the module is ready as soon as the bot is on the server.
2. Check that the bot can connect and speak in the voice channels concerned.
3. Join a voice channel, then run /music play with a title or a link.
4. If playback should stay restricted to certain members, restrict the /music commands from Discord's Server Settings → Integrations.

Commands

Command	Description
/music play	Plays a track or adds it to the queue (a title to search for, or a link).
/music skip	Skips to the next track.
/music pause	Pauses playback.
/music resume	Resumes playback.
/music stop	Stops playback, clears the queue and disconnects the bot.
/music queue	Shows the queue.
/music volume	Sets the volume, from 0 to 100.

Settings from the dashboard

This module has no dashboard page: it is driven solely by the commands above.

Good to know

• The module depends on an external audio service (a Lavalink server) which must be running and reachable by the bot. If it is unavailable, /music play replies "The music service is currently unavailable"; all the other commands simply have no effect.
• You must be in a voice channel to run /music play: the bot joins the channel you are in.
• A text search queries SoundCloud. If you want a specific source, paste the link directly: it is then resolved as-is.
• Pasting a playlist link adds all of its tracks to the queue at once.
• The queue is shared by the whole server: there is only one, and the volume applies to the entire player, not to each listener.
• /music queue only shows the first 10 tracks, followed by the number of remaining titles.
• The "now playing" announcements are sent to the text channel the last /music play command came from.
• Some tracks cannot be played even though they show up in the results (monetised, restricted or geo-blocked content). The bot reports this and automatically moves on to the next one.
• When the queue runs out, the bot disconnects by itself; you have to run /music play again to bring it back.
• There is no repeat, no shuffle and no way to remove a specific track from the queue: use /music skip or /music stop.