discord-player 6.2.0 → 6.3.0

package/README.md

@@ -11,6 +11,7 @@ It provides easy set of customizable tools to develop Discord Music bots.
 
 -   Beginner friendly, easy to understand
 -   TypeScript support
+-   Supports audio player sharing
 -   Quick and easy to set up
 -   Wide range of player management features
 -   64+ built-in audio filter presets
@@ -23,7 +24,7 @@ It provides easy set of customizable tools to develop Discord Music bots.
 
 ## Installation
 
-## Before you start
+### Before you start
 
 Discord Player requires Discord.js 14.0 or higher. PLease make sure you have a compatible version using `npm list discord.js` in your terminal. If you're using an earlier version please update it. The [Discord.JS Guide](https://discordjs.guide/) has resources to help with that.
 
@@ -42,18 +43,25 @@ Discord Player is a high level framework for Discord VoIP. Discord only accepts
 
 ```bash
 $ yarn add @discordjs/opus
+# or
 $ yarn add opusscript
 ```
 
 #### FFmpeg or Avconv
 
-FFmpeg or Avconv is required for media transcoding. You can get it from [https://ffmpeg.org](https://www.ffmpeg.org/download.html) or by installing it from npm:
+FFmpeg or Avconv is required for media transcoding. You can get it from [https://ffmpeg.org](https://www.ffmpeg.org/download.html) or by installing it from npm (ffmpeg-static or other binaries are not recommended):
 
 ```bash
 $ yarn add ffmpeg-static
+# or
+$ yarn add @ffmpeg-installer/ffmpeg
+# or
+$ yarn add @node-ffmpeg/node-ffmpeg-installer
+# or
+$ yarn add ffmpeg-binaries
 ```
 
-You can get avconv from [https://libav.org/download](https://libav.org/download).
+> Use `FFMPEG_PATH` environment variable to load ffmpeg from custom path.
 
 #### Streaming Library
 
@@ -61,7 +69,9 @@ You also need to install streaming library if you want to add support for youtub
 
 ```bash
 $ yarn add ytdl-core
+# or
 $ yarn add play-dl
+# or
 $ yarn add @distube/ytdl-core
 ```
 
@@ -73,13 +83,25 @@ Let's create a master player instance.
 
 ```js
 const { Player } = require('discord-player');
+
+// get some extractors if you want to handpick sources
+const { SpotifyExtractor, SoundCloudExtractor } = require('@discord-player/extractor');
+
 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);
+
+// This method will load all the extractors from the @discord-player/extractor package
+await player.extractors.loadDefault();
+
+// If you dont want to use all of the extractors and register only the required ones manually, use
+await player.extractors.register(SpotifyExtractor, {});
+await player.extractors.register(SoundCloudExtractor, {});
 ```
 
 > **Did You Know?** _Discord Player is by default a singleton._
@@ -128,4 +150,4 @@ That's all it takes to build your own music bot.
 ## Community Resources
 
 A curated list of resources (such as open source music bots, extractors, etc.) built by Discord Player community.
-[https://discord-player.js.org/docs/guides/community-resources](https://discord-player.js.org/docs/guides/community-resources)
+[https://discord-player.js.org/docs/guides/community-resources](https://discord-player.js.org/docs/guides/community-resources)