distube 3.0.0-beta.8 → 3.0.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Skick
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Skick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,51 +1,64 @@
-<div align="center">
-  <p>
-    <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">
-  </p>
-</div>
-
-# DisTube
-
-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)
-
-## Features
-
--   Build on discord.js v12
--   Easily 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
-
-## Installation
-
-```npm
-npm install distube
-```
-
-### Requirement
-
--   Node v14.x or higher
--   [discord.js](https://discord.js.org) v12 / master branch (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).)_
-
-## Documentation
-
-Read DisTube's definitions, properties and events details in the [Documentation page](https://distube.js.org/).
-
-## 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.
--   [DisTube Guide](https://distube.js.org/guide) - How to build a music bot from scratch.
+<div align="center">
+  <p>
+    <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="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 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://discord.gg/feaDd9h)
+
+## Features
+
+- 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 songs
+- Plugin system to support more sites ([Plugin List](https://distube.js.org/#/docs/DisTube/stable/plugin/list))
+
+## Installation
+
+```npm
+npm install distube
+```
+
+### Requirement
+
+- Node v12 or higher
+- [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
+
+Read DisTube's definitions, properties and events details in the [Documentation page](https://distube.js.org/).
+
+## 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.
+- [DisTube Guide](https://distube.js.org/guide) - How to build a music bot from scratch.
+
+## Dependencies
+
+- [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