Need help with discord-player?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Androz2091
147 Stars 47 Forks MIT License 247 Commits 34 Opened issues

Description

🎧 Complete framework to simplify the implementation of music commands using discords.js v12

Services available

!
?

Need anything else?

Contributors list

# 29,520
Discord
js
Bootstr...
HTML
212 commits
# 214,009
github-...
JavaScr...
discord...
HTML
9 commits
# 579,181
JavaScr...
Discord
2 commits
# 222,773
JavaScr...
TypeScr...
ESLint
eslint-...
1 commit
# 173,067
C++
PHP
bcrypt
Discord
1 commit
# 142,687
C#
indexer
HTML
tracker...
1 commit

Discord Player

downloadsBadge versionBadge patreonBadge

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! It doesn't require any api key, as it uses scraping.

Installation

npm install --save discord-player

Install @discordjs/opus:

npm install --save @discordjs/opus

Install FFMPEG and you're done!

Features

🤘 Easy to use!
🎸 You can apply some cool filters (bassboost, reverse, 8D, etc...)
🎼 Manage your server queues with simple functions (add songs, skip the current song, pause the music, resume it, etc...)!
🌐 Multi-servers support

Getting Started

Here is the code you will need to get started with discord-player. Then, you will be able to use

client.player
everywhere in your code!
const Discord = require("discord.js"),
client = new Discord.Client(),
settings = {
    prefix: "!",
    token: "Your Discord Token"
};

const { Player } = require("discord-player"); // Create a new Player (you don't need any API Key) const player = new Player(client); // To easily access the player client.player = player; // add the trackStart event so when a song will be played this message will be sent client.player.on('trackStart', (message, track) => message.channel.send(Now playing ${track.title}...))

client.on("ready", () => { console.log("I'm ready !"); });

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"){
    client.player.play(message, args[0]);
    // as we registered the event above, no need to send a success message here
}

});

client.login(settings.token);

Documentation

You will find many examples in the documentation to understand how the package works!

Methods overview

You need to init the guild queue using the play() function, then you are able to manage the queue and the music using the following functions. Click on a function name to get an example code and explanations.

Play a track

Check if a track is being played

Manage the queue

Manage music stream

Event messages

// Then add some messages that will be sent when the events will be triggered
client.player

// Send a message when a track starts .on('trackStart', (message, track) => message.channel.send(Now playing ${track.title}...))

// Send a message when something is added to the queue .on('trackAdd', (message, queue, track) => message.channel.send(${track.title} has been added to the queue!)) .on('playlistAdd', (message, queue, playlist) => message.channel.send(${playlist.title} has been added to the queue (${playlist.tracks.length} songs)!))

// Send messages to format search results .on('searchResults', (message, query, tracks) => {

const embed = new Discord.MessageEmbed()
.setAuthor(`Here are your search results for ${query}!`)
.setDescription(tracks.map((t, i) => `${i}. ${t.title}`))
.setFooter('Send the number of the song you want to play!')
message.channel.send(embed);

}) .on('searchInvalidResponse', (message, query, tracks, content, collector) => {

if (content === 'cancel') {
    collector.stop()
    return message.channel.send('Search cancelled!')
}

message.channel.send(`You must send a valid number between 1 and ${tracks.length}!`)

}) .on('searchCancel', (message, query, tracks) => message.channel.send('You did not provide a valid response... Please send the command again!')) .on('noResults', (message, query) => message.channel.send(No results found on YouTube for ${query}!))

// Send a message when the music is stopped .on('queueEnd', (message, queue) => message.channel.send('Music stopped as there is no more music in the queue!')) .on('channelEmpty', (message, queue) => message.channel.send('Music stopped as there is no more member in the voice channel!')) .on('botDisconnect', (message) => message.channel.send('Music stopped as I have been disconnected from the channel!'))

// Error handling .on('error', (error, message) => { switch(error){ case 'NotPlaying': message.channel.send('There is no music being played on this server!') break; case 'NotConnected': message.channel.send('You are not connected in any voice channel!') break; case 'UnableToJoin': message.channel.send('I am not able to join your voice channel, please check my permissions!') break; case 'LiveVideo': message.channel.send('YouTube lives are not supported!') break; default: message.channel.send(Something went wrong... Error: ${error}) } })

Examples of bots made with discord-player

These bots are made by the community, they can help you build your own!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.