13 KiB
13 KiB
Discord Player
Note: this module uses recent discordjs features and requires discord.js version 12.
Discord Player is a powerful Node.js module that allows you to easily implement music commands. Everything is customizable, and everything is done to simplify your work without limiting you!
Installation
npm install --save discord-player
Install opusscript or @discordjs/opus:
npm install --save opusscript
Install FFMPEG and you're done!
Player
const Discord = require("discord.js"),
client = new Discord.Client(),
settings = {
prefix: "!",
token: "Your Discord Token"
};
const { Player } = require("discord-player");
// Create a new Player (Youtube API key is your Youtube Data v3 key)
const player = new Player(client, "YOUTUBE API KEY");
// To easily access the player
client.player = player;
client.on("ready", () => {
console.log("I'm ready !");
});
client.login(settings.token);
You can pass a third parameter when instantiating the class Player: the options object:
options.leaveOnEnd: whether the bot should leave the voice channel when there is no more track in the queue.
options.leaveOnStop: whether the bot should leave the voice channel when the stop() function is used.
options.leaveOnEmpty: whether the bot should leave the voice channel if there is no more member in it.
Features Overview
You need to init the guild queue using the play() function, then you are able to manage the queue using the following functions:
// Play a track in the voice channel and init the guild queue
client.player.play(voiceChannel, trackName);
// Add a track to the queue
client.player.addToQueue(guildID, trackName);
// Clear the queue
client.player.clearQueue(guildID);
// Get the queue
client.player.getQueue(guildID);
// Skip the current track
client.player.skip(guildID);
// Remove a track from the queue using the index number
client.player.remove(guildID, track);
// Pause
client.player.pause(guildID);
// Resume
client.player.resume(guildID);
// Stop
client.player.stop(guildID);
// Check if music is playing in a guild
client.player.isPlaying(guildID);
// Get the currently playing trac
client.player.nowPlaying(guildID);
// Current track will be repeated indefinitely
client.player.setRepeatMode(guildID, true);
// Current track will no longer be repeated indefinitely
client.player.setRepeatMode(guildID, false);
Event messages
client.player.getQueue(guildID)
.on('end', () => {
message.channel.send('There is no more music in the queue!');
})
.on('trackChanged', (oldTrack, newTrack) => {
message.channel.send(`Now playing ${newTrack.name}...`);
})
.on('channelEmpty', () => {
message.channel.send('Stop playing, there is no more member in the voice channel...');
});
Examples
Play
To play a track, use the client.player.play() function.
Usage:
client.player.play(voiceChannel, trackName, requestedBy);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
// !play Despacito
// will play "Despacito" in the member voice channel
if(command === 'play'){
let track = await client.player.play(message.member.voice.channel, args[0], message.member.user.tag);
message.channel.send(`Currently playing ${track.name}! - Requested by ${track.requestedBy}`);
}
Pause
To pause the current track, use the client.player.pause() function.
Usage:
client.player.pause(guildID);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'pause'){
let track = await client.player.pause(message.guild.id);
message.channel.send(`${track.name} paused!`);
}
});
Resume
To resume the current track, use the client.player.resume() function.
Usage:
client.player.resume(guildID);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'resume'){
let track = await client.player.resume(message.guild.id);
message.channel.send(`${track.name} resumed!`);
}
});
Stop
To stop the music, use the client.player.stop() function.
Usage:
client.player.stop(guildID);
Example:
client.on('message', (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'stop'){
client.player.stop(message.guild.id);
message.channel.send('Music stopped!');
}
});
SetVolume
To update the volume, use the client.player.setVolume() function.
Usage:
client.player.setVolume(guildID, percent);
Example:
client.on('message', (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'setvolume'){
client.player.setVolume(message.guild.id, parseInt(args[0]));
message.channel.send(`Volume set to ${args[0]} !`);
}
});
AddToQueue
To add a track to the queue, use the client.player.addToQueue() function.
Usage:
client.player.addToQueue(guildID, trackName);
Example:
In this example, you will see how to add a track to the queue if one is already playing.
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'play'){
let aTrackIsAlreadyPlaying = client.player.isPlaying(message.guild.id);
// If there's already a track playing
if(aTrackIsAlreadyPlaying){
// Add the track to the queue
let track = await client.player.addToQueue(message.guild.id, args[0]);
message.channel.send(`${track.name} added to queue!`);
} else {
// Else, play the track
let track = await client.player.play(message.member.voice.channel, args[0]);
message.channel.send(`Currently playing ${track.name}!`);
}
}
});
ClearQueue
To clear the queue, use the client.player.clearQueue() function.
Usage:
client.player.clearQueue(guildID);
Example:
client.on('message', (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'clear-queue'){
client.player.clearQueue(message.guild.id);
message.channel.send('Queue cleared!');
}
});
GetQueue
To get the server queue, use the client.player.getQueue() function.
Usage:
client.player.getQueue(guildID);
Example:
client.on('message', (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'queue'){
let queue = await client.player.getQueue(message.guild.id);
message.channel.send('Server queue:\n'+(queue.tracks.map((track, i) => {
return `${i === 0 ? 'Current' : `#${i+1}`} - ${track.name} | ${track.author}`
}).join('\n')));
}
/**
* Output:
*
* Server queue:
* Current - Despacito | Luis Fonsi
* #2 - Memories | Maroon 5
* #3 - Dance Monkey | Tones And I
* #4 - Circles | Post Malone
*/
});
Skip
To skip the current track, use the client.player.skip() function.
Usage:
client.player.skip(guildID);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'skip'){
let track = await client.player.skip(message.guild.id);
message.channel.send(`${track.name} skipped!`);
}
});
Now Playing
To get the currently playing track, use the client.player.nowPlaying() function.
Usage:
client.player.nowPlaying(guildID);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'now-playing'){
let track = await client.player.nowPlaying(message.guild.id);
message.channel.send(`Currently playing ${track.name}...`);
}
});
Repeat
To repeat the current track, use the client.player.setRepeatMode() function.
Usage:
client.player.setRepeatMode(guildID, boolean);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'enable-repeat'){
// Enable repeat mode
client.player.setRepeatMode(message.guild.id, true);
// Get the current track
let track = await client.player.nowPlaying(message.guild.id);
message.channel.send(`${track.name} will be repeated indefinitely!`);
}
if(command === 'disable-repeat'){
// Disable repeat mode
client.player.setRepeatMode(message.guild.id, false);
// Get the current track
let track = await client.player.nowPlaying(message.guild.id);
message.channel.send(`${track.name} will no longer be repeated indefinitely!`);
}
});
Remove
To remove a track from the queue, use the client.player.remove() function.
Usage:
client.player.remove(guildID, track);
Example:
client.on('message', async (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'remove'){
// Removes a track from the queue
client.player.remove(message.guild.id, args[0]).then(() => {
message.channel.send('Removed track!');
});
}
});
Info Messages
You can send a message when the queue ends or when the track changes:
client.on('message', (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
if(command === 'play'){
let track = await client.player.play(message.member.voice.channel, args[0]);
track.queue.on('end', () => {
message.channel.send('The queue is empty, please add new tracks!');
});
track.queue.on('trackChanged', (oldTrack, newTrack, skipped, repeatMode) => {
if(repeatMode){
message.channel.send(`Playing ${newTrack} again...`);
} else {
message.channel.send(`Now playing ${newTrack}...`);
}
});
}
Handle errors
There are 2 main errors that you can handle like this:
client.on('message', (message) => {
const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
const command = args.shift().toLowerCase();
// Error 1:
// Track not found
if(command === 'play'){
client.player.play(message.member.voice.channel, args[0]).then((track) => {
message.channel.send(`Currently playing ${track.name}!`);
}).catch(() => {
message.channel.send(`No track found for ${args[0]}`);
});
}
// Error 2:
// Not playing
if(command === 'queue'){
let playing = client.player.isPlaying(message.guild.id);
if(!playing) return message.channel.send(':x: No tracks currently playing!');
// you are sure it works:
client.player.getQueue(message.guild.id);
}
});
Examples of bots made with discord-player
These bots are made by the community, they can help you build your own!