Discord Player
Complete framework to facilitate music commands using discord.js.

Installation
$ npm install --save discord-player
$ npm install --save @discordjs/opus
$ npm install --save opusscript
Install streaming library (if you want to play from youtube)
$ npm install --save play-dl
$ npm install --save ytdl-core
Install FFmpeg or Avconv
Features
- Simple & easy to use 🤘
- Beginner friendly 😱
- Audio filters 🎸
- Lavalink compatible 15 band equalizer 🎚️
- Digital biquad filters support
- Lightweight ☁️
- Custom extractors support 🌌
- Multiple sources support ✌
- Play in multiple servers at the same time 🚗
- Does not inject anything to discord.js or your discord.js client 💉
- Allows you to have full control over what is going to be streamed 👑
Getting Started
First of all, you will need to register slash commands:
const { REST } = require('@discordjs/rest');
const { Routes, ApplicationCommandOptionType } = require('discord.js');
const commands = [
{
name: 'play',
description: 'Plays a song!',
options: [
{
name: 'query',
type: ApplicationCommandOptionType.String,
description: 'The song you want to play',
required: true
}
]
}
];
const rest = new REST({ version: '10' }).setToken('BOT_TOKEN');
(async () => {
try {
console.log('Started refreshing application [/] commands.');
await rest.put(Routes.applicationGuildCommands(CLIENT_ID, GUILD_ID), { body: commands });
console.log('Successfully reloaded application [/] commands.');
} catch (error) {
console.error(error);
}
})();
Now you can implement your bot's logic:
const { Client } = require('discord.js');
const client = new Discord.Client({
intents: ['Guilds', 'GuildVoiceStates']
});
const { Player } = require('discord-player');
const player = new Player(client);
player.events.on('playerStart', (queue, track) => queue.metadata.channel.send(`🎶 | Now playing **${track.title}**!`));
player.events.on('playerFinish', (queue, track) => queue.metadata.channel.send(`🎶 | Now playing **${track.title}**!`));
client.once('ready', () => {
console.log("I'm ready !");
});
client.on('interactionCreate', async (interaction) => {
if (!interaction.isChatInputCommand()) return;
if (interaction.commandName === 'play') {
const voiceChannel = interaction.member.voice.channelId;
if (!voiceChannel) return await interaction.reply({ content: 'You are not in a voice channel!', ephemeral: true });
if (interaction.guild.members.me.voice.channelId && voiceChannel !== interaction.guild.members.me.voice.channelId)
return await interaction.reply({ content: 'You are not in my voice channel!', ephemeral: true });
await interaction.deferReply({ ephemeral: true });
const query = interaction.options.getString('query');
try {
const res = await player.play(voiceChannel, query, {
nodeOptions: {
metadata: {
channel: interaction.channel
}
}
});
return await interaction.followUp({ content: `⏱️ | Loading track **${res.track.title}**!` });
} catch(e) {
return await interaction.followUp({ content: `Could not play: ${e.message}`, ephemeral: true });
}
}
});
client.login('BOT_TOKEN');
Supported sources
By default, discord-player supports the following sources:
- Local file (You must set the search engine to
QueryType.FILE
in order to play local files) - Raw attachments
- Spotify (Streamed from youtube)
- Apple Music (Streamed from youtube)
- Vimeo
- Reverbnation
- SoundCloud
You can also force a specific extractor to resolve your search query. This is useful in some cases where you don't want to use other sources.
You can do so by using ext:<EXTRACTOR_IDENTIFIER>
in searchEngine
value. Example:
const result = await player.search(query, {
searchEngine: 'ext:com.discord-player.soundcloudextractor'
});
Adding more sources
Discord Player provides an Extractor API that enables you to use your custom stream extractor with it. Some packages have been made by the community to add new features using this API.
Audio Filters
Discord Player supports various audio filters. There are 4 types of audio filters in discord-player.
FFmpeg
The most common and powerful method is FFmpeg. It supports a lot of audio filters. To set ffmpeg filter, you can do:
await queue.filters.ffmpeg.setFilters(['bassboost', 'nightcore']);
Note that there can be a delay between filters transition in this method.
Equalizer
This equalizer is very similar to Lavalink's 15 Band Equalizer. To use this, you can do:
queue.filters.equalizer.setEQ([
{ band: 0, gain: 0.25 },
{ band: 1, gain: 0.25 },
{ band: 2, gain: 0.25 }
]);
There is no delay between filter transition when using equalizer.
Biquad
This filter provides digital biquad filterer to the player. To use this, you can do:
import { BiquadFilterType } from 'discord-player';
queue.filters.biquad.setFilter(BiquadFilterType.LowPass);
There is no delay between filter transition when using biquad filters.
Mini Audio Filters
This is another type of audio filters provider. It currently supports Tremolo
and 8D
filters only. To use this, you can do:
queue.filters.filters.setFilters(['8D']);
There is no delay between filters transition using this filter.
Example bots made with Discord Player
These bots are made by the community, they can help you build your own!
Use cookies with ytdl-core
const player = new Player(client, {
ytdlOptions: {
requestOptions: {
headers: {
cookie: 'YOUR_YOUTUBE_COOKIE'
}
}
}
});
Note: the above option is only used when ytdl-core is being used.
Use custom proxies
const HttpsProxyAgent = require('https-proxy-agent');
const proxy = 'http://user:pass@111.111.111.111:8080';
const agent = HttpsProxyAgent(proxy);
const player = new Player(client, {
ytdlOptions: {
requestOptions: { agent }
}
});
You may also create a simple proxy server and forward requests through it.
See https://github.com/http-party/node-http-proxy for more info.
Custom stream Engine
Discord Player by default uses registered extractors to stream audio. If you need to override what needs to be streamed, you can use this hook.
const fs = require('fs');
const queue = player.nodes.create(..., {
...,
async onBeforeCreateStream(track, source, _queue) {
if (track.title === 'some title') {
return fs.createReadStream('./playThisInstead.mp3');
}
}
});
\<GuildQueue>.onBeforeCreateStream
is called before actually downloading the stream. It is a different concept from extractors, where you are just downloading
streams. source
here will be a track source. Streams from onBeforeCreateStream
are then piped to FFmpeg
and finally sent to Discord voice servers.