Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shipgirlproject/Shoukaku
A stable, powerful and updated wrapper around Lavalink
https://github.com/shipgirlproject/Shoukaku
discord-js discord-music-bot discordjs eris eris-lavalink lavalink lavalink-client lavalink-music lavalink-wrapper
Last synced: about 1 month ago
JSON representation
A stable, powerful and updated wrapper around Lavalink
- Host: GitHub
- URL: https://github.com/shipgirlproject/Shoukaku
- Owner: shipgirlproject
- License: mit
- Created: 2019-06-12T15:12:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T09:00:40.000Z (about 2 months ago)
- Last Synced: 2024-07-23T11:08:31.198Z (about 2 months ago)
- Topics: discord-js, discord-music-bot, discordjs, eris, eris-lavalink, lavalink, lavalink-client, lavalink-music, lavalink-wrapper
- Language: TypeScript
- Homepage: https://guide.shoukaku.shipgirl.moe/
- Size: 5.29 MB
- Stars: 266
- Watchers: 10
- Forks: 81
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Shoukaku
> A stable and updated wrapper around Lavalink
[](https://discordapp.com/invite/FVqbtGu)
[](https://www.npmjs.com/package/shoukaku)
> Shoukaku, from Azur Lane, drawn by: @hoshimaro15
### Features
- Stable
- Updated
- Documented
- Extendable
- ESM & CommonJS supported
- Very cute (Very Important)
### Documentation
> https://guide.shoukaku.shipgirl.moe/
### Getting Started
> https://guide.shoukaku.shipgirl.moe/guides/1-getting-started/
### Supported Libraries
> https://guide.shoukaku.shipgirl.moe/guides/5-connectors/
### Example Bot
> https://github.com/Deivu/Kongou
### Configuration Options
```js
// Parameters for main class init, Options is the Configuration Options
new Shoukaku(new Connectors.DiscordJS(client), Nodes, Options);
```
| Option | Type | Default | Description | Notes |
| ---------------------- | ---------------------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------ |
| resume | boolean | false | If you want to enable resuming when your connection when your connection to lavalink disconnects | |
| resumeTimeout | number | 30 | Timeout before lavalink destroys the players on a disconnect | In seconds |
| resumeByLibrary | boolean | false | If you want to force resume players no matter what even if it's not resumable by lavalink | |
| reconnectTries | number | 3 | Number of tries to reconnect to lavalink before disconnecting | |
| reconnectInterval | number | 5 | Timeout between reconnects | In seconds |
| restTimeout | number | 60 | Maximum amount of time to wait for rest lavalink api requests | In seconds |
| moveOnDisconnect | boolean | false | Whether to move players to a different lavalink node when a node disconnects | |
| userAgent | string | (auto) | Changes the user-agent used for lavalink requests | Not recommeded to change |
| structures | Object{rest?, player?} | {} | Custom structures for shoukaku to use | |
| voiceConnectionTimeout | number | 15 | Maximum amount of time to wait for a join voice channel command | In seconds |
| nodeResolver | function | function | Custom node resolver if you want to have your own method of getting the ideal node | |
### Wrappers
| Name | Link | Description |
| -------- | --------------------------------------------- | -------------------------------------------------------- |
| Kazagumo | [Github](https://github.com/Takiyo0/Kazagumo) | A wrapper for Shoukaku that has an internal queue system |
> Open a pr if you want to add a wrapper here
### Other Links
- [Discord](https://discord.gg/FVqbtGu)
- [Lavalink](https://github.com/lavalink-devs/Lavalink)
### Made with ❤ by @ichimakase (Saya)
> The Shipgirl Project