distube 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -28
- package/dist/index.d.ts +788 -520
- package/dist/index.js +505 -469
- package/dist/index.js.map +1 -1
- package/package.json +44 -68
package/README.md
CHANGED
|
@@ -1,17 +1,19 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<p>
|
|
3
|
-
<a href="https://www.npmjs.com/package/distube" target="_blank"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"
|
|
3
|
+
<a href="https://www.npmjs.com/package/distube" target="_blank"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"/></a>
|
|
4
4
|
</p>
|
|
5
5
|
<p>
|
|
6
|
-
<a href="https://github.com/skick1234/DisTube/actions" target="_blank"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/skick1234/DisTube/test.yml?branch=main&label=Tests&logo=github&style=flat-square"
|
|
7
|
-
<a href="https://nodejs.org/" target="_blank"><img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square"
|
|
8
|
-
<a href="https://discord.js.org/" target="_blank"><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"
|
|
9
|
-
<a href="https://
|
|
10
|
-
<
|
|
11
|
-
<
|
|
12
|
-
<a href="https://
|
|
13
|
-
<a href="https://
|
|
14
|
-
|
|
6
|
+
<a href="https://github.com/skick1234/DisTube/actions" target="_blank"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/skick1234/DisTube/test.yml?branch=main&label=Tests&logo=github&style=flat-square" /></a>
|
|
7
|
+
<a href="https://nodejs.org/" target="_blank"><img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square"/></a>
|
|
8
|
+
<a href="https://discord.js.org/" target="_blank"><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"/></a>
|
|
9
|
+
<a href="https://app.codecov.io/gh/skick1234/DisTube" target="_blank"><img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW"/></a>
|
|
10
|
+
<br/>
|
|
11
|
+
<a href="https://www.npmjs.com/package/distube" target="_blank"><img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square"/></a>
|
|
12
|
+
<a href="https://github.com/skick1234/DisTube/stargazers" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square"/></a>
|
|
13
|
+
<a href="https://discord.gg/feaDd9h" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square"/></a>
|
|
14
|
+
</p>
|
|
15
|
+
<p>
|
|
16
|
+
<a href='https://ko-fi.com/skick' target='_blank'><img height='48' src='https://storage.ko-fi.com/cdn/kofi3.png' alt='Buy Me a Coffee at ko-fi.com' /></a>
|
|
15
17
|
</p>
|
|
16
18
|
</div>
|
|
17
19
|
|
|
@@ -23,35 +25,23 @@ A Discord.js module to simplify your music commands and play songs with audio fi
|
|
|
23
25
|
|
|
24
26
|
## Features
|
|
25
27
|
|
|
26
|
-
- Based on `@discordjs/voice`
|
|
27
28
|
- Easy to use and customize
|
|
28
29
|
- Support YouTube and audio link
|
|
29
30
|
- Audio filters (bassboost, nightcore, vaporwave,...)
|
|
30
|
-
-
|
|
31
|
-
- Plugin system to support more sites ([Plugin List](https://
|
|
31
|
+
- Auto-play related songs
|
|
32
|
+
- Plugin system to support more sites ([Plugin List](https://github.com/skick1234/DisTube/wiki/Projects-Hub#plugins))
|
|
32
33
|
|
|
33
34
|
## Requirement
|
|
34
35
|
|
|
35
|
-
- Node.js
|
|
36
|
+
- Node.js 18.17.0 or higher
|
|
36
37
|
- [discord.js](https://discord.js.org) v14
|
|
37
38
|
- [@discordjs/voice](https://github.com/discordjs/voice)
|
|
38
39
|
- [FFmpeg](https://www.ffmpeg.org/download.html)
|
|
39
40
|
- [@discordjs/opus](https://github.com/discordjs/opus)
|
|
40
|
-
- [sodium](https://www.npmjs.com/package/sodium
|
|
41
|
-
|
|
42
|
-
## Installation
|
|
43
|
-
|
|
44
|
-
```npm
|
|
45
|
-
npm install distube@latest
|
|
46
|
-
```
|
|
41
|
+
- [sodium-native](https://www.npmjs.com/package/sodium-native)
|
|
47
42
|
|
|
48
43
|
## Documentation
|
|
49
44
|
|
|
50
|
-
Read DisTube's definitions, properties and events details in the [Documentation page](https://distube.js.org/).
|
|
51
|
-
|
|
52
|
-
Learn how to build a music bot from scratch with [DisTube Guide](https://distube.js.org/guide)
|
|
53
|
-
|
|
54
|
-
## Example Bot
|
|
45
|
+
Read DisTube's definitions, properties and events details in the [API Documentation page](https://distube.js.org/).
|
|
55
46
|
|
|
56
|
-
|
|
57
|
-
- [DisTube Example](https://github.com/distubejs/example) - Example bot with simple command handler.
|
|
47
|
+
Learn how to build a music bot from scratch with [DisTube Guide](https://github.com/skick1234/DisTube/wiki)
|