A stable and updated wrapper around Lavalink
Shoukaku, from Azur Lane, drawn by: elfenlied22
Stable
Updated
Documented
Extendable
ESM & CommonJS supported
Very cute (Very Important)
https://guide.shoukaku.shipgirl.moe/guides/1-getting-started/
// 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 |
| Name | Link | Description |
|---|---|---|
| Kazagumo | Github | A wrapper for Shoukaku that has an internal queue system |
Open a pr if you want to add a wrapper here
The Shipgirl Project
FAQs
A stable and updated wrapper around Lavalink
The npm package shoukaku receives a total of 915 weekly downloads. As such, shoukaku popularity was classified as not popular.
We found that shoukaku demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.