Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/androz2091/discord-player

🎧 Complete framework to simplify the implementation of music commands using discord.js v14
https://github.com/androz2091/discord-player

bot custom discord discord-player framework hacktoberfest music play queue-management search youtube

Last synced: 22 days ago
JSON representation

🎧 Complete framework to simplify the implementation of music commands using discord.js v14

Awesome Lists containing this project

README 

        
# Discord Player



Discord Player is a robust framework for developing Discord Music bots using JavaScript and TypeScript. It is built on top of the [discord-voip](https://npm.im/discord-voip) library and offers a comprehensive set of customizable tools, making it one of the most feature enrich framework in town.



[![downloadsBadge](https://img.shields.io/npm/dt/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)

[![versionBadge](https://img.shields.io/npm/v/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)

[![discordBadge](https://img.shields.io/discord/558328638911545423?style=for-the-badge&color=7289da)](https://androz2091.fr/discord)



# Why Choose Discord Player?



-   Beginner-friendly with easy-to-understand features

-   TypeScript support

-   Offers hackable APIs.

-   Supports audio player sharing

-   Quick and easy setup process

-   Wide range of player management features

-   Offers 64+ built-in audio filter presets

-   Highly customizable according to your needs

-   Automatic queue management

-   Query caching support

-   Extensible sources through the Extractors API

-   Object-oriented design

-   Built-in stats tracker

-   Offers easy debugging methods

-   Out-of-the-box voice states handling

-   IP Rotation support

-   Easy serialization and deserialization



## Installation



### Before you start



Discord Player requires Discord.js 14.0 or higher. Please ensure that you have a compatible version by running `npm list discord.js` in your terminal. If you're using an earlier version, please update it. The [discord.js Guide](https://discordjs.guide) provides resources to assist you with the update process.



#### Main Library



```bash

$ npm install --save discord-player # main library

$ npm install --save @discord-player/extractor # extractors provider

```



> Discord Player recognizes `@discord-player/extractor` and loads it automatically by default. Just invoke `await player.extractors.loadDefault()`.



#### Opus Library



Since Discord only accepts opus packets, you need to install the opus library. Discord Player supports multiple opus libraries, such as:



-   [mediaplex](https://npmjs.com/mediaplex)

-   [@discordjs/opus](https://npmjs.com/@discordjs/opus)

-   [opusscript](https://npmjs.com/opusscript)

-   [@evan/opus](https://npmjs.com/@evan/opus)

-   [node-opus](https://npmjs.com/node-opus)



Among these, mediaplex is the recommended library as it adds more functionalities to discord-player than just libopus interface. You can install opus libraries by running:



```bash

$ npm install --save mediaplex

# or

$ npm install --save @discordjs/opus

# or

$ npm install --save opusscript

# or

$ npm install --save @evan/opus

# or

$ npm install --save node-opus

```



#### FFmpeg or Avconv



FFmpeg or Avconv is required for media transcoding. You can obtain it from [https://ffmpeg.org](https://ffmpeg.org) or via npm.



> We do not recommend installing ffmpeg via npm because binaries pulled from npm is known to be unstable. It is recommended to install it from the official source.



```bash

$ npm install --save ffmpeg-static

# or

$ npm install --save @ffmpeg-installer/ffmpeg

# or

$ npm install --save @node-ffmpeg/node-ffmpeg-installer

# or

$ npm install --save ffmpeg-binaries

```



> Use `FFMPEG_PATH` environment variable to load ffmpeg from custom path.



#### Streaming Library



**The following method is deprecated and will be removed in the future. Please switch to [discord-player-youtubei](https://npmjs.com/discord-player-youtubei).**



**Not recommended**:



YouTube streaming is not supported without installing one of the following package. If you want to add support for YouTube playback, you need to install a streaming library. This step is not needed if you do not plan on using youtube source.



```bash

$ npm install --save youtube-ext

# or

$ npm install --save play-dl

# or

$ npm install --save @distube/ytdl-core

# or

$ npm install --save yt-stream

# or

$ npm install --save ytdl-core

```



Once you have completed these installations, let's proceed with writing a simple music bot.



### Setup



Let's create a main player instance. This instance handles and keeps track of all the queues and its components.



```js index.js

const { Player } = require('discord-player');



const client = new Discord.Client({

    // Make sure you have 'GuildVoiceStates' intent enabled

    intents: ['GuildVoiceStates' /* Other intents */]

});



// this is the entrypoint for discord-player based application

const player = new Player(client);



// Now, lets load all the default extractors, except 'YouTubeExtractor'. You can remove the filter if you want to include youtube.

await player.extractors.loadDefault((ext) => ext !== 'YouTubeExtractor');

```



Discord Player is mostly events based. It emits different events based on the context and actions. Let's add a basic event listener to notify the user when a track starts to play:



```js index.js

// this event is emitted whenever discord-player starts to play a track

player.events.on('playerStart', (queue, track) => {

    // we will later define queue.metadata object while creating the queue

    queue.metadata.channel.send(`Started playing **${track.cleanTitle}**!`);

});

```



Let's move on to the command part. You can define the command as per your requirements. We will only focus on the command part:



```js play.js

const { useMainPlayer } = require('discord-player');



export async function execute(interaction) {

    const player = useMainPlayer();

    const channel = interaction.member.voice.channel;

    if (!channel) return interaction.reply('You are not connected to a voice channel!'); // make sure we have a voice channel

    const query = interaction.options.getString('query', true); // we need input/query to play



    // let's defer the interaction as things can take time to process

    await interaction.deferReply();



    try {

        const { track } = await player.play(channel, query, {

            nodeOptions: {

                // nodeOptions are the options for guild node (aka your queue in simple word)

                metadata: interaction // we can access this metadata object using queue.metadata later on

            }

        });



        return interaction.followUp(`**${track.cleanTitle}** enqueued!`);

    } catch (e) {

        // let's return error if something failed

        return interaction.followUp(`Something went wrong: ${e}`);

    }

}

```



That's all it takes to build your own music bot. Please check out the [Documentation](https://discord-player.js.org) for more features/functionalities.



## Community Resources



Explore a curated list of resources built by the Discord Player community, including open-source music bots and extractors. Visit [https://discord-player.js.org/showcase](https://discord-player.js.org/showcase) for more information.