-
-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration
Reishi edited this page Mar 5, 2024
·
30 revisions
Tip
If you're having issues with the configuration of the bot feel free to ask for help in the support server
You can find an example configuration file here
Highlighted
values are the default
Config option | Description | Value |
---|---|---|
botToken |
This is what the bot logs in with. That's like your login and password for it | Any string |
apiKeys#steam |
Used in the /tf2 command to show stats of a user |
Any string |
apiKeys#tenor |
Used in the starboard script to display tenor gifs correctly | Any string |
database |
Sets which database the bot should use (postgres or sqlite ). Postrgres is recommended since it's faster than sqlite, but sqlite is easier to setup if you don't want to set up a database server. Both will work just fine. |
postgres/sqlite
|
logLevel |
Limits the amount of logger messages being sent to stdout. | trace, debug, info , warn, error, fatal |
autostartLavalink |
Sets if lavalink should be started alongside the bot (You must place the lavalink.jar file in the project's root folder) | true/false
|
pipeLavalinkStdout |
Sets if lavalink's stdout should be piped to twm's stdout. Ignored if autostartLavalink is set to false
|
true/false
|
errorWebhookUrl |
Sets the URL of a channel webhook that will send uncaught errors so they can be fixed easily. If set to null this will be disabled |
Any string/null
|
You can find an example in the example configuration file linked above
In the values column, the highlighted
one is the default value
Player option | Description | Values |
---|---|---|
leaveAfterQueueEnd |
Toggles if the bot should leave after the queue ends |
false | true |
playerTimeout |
Time after which the bot will automatically disconnect from the channel (in minutes) | a number, 10
|
autocomplete |
Enables suggestions in commands that support them (like /play and /skipto) | false | true
|
resendEmbedAfterSongEnd |
Resends the now playing message after a song ends | false | true
|
enableSkipvote |
Enables vote to skip song | false | true
|
skipvoteThreshold |
Sets the percentage of voice chat members required to vote "yes" for the song to be skipped | 0-100, 50
|
skipvoteMemberRequirement |
Sets how many members need to be in vc for vote skips to be enabled | a number, 3
|
Tip
You can set playerTimeout
to -1
to disable it
You can set skipvoteMemberRequirement
to -1
to always require a vote to skip
You can find an example configuration file in the lavalink configuration guide page.