Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add default Shoukaku options to README #164

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Add default Shoukaku options to README #164

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dac10f6
add option defaults to readme
tehtnaz Sep 17, 2023
5085686
im kinda bad lol
tehtnaz Sep 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,18 +203,18 @@ console.log(shoukaku.getIdealNode());
```

### Shoukaku's options
| Option | Type | Description |
|------------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| resume | boolean | Whether to resume a connection on disconnect to Lavalink (Server Side) (Note: DOES NOT RESUME WHEN THE LAVALINK SERVER DIES) |
| resumeTimeout | number | Timeout before resuming a connection **in seconds** |
| resumeByLibrary | boolean | Whether to resume the players by doing it in the library side (Client Side) (Note: TRIES TO RESUME REGARDLESS OF WHAT HAPPENED ON A LAVALINK SERVER) |
| reconnectTries | number | Number of times to try and reconnect to Lavalink before giving up |
| reconnectInterval | number | Timeout before trying to reconnect **in seconds** |
| restTimeout | number | Time to wait for a response from the Lavalink REST API before giving up **in seconds** |
| moveOnDisconnect | boolean | Whether to move players to a different Lavalink node when a node disconnects |
| userAgent | string | User Agent to use when making requests to Lavalink |
| structures | Object{rest?, player?} | Custom structures for shoukaku to use |
| voiceConnectionTimeout | number | Timeout before abort connection **in seconds** |
| Option | Type | Default | Description |
|------------------------|------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
| resume | boolean | false | Whether to resume a connection on disconnect to Lavalink (Server Side) (Note: DOES NOT RESUME WHEN THE LAVALINK SERVER DIES) |
| resumeTimeout | number | 30 | Timeout before resuming a connection **in seconds** |
| resumeByLibrary | boolean | false | Whether to resume the players by doing it in the library side (Client Side) (Note: TRIES TO RESUME REGARDLESS OF WHAT HAPPENED ON A LAVALINK SERVER) |
| reconnectTries | number | 3 | Number of times to try and reconnect to Lavalink before giving up |
| reconnectInterval | number | 5 | Timeout before trying to reconnect **in seconds** |
| restTimeout | number | 60 | Time to wait for a response from the Lavalink REST API before giving up **in seconds** |
| moveOnDisconnect | boolean | false | Whether to move players to a different Lavalink node when a node disconnects |
| userAgent | string | (auto) | User Agent to use when making requests to Lavalink |
| structures | Object{rest?, player?} | {} | Custom structures for shoukaku to use |
| voiceConnectionTimeout | number | 15 | Timeout before abort connection **in seconds** |

### Plugins list

Expand Down
Loading