shoukaku-bun 4.2.0-b → 4.2.0-d
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 +32 -54
- package/package.json +18 -9
package/README.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
## Shoukaku-Bun
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/sponsors/LuigiColantuono)
|
|
4
|
+
[](https://paypal.me/l0g4n7)
|
|
5
|
+
[](https://www.npmjs.com/package/shoukaku-bun)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
4
9
|
|
|
5
|
-
|
|
6
|
-
[](https://www.npmjs.com/package/shoukaku)
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
+
> Powerful, Lightweight wrapper around Lavalink
|
|
10
11
|
|
|
11
12
|
<p align="center">
|
|
12
13
|
<img src="https://azurlane.netojuu.com/images/thumb/d/dc/ShoukakuWeddingWithoutBG.png/767px-ShoukakuWeddingWithoutBG.png">
|
|
@@ -21,68 +22,45 @@
|
|
|
21
22
|
- **Stable & Updated**: Based on the rock-solid Shoukaku v4.2.0 logic.
|
|
22
23
|
- **Very cute (Very Important)**
|
|
23
24
|
|
|
24
|
-
|
|
25
|
+
## 📦 Bundle Size Comparison
|
|
25
26
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
This is a specialized fork. Install it directly from GitHub:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
bun add github:LuigiColantuono/shoukaku-bun
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
### Documentation
|
|
27
|
+
| Package | Size | Dependencies | Total Install |
|
|
28
|
+
|---------|------|--------------|---------------|
|
|
29
|
+
| shoukaku | 366 kB | ws (~300 kB) | **~666 kB** |
|
|
30
|
+
| shoukaku-bun | 72.9 kB | **NONE** | **72.9 kB** |
|
|
37
31
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
### Getting Started
|
|
32
|
+
**89% smaller install size!** 🚀
|
|
41
33
|
|
|
42
|
-
|
|
34
|
+
## 🎵 The Story
|
|
43
35
|
|
|
44
|
-
|
|
36
|
+
Built out of frustration with constant WebSocket upgrade warnings that were
|
|
37
|
+
making my Discord music bot laggy. After migrating to Bun, I realized the
|
|
38
|
+
entire Shoukaku stack could be rewritten to be faster and lighter.
|
|
45
39
|
|
|
46
|
-
|
|
40
|
+
**Result?** Zero warnings. Noticeably faster. Way more fun to work with.
|
|
47
41
|
|
|
48
|
-
|
|
42
|
+
If this solved your problems too, [consider supporting the project](https://paypal.me/tuonome)!
|
|
43
|
+
Even a coffee helps keep the motivation high! ☕
|
|
49
44
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
### Configuration Options
|
|
45
|
+
### Installation
|
|
53
46
|
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
new Shoukaku(new Connectors.DiscordJS(client), Nodes, Options);
|
|
47
|
+
```bash
|
|
48
|
+
bun add shoukaku-bun
|
|
57
49
|
```
|
|
58
50
|
|
|
59
|
-
|
|
60
|
-
| ---------------------- | ---------------------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------ |
|
|
61
|
-
| resume | boolean | false | If you want to enable resuming when your connection to lavalink disconnects | |
|
|
62
|
-
| resumeTimeout | number | 30 | Timeout before lavalink destroys the players on a disconnect | In seconds |
|
|
63
|
-
| resumeByLibrary | boolean | false | If you want to force resume players no matter what even if it's not resumable by lavalink | |
|
|
64
|
-
| reconnectTries | number | 3 | Number of tries to reconnect to lavalink before disconnecting | |
|
|
65
|
-
| reconnectInterval | number | 5 | Timeout between reconnects | In seconds |
|
|
66
|
-
| restTimeout | number | 60 | Maximum amount of time to wait for rest lavalink api requests | In seconds |
|
|
67
|
-
| moveOnDisconnect | boolean | false | Whether to move players to a different lavalink node when a node disconnects | |
|
|
68
|
-
| userAgent | string | (auto) | Changes the user-agent used for lavalink requests | Not recommeded to change |
|
|
69
|
-
| structures | Object{rest?, player?} | {} | Custom structures for shoukaku to use | |
|
|
70
|
-
| voiceConnectionTimeout | number | 15 | Maximum amount of time to wait for a join voice channel command | In seconds |
|
|
71
|
-
| nodeResolver | function | function | Custom node resolver if you want to have your own method of getting the ideal node | |
|
|
72
|
-
|
|
73
|
-
### Wrappers
|
|
51
|
+
### Official Documentation
|
|
74
52
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
| Kazagumo | [Github](https://github.com/Takiyo0/Kazagumo) | A wrapper for Shoukaku that has an internal queue system |
|
|
78
|
-
|
|
79
|
-
> Open a pr if you want to add a wrapper here
|
|
53
|
+
> https://guide.shoukaku.shipgirl.moe/
|
|
54
|
+
> https://github.com/shipgirlproject/Shoukaku
|
|
80
55
|
|
|
81
|
-
|
|
56
|
+
## Performance
|
|
82
57
|
|
|
83
|
-
|
|
58
|
+
)
|
|
84
59
|
|
|
85
|
-
|
|
60
|
+
## Support
|
|
61
|
+
> Kazagumo support server: https://discord.gg/nPPW2Gzqg2 (anywhere lmao)
|
|
62
|
+
> Shoukaku support server: https://discord.gg/FVqbtGu (#development)
|
|
63
|
+
> Brucius support server: https://discord.gg/XqJw52d35R
|
|
86
64
|
|
|
87
65
|
### Code made with ❤ by @ichimakase (Saya) & Luigi
|
|
88
66
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "shoukaku-bun",
|
|
3
|
-
"version": "4.2.0-
|
|
3
|
+
"version": "4.2.0-d",
|
|
4
4
|
"description": "Bun-native high-performance fork of Shoukaku. Node-dependencies purged.",
|
|
5
5
|
"main": "index.ts",
|
|
6
6
|
"module": "index.ts",
|
|
@@ -26,31 +26,40 @@
|
|
|
26
26
|
"lavalink",
|
|
27
27
|
"bun",
|
|
28
28
|
"high-performance",
|
|
29
|
-
"discord"
|
|
29
|
+
"discord",
|
|
30
|
+
"websocket",
|
|
31
|
+
"zero-dependencies",
|
|
32
|
+
"typescript"
|
|
30
33
|
],
|
|
31
34
|
"engines": {
|
|
32
|
-
"bun": "1.3.6"
|
|
35
|
+
"bun": ">=1.3.6"
|
|
33
36
|
},
|
|
34
37
|
"author": "Saya",
|
|
35
38
|
"contributors": [
|
|
36
39
|
{
|
|
37
40
|
"name": "Luigi Colantuono",
|
|
38
|
-
"url": "https://github.com/LuigiColantuono"
|
|
39
|
-
"info": "Bun Refactor & Optimization"
|
|
41
|
+
"url": "https://github.com/LuigiColantuono"
|
|
40
42
|
}
|
|
41
43
|
],
|
|
42
44
|
"license": "MIT",
|
|
43
|
-
"homepage": "https://github.com/LuigiColantuono/
|
|
45
|
+
"homepage": "https://github.com/LuigiColantuono/Shoukaku-Bun#readme",
|
|
44
46
|
"repository": {
|
|
45
47
|
"type": "git",
|
|
46
|
-
"url": "git+https://github.com/LuigiColantuono/
|
|
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"
|
|
47
56
|
},
|
|
48
57
|
"dependencies": {},
|
|
49
58
|
"devDependencies": {
|
|
50
|
-
"@shipgirl/eslint-config": "^0.
|
|
59
|
+
"@shipgirl/eslint-config": "^0.4.2",
|
|
51
60
|
"@types/bun": "latest",
|
|
52
61
|
"eslint": "^9.39.2",
|
|
53
62
|
"typedoc": "^0.28.16",
|
|
54
63
|
"typescript": "^5.9.3"
|
|
55
64
|
}
|
|
56
|
-
}
|
|
65
|
+
}
|