5.3 KiB
Discord Player
Complete framework to facilitate music commands using discord.js.
V5 WIP
Installation
Install discord-player
$ npm install --save discord-player
Install @discordjs/opus
$ npm install --save @discordjs/opus
Install FFmpeg or Avconv
-
Official FFMPEG Website: https://www.ffmpeg.org/download.html
-
Node Module (FFMPEG): https://npmjs.com/package/ffmpeg-static
-
Avconv: https://libav.org/download
Features
- Simple & easy to use 🤘
- Beginner friendly 😱
- Audio filters 🎸
- Lightweight 🛬
- Custom extractors support 🌌
- Lyrics 📃
- Multiple sources support ✌
- Play in multiple servers at the same time 🚗
Documentation
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({ intents: ["GUILD_VOICE_STATES", "GUILD_MESSAGES", "GUILDS"] }),
settings = {
prefix: "!",
token: "Your Discord Token"
};
const { Player, QueryType } = 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", (queue, track) => queue.metadata.channel.send(`Now playing ${track.title}...`))
client.once("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 voice channel
if (command === "play") {
if (!message.member.voice.channel) return void message.reply("You are not in a voice channel!");
if (message.guild.me.voice.channel && message.member.voice.channelID !== message.guild.me.voice.channelID) return void message.reply("You are not in my voice channel!");
const queue = client.player.createQueue(message.guild, {
metadata: message
});
// verify vc connection
try {
if (!queue.connection) await queue.connect(message.member.voice.channel);
} catch {
queue.destroy();
return void message.reply("Could not join your voice channel!");
}
const track = await client.player.search(args[0], {
searchEngine: QueryType.YOUTUBE_SEARCH
}).then(x => x.tracks[1]);
if (!track) return void message.reply("Track not found!");
queue.play(track);
}
});
client.login(settings.token);
Supported websites
By default, discord-player supports YouTube, Spotify and SoundCloud streams only.
Optional dependencies
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.
@discord-player/extractor (optional)
Optional package that adds support for vimeo, reverbnation, facebook, attachment links and lyrics.
You just need to install it using npm i --save @discord-player/extractor (discord-player will automatically detect and use it).
@discord-player/downloader (optional)
@discord-player/downloader is an optional package that brings support for +700 websites. The documentation is available here.
Examples of bots made with Discord Player
These bots are made by the community, they can help you build your own!
Advanced
Use cookies
const player = new Player(client, {
ytdlDownloadOptions: {
requestOptions: {
headers: {
cookie: "YOUR_YOUTUBE_COOKIE"
}
}
}
});
Use custom proxies
const HttpsProxyAgent = require("https-proxy-agent");
// Remove "user:pass@" if you don't need to authenticate to your proxy.
const proxy = "http://user:pass@111.111.111.111:8080";
const agent = HttpsProxyAgent(proxy);
const player = new Player(client, {
ytdlDownloadOptions: {
requestOptions: { agent }
}
});