Skip to content

Configuration Options

This content is for the 3.4.2 version. Switch to the latest version for up-to-date documentation.

OptionTypeDescription
resumebooleanWhether to resume a connection on disconnect to Lavalink (Server Side) (Note: DOES NOT RESUME WHEN THE LAVALINK SERVER DIES)
resumeKeystringResume key for Lavalink
resumeTimeoutnumberTimeout before resuming a connection in seconds
resumeByLibrarybooleanWhether 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)
alwaysSendResumeKeybooleanDisables the first time initialization tracking of nodes, and just sends the resume key always (Note: Useful for people who save their players to redis and wants to resume sessions even at first boot)
reconnectTriesnumberNumber of times to try and reconnect to Lavalink before giving up
reconnectIntervalnumberTimeout before trying to reconnect in milliseconds
restTimeoutnumberTime to wait for a response from the Lavalink REST API before giving up in milliseconds
moveOnDisconnectbooleanWhether to move players to a different Lavalink node when a node disconnects
userAgentstringUser Agent to use when making requests to Lavalink
structuresObject{rest?, player?}Custom structures for shoukaku to use