Field Value
EnableDebugConsole (internal use only)
EnableLocalFS (internal use only)
EnableProfiler (internal use only; deprecated)
EnableWebStream allow the bot to export the audiostream via http or icecast; disabled by default
DataDir This can be used to specify the data directory the bot should use. Default is ./data inside the bot root.
Hostname Hostname to use for the certificate when UseSSL is enabled
InstanceActionLimit number of http requests / actions (per instance and second) before a limit will prevent further actions
IsProxied if enabled, the bot will trust proxied headers and use the ips from there
License one or more valid licenses
LicenseKey hostspecific license key; used for license-requests. Don't change!
ListenHost IP-address the bot should listen on; default will listen on all interfaces / IP-addresses
ListenPort Port the bot should listen on
LocalPlayback (internal use only)
LogFile if specified, output will be logged to this file instead of stdout
MaxBulkOperations number of entries that can be moved with one operation (add to playlist, move to folder and such)
LogLevel verbosity of the log; default is 3
Pragma (caution!) used to override database version; DO NOT SET!
RunAsGroup gid to use for privilege drop
RunAsUser uid to use for privilege drop
SampleInterval number of milliseconds of audiodata that is handled in a batch; 60 is sane for most installations, on Windows tuning this can help preventing stuttering
SSLCertFile certificate to use for SSL connections
SSLKeyFile private key to use for SSL connections
Token random security token, generated on first start; to change, remove it
TS3Path Path to the TeamSpeak 3 Client executable
UploadLimit maximum number of bytes a file is allowed to have when uploading; default 80M
UseSSL if set to true, the bot will only accept https-connections; Hostname MUST be specified
YoutubeDLPath Path the the youtube-dl executable


Field Value
AvatarMaxWidth if set, all uploaded avatars will be limited (resized) to this value
AvatarMaxHeight if set, all uploaded avatars will be limited (resized) to this value


Field Value
BufferSize number of bytes to use for buffering (useful to tune on slow connections)
MaxDownloadSize maximum size of files to download via ytdl
MaxDownloadRate if you want to slow down ytdl to prevent traffic spikes, use this
CacheStreamed if streaming via ytdl, enabling this will cause the streams to get stored inside the cache directory; please be aware that you have to delete the cache files manually (that's safe to do)


This section will hold configuration values for used plugins. Please see the manual of the plugin to use for what settings are required.


Field Value
AllowReload Enables a script function that allows hot script reloading (added scripts will still need a restart of the bot)
EnableTimer Enable the timer event (disabled by default); deprecated, will get removed soon
WatchScripts An array of script files that should automatically be reloaded if a change is detected; very useful for script developers


Field Value
Enable Enable speech recognition; requires additional files to work


Field Value
Delay Throttle XServer events to save CPU cycles (DON'T CHANGE)
Debug (internal only)


Field Value
Enable Enables serving the music files via DAV backend; experimental


Field Value
UserAgent Can be used to replace the default user-agent header FFmpeg uses