distube 2.8.15 → 3.0.0-0

package/README.md

@@ -3,28 +3,32 @@
     <a href="https://nodei.co/npm/distube/"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"></a>
   </p>
   <p>
-    <img alt="npm" src="https://img.shields.io/npm/dt/distube">
-    <img alt="Depfu" src="https://img.shields.io/depfu/skick1234/DisTube">
-    <img alt="Codacy Grade" src="https://img.shields.io/codacy/grade/79c8b7d7d026410f8e1b7e9d326167a7?label=Codacy%20Score">
-    <img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/skick1234/DisTube?label=Codefactor%20Score">
+    <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/skick1234/DisTube/Testing?label=Tests&logo=github&style=flat-square">
+    <img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square">
+    <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/distube/peer/discord.js?label=discord.js&logo=discord&logoColor=white&style=flat-square">
+    <img alt="Depfu" src="https://img.shields.io/depfu/skick1234/DisTube?style=flat-square">
+    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
+    <br>
+    <img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square">
+    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square">
+    <img alt="Discord" src="https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square">
   </p>
 </div>
 
 # DisTube
 
-A Discord.js v12 module to simplify your music commands and play songs with audio filters on Discord without any API key.
+A Discord.js module to simplify your music commands and play songs with audio filters on Discord without any API key.
 
-[DisTube Support Server](https://discord.gg/feaDd9h) - [Frequently Asked Questions](https://github.com/skick1234/DisTube/wiki/Frequently-Asked-Questions)
+[DisTube Support Server](https://discord.gg/feaDd9h) - [Frequently Asked Questions](https://discord.gg/feaDd9h)
 
 ## Features
 
-- Build on discord.js v12
-- Easily to use and customize
+- Build on `@discordjs/voice`
+- Easy to use and customize
 - Support YouTube, SoundCloud, Facebook, and [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html)
 - Audio filters (bassboost, nightcore, vaporwave,...)
-- Autoplay related YouTube songs
-- Prebuilt server queue
-- Multiple servers compatible
+- Autoplay related songs
+- Plugin system to support more sites ([Plugin List](https://distube.js.org/#/docs/DisTube/stable/plugin/list))
 
 ## Installation
 
@@ -33,10 +37,15 @@ npm install distube
 ```
 
 ### Requirement
-- [discord.js](https://discord.js.org) v12 or v13
-- [FFmpeg](https://www.ffmpeg.org/download.html) - `npm install ffmpeg-static`
-- [@discordjs/opus](https://github.com/discordjs/opus) - `npm install @discordjs/opus`
-- [python](https://www.python.org/) *(For [`youtube-dl`](http://ytdl-org.github.io/youtube-dl/) to support [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html).)*
+
+- Node v12 or higher
+- [git](https://git-scm.com/downloads) _(For installing forked dependencies)_
+- [discord.js](https://discord.js.org) v12 or **v13 _(Recommended)_**
+- [@discordjs/voice](https://github.com/discordjs/voice)
+- [FFmpeg](https://www.ffmpeg.org/download.html)
+- [@discordjs/opus](https://github.com/discordjs/opus)
+- [sodium](https://www.npmjs.com/package/sodium) or [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers)
+- [python](https://www.python.org/) _(Optional - For [`youtube-dl`](https://youtube-dl.org/) to support [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html).)_
 
 ## Documentation
 
@@ -44,88 +53,13 @@ Read DisTube's definitions, properties and events details in the [Documentation
 
 ## Example Bot
 
-- [DisTube-Bot](https://skick.xyz/DisTube) - A music bot with reaction controller, filters, DJ mode, user's custom playlist and voting.
-- [DisTube-Example](https://github.com/distubejs/example) - Example bot with simple command handler.
-
-```javascript
-
-// DisTube example bot, definitions, properties and events details in the Documentation page.
-const Discord = require('discord.js'),
-    DisTube = require('distube'),
-    client = new Discord.Client(),
-    config = {
-        prefix: ".",
-        token: process.env.TOKEN || "Your Discord Token"
-    };
-
-// Create a new DisTube
-const distube = new DisTube(client, { searchSongs: true, emitNewSongOnly: true });
-
-client.on('ready', () => {
-    console.log(`Logged in as ${client.user.tag}!`);
-});
-
-client.on("message", async (message) => {
-    if (message.author.bot) return;
-    if (!message.content.startsWith(config.prefix)) return;
-    const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-    const command = args.shift();
-
-    if (command == "play")
-        distube.play(message, args.join(" "));
-
-    if (["repeat", "loop"].includes(command))
-        distube.setRepeatMode(message, parseInt(args[0]));
-
-    if (command == "stop") {
-        distube.stop(message);
-        message.channel.send("Stopped the music!");
-    }
-
-    if (command == "skip")
-        distube.skip(message);
-
-    if (command == "queue") {
-        let queue = distube.getQueue(message);
-        message.channel.send('Current queue:\n' + queue.songs.map((song, id) =>
-            `**${id + 1}**. ${song.name} - \`${song.formattedDuration}\``
-        ).slice(0, 10).join("\n"));
-    }
-
-    if ([`3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`].includes(command)) {
-        let filter = distube.setFilter(message, command);
-        message.channel.send("Current queue filter: " + (filter || "Off"));
-    }
-});
-
-// Queue status template
-const status = (queue) => `Volume: \`${queue.volume}%\` | Filter: \`${queue.filter || "Off"}\` | Loop: \`${queue.repeatMode ? queue.repeatMode == 2 ? "All Queue" : "This Song" : "Off"}\` | Autoplay: \`${queue.autoplay ? "On" : "Off"}\``;
+- [DisTube Bot](https://skick.xyz/DisTube) - A music bot with reaction controller, filters, DJ mode, user's custom playlist and voting.
+- [DisTube Example](https://github.com/distubejs/example) - Example bot with simple command handler.
+- [DisTube Guide](https://distube.js.org/guide) - How to build a music bot from scratch.
 
-// DisTube event listeners, more in the documentation page
-distube
-    .on("playSong", (message, queue, song) => message.channel.send(
-        `Playing \`${song.name}\` - \`${song.formattedDuration}\`\nRequested by: ${song.user}\n${status(queue)}`
-    ))
-    .on("addSong", (message, queue, song) => message.channel.send(
-        `Added ${song.name} - \`${song.formattedDuration}\` to the queue by ${song.user}`
-    ))
-    .on("playList", (message, queue, playlist, song) => message.channel.send(
-        `Play \`${playlist.name}\` playlist (${playlist.songs.length} songs).\nRequested by: ${song.user}\nNow playing \`${song.name}\` - \`${song.formattedDuration}\`\n${status(queue)}`
-    ))
-    .on("addList", (message, queue, playlist) => message.channel.send(
-        `Added \`${playlist.name}\` playlist (${playlist.songs.length} songs) to queue\n${status(queue)}`
-    ))
-    // DisTubeOptions.searchSongs = true
-    .on("searchResult", (message, result) => {
-        let i = 0;
-        message.channel.send(`**Choose an option from below**\n${result.map(song => `**${++i}**. ${song.name} - \`${song.formattedDuration}\``).join("\n")}\n*Enter anything else or wait 60 seconds to cancel*`);
-    })
-    // DisTubeOptions.searchSongs = true
-    .on("searchCancel", (message) => message.channel.send(`Searching canceled`))
-    .on("error", (message, e) => {
-        console.error(e)
-        message.channel.send("An error encountered: " + e);
-    });
+## Dependencies
 
-client.login(config.token);
-```
+- [node-ytdl-core](https://github.com/fent/node-ytdl-core): YouTube scraper ([DisTube Fork](https://github.com/distubejs/node-ytdl-core))
+- [node-ytsr](https://github.com/TimeForANinja/node-ytsr): YouTube search scraper ([DisTube Fork](https://github.com/distubejs/ytsr))
+- [node-ytpl](https://github.com/TimeForANinja/node-ytpl): YouTube playlist resolver ([DisTube Fork](https://github.com/distubejs/ytpl))
+- [youtube-dl-exec](https://github.com/microlinkhq/youtube-dl-exec): [`youtube-dl`](https://youtube-dl.org/) wrapper