shoukaku-bun 4.2.0-c → 4.2.1
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 +11 -59
- package/package.json +64 -65
package/README.md
CHANGED
|
@@ -1,16 +1,11 @@
|
|
|
1
1
|
## Shoukaku-Bun
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://paypal.me/l0g4n7)
|
|
5
|
-
[](https://www.npmjs.com/package/shoukaku-bun)
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
3
|
+
<p align="center"><a href="https://github.com/sponsors/LuigiColantuono"><img src="https://img.shields.io/github/sponsors/LuigiColantuono?style=social"></a> <a href="https://paypal.me/l0g4n7"><img src="https://img.shields.io/badge/💖-Support-ff69b4"></a> <img src="https://img.shields.io/npm/v/shoukaku-bun"> <img src="https://img.shields.io/npm/dm/shoukaku-bun?label=downloads"> <img src="https://img.shields.io/npm/l/shoukaku-bun"> <img src="https://img.shields.io/github/repo-size/LuigiColantuono/Shoukaku-Bun"> <a href="https://github.com/LuigiColantuono/Shoukaku-Bun"><img src="https://img.shields.io/badge/Bun-Networking-black?logo=bun"></a></p>
|
|
9
4
|
|
|
10
5
|
> Powerful, Lightweight wrapper around Lavalink
|
|
11
6
|
|
|
12
7
|
<p align="center">
|
|
13
|
-
<img src="https://azurlane.netojuu.com/images/thumb/d/dc/ShoukakuWeddingWithoutBG.png/767px-ShoukakuWeddingWithoutBG.png">
|
|
8
|
+
<img src="https://azurlane.netojuu.com/images/thumb/d/dc/ShoukakuWeddingWithoutBG.png/767px-ShoukakuWeddingWithoutBG.png" width="400">
|
|
14
9
|
</p>
|
|
15
10
|
|
|
16
11
|
### Features
|
|
@@ -29,7 +24,7 @@
|
|
|
29
24
|
| shoukaku | 366 kB | ws (~300 kB) | **~666 kB** |
|
|
30
25
|
| shoukaku-bun | 72.9 kB | **NONE** | **72.9 kB** |
|
|
31
26
|
|
|
32
|
-
**89% smaller install size!**
|
|
27
|
+
**89% smaller install size!**
|
|
33
28
|
|
|
34
29
|
## 🎵 The Story
|
|
35
30
|
|
|
@@ -39,68 +34,25 @@ entire Shoukaku stack could be rewritten to be faster and lighter.
|
|
|
39
34
|
|
|
40
35
|
**Result?** Zero warnings. Noticeably faster. Way more fun to work with.
|
|
41
36
|
|
|
42
|
-
If this solved your problems too, [consider supporting the project](https://paypal.me/
|
|
37
|
+
If this solved your problems too, [consider supporting the project](https://paypal.me/l0g4n7)!
|
|
43
38
|
Even a coffee helps keep the motivation high! ☕
|
|
44
39
|
|
|
45
40
|
### Installation
|
|
46
41
|
|
|
47
|
-
This is a specialized fork. Install it directly from GitHub:
|
|
48
|
-
|
|
49
42
|
```bash
|
|
50
43
|
bun add shoukaku-bun
|
|
51
44
|
```
|
|
52
45
|
|
|
53
|
-
|
|
54
46
|
### Official Documentation
|
|
55
47
|
|
|
56
48
|
> https://guide.shoukaku.shipgirl.moe/
|
|
49
|
+
> https://github.com/shipgirlproject/Shoukaku
|
|
57
50
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
> https://guide.shoukaku.shipgirl.moe/guides/1-getting-started/
|
|
61
|
-
|
|
62
|
-
### Supported Libraries
|
|
63
|
-
|
|
64
|
-
> https://guide.shoukaku.shipgirl.moe/guides/5-connectors/
|
|
65
|
-
|
|
66
|
-
### Example Bot
|
|
67
|
-
|
|
68
|
-
> https://github.com/Deivu/Kongou
|
|
69
|
-
|
|
70
|
-
### Configuration Options
|
|
71
|
-
|
|
72
|
-
```js
|
|
73
|
-
// Parameters for main class init, Options is the Configuration Options
|
|
74
|
-
new Shoukaku(new Connectors.DiscordJS(client), Nodes, Options);
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
| Option | Type | Default | Description | Notes |
|
|
78
|
-
| ---------------------- | ---------------------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------ |
|
|
79
|
-
| resume | boolean | false | If you want to enable resuming when your connection to lavalink disconnects | |
|
|
80
|
-
| resumeTimeout | number | 30 | Timeout before lavalink destroys the players on a disconnect | In seconds |
|
|
81
|
-
| resumeByLibrary | boolean | false | If you want to force resume players no matter what even if it's not resumable by lavalink | |
|
|
82
|
-
| reconnectTries | number | 3 | Number of tries to reconnect to lavalink before disconnecting | |
|
|
83
|
-
| reconnectInterval | number | 5 | Timeout between reconnects | In seconds |
|
|
84
|
-
| restTimeout | number | 60 | Maximum amount of time to wait for rest lavalink api requests | In seconds |
|
|
85
|
-
| moveOnDisconnect | boolean | false | Whether to move players to a different lavalink node when a node disconnects | |
|
|
86
|
-
| userAgent | string | (auto) | Changes the user-agent used for lavalink requests | Not recommeded to change |
|
|
87
|
-
| structures | Object{rest?, player?} | {} | Custom structures for shoukaku to use | |
|
|
88
|
-
| voiceConnectionTimeout | number | 15 | Maximum amount of time to wait for a join voice channel command | In seconds |
|
|
89
|
-
| nodeResolver | function | function | Custom node resolver if you want to have your own method of getting the ideal node | |
|
|
90
|
-
|
|
91
|
-
### Wrappers
|
|
92
|
-
|
|
93
|
-
| Name | Link | Description |
|
|
94
|
-
| -------- | --------------------------------------------- | -------------------------------------------------------- |
|
|
95
|
-
| Kazagumo-Bun | [Github](https://github.com/uigiColantuono/Kazagumo-Bun) | A wrapper for Shoukaku that has an internal queue system |
|
|
96
|
-
|
|
97
|
-
> Open a pr if you want to add a wrapper here
|
|
98
|
-
|
|
99
|
-
### Other Links
|
|
100
|
-
|
|
101
|
-
- [Discord](https://discord.gg/XqJw52d35R)
|
|
102
|
-
|
|
103
|
-
- [Lavalink](https://github.com/lavalink-devs/Lavalink)
|
|
51
|
+
## Performance
|
|
52
|
+
<img width="380" height="" alt="B R U C I U S 🎵" src="https://i.imgur.com/zZsPzm6.png" />
|
|
104
53
|
|
|
105
|
-
|
|
54
|
+
## Support
|
|
55
|
+
> Kazagumo support server: https://discord.gg/nPPW2Gzqg2 (anywhere lmao)
|
|
56
|
+
> Shoukaku support server: https://discord.gg/FVqbtGu (#development)
|
|
57
|
+
> Brucius support server: https://discord.gg/XqJw52d35R
|
|
106
58
|
|
package/package.json
CHANGED
|
@@ -1,65 +1,64 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "shoukaku-bun",
|
|
3
|
-
"version": "4.2.
|
|
4
|
-
"description": "Bun-native high-performance fork of Shoukaku. Node-dependencies purged.",
|
|
5
|
-
"main": "index.ts",
|
|
6
|
-
"module": "index.ts",
|
|
7
|
-
"types": "index.ts",
|
|
8
|
-
"files": [
|
|
9
|
-
"src",
|
|
10
|
-
"index.ts"
|
|
11
|
-
],
|
|
12
|
-
"exports": {
|
|
13
|
-
".": {
|
|
14
|
-
"types": "./index.ts",
|
|
15
|
-
"import": "./index.ts",
|
|
16
|
-
"require": "./index.ts"
|
|
17
|
-
}
|
|
18
|
-
},
|
|
19
|
-
"scripts": {
|
|
20
|
-
"lint": "eslint .",
|
|
21
|
-
"test": "bun test"
|
|
22
|
-
},
|
|
23
|
-
"keywords": [
|
|
24
|
-
"bot",
|
|
25
|
-
"music",
|
|
26
|
-
"lavalink",
|
|
27
|
-
"bun",
|
|
28
|
-
"high-performance",
|
|
29
|
-
"discord",
|
|
30
|
-
"websocket",
|
|
31
|
-
"zero-dependencies",
|
|
32
|
-
"typescript"
|
|
33
|
-
],
|
|
34
|
-
"engines": {
|
|
35
|
-
"bun": ">=1.3.6"
|
|
36
|
-
},
|
|
37
|
-
"author": "Saya",
|
|
38
|
-
"contributors": [
|
|
39
|
-
{
|
|
40
|
-
"name": "Luigi Colantuono",
|
|
41
|
-
"url": "https://github.com/LuigiColantuono"
|
|
42
|
-
}
|
|
43
|
-
],
|
|
44
|
-
"license": "MIT",
|
|
45
|
-
"homepage": "https://github.com/LuigiColantuono/Shoukaku-Bun#readme",
|
|
46
|
-
"repository": {
|
|
47
|
-
"type": "git",
|
|
48
|
-
"url": "git+https://github.com/LuigiColantuono/Shoukaku-Bun.git"
|
|
49
|
-
},
|
|
50
|
-
"bugs": {
|
|
51
|
-
"url": "https://github.com/LuigiColantuono/Shoukaku-Bun/issues"
|
|
52
|
-
},
|
|
53
|
-
"funding": {
|
|
54
|
-
"type": "individual",
|
|
55
|
-
"url": "https://paypal.me/l0g4n7"
|
|
56
|
-
},
|
|
57
|
-
"dependencies": {},
|
|
58
|
-
"devDependencies": {
|
|
59
|
-
"@shipgirl/eslint-config": "^0.
|
|
60
|
-
"@types/bun": "latest",
|
|
61
|
-
"eslint": "^9.39.2",
|
|
62
|
-
"
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "shoukaku-bun",
|
|
3
|
+
"version": "4.2.1",
|
|
4
|
+
"description": "Bun-native high-performance fork of Shoukaku. Node-dependencies purged.",
|
|
5
|
+
"main": "index.ts",
|
|
6
|
+
"module": "index.ts",
|
|
7
|
+
"types": "index.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"src",
|
|
10
|
+
"index.ts"
|
|
11
|
+
],
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./index.ts",
|
|
15
|
+
"import": "./index.ts",
|
|
16
|
+
"require": "./index.ts"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"scripts": {
|
|
20
|
+
"lint": "eslint .",
|
|
21
|
+
"test": "bun test"
|
|
22
|
+
},
|
|
23
|
+
"keywords": [
|
|
24
|
+
"bot",
|
|
25
|
+
"music",
|
|
26
|
+
"lavalink",
|
|
27
|
+
"bun",
|
|
28
|
+
"high-performance",
|
|
29
|
+
"discord",
|
|
30
|
+
"websocket",
|
|
31
|
+
"zero-dependencies",
|
|
32
|
+
"typescript"
|
|
33
|
+
],
|
|
34
|
+
"engines": {
|
|
35
|
+
"bun": ">=1.3.6"
|
|
36
|
+
},
|
|
37
|
+
"author": "Saya",
|
|
38
|
+
"contributors": [
|
|
39
|
+
{
|
|
40
|
+
"name": "Luigi Colantuono",
|
|
41
|
+
"url": "https://github.com/LuigiColantuono"
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"license": "MIT",
|
|
45
|
+
"homepage": "https://github.com/LuigiColantuono/Shoukaku-Bun#readme",
|
|
46
|
+
"repository": {
|
|
47
|
+
"type": "git",
|
|
48
|
+
"url": "git+https://github.com/LuigiColantuono/Shoukaku-Bun.git"
|
|
49
|
+
},
|
|
50
|
+
"bugs": {
|
|
51
|
+
"url": "https://github.com/LuigiColantuono/Shoukaku-Bun/issues"
|
|
52
|
+
},
|
|
53
|
+
"funding": {
|
|
54
|
+
"type": "individual",
|
|
55
|
+
"url": "https://paypal.me/l0g4n7"
|
|
56
|
+
},
|
|
57
|
+
"dependencies": {},
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"@shipgirl/eslint-config": "^0.4.2",
|
|
60
|
+
"@types/bun": "latest",
|
|
61
|
+
"eslint": "^9.39.2",
|
|
62
|
+
"typescript": "^5.9.3"
|
|
63
|
+
}
|
|
64
|
+
}
|