Launch Parameters
JJMumbleBot comes with a launch parameters for every option available in the config.ini file.
This is especially helpful for minimal setup docker containers, or users that don't want to mess with config files.
Use the -h
launch parameter to get a full list of the available arguments.
Required launch parameters for regular startup:
-ip
- Enter the server IP for this launch parameter.-port
- Enter the server Port for this launch parameter.-password
- Enter the password required to connect to the server. This is not required if your server is unprotected.
All launch parameters:
-
Safe/Verbose/Quiet Mode Launch Parameters:
-safe
- Enables safe mode for the bot service which initializes the bot with safe-mode only plugins.-verbose
- Enables verbose mode which displays extensive output statements from the bot service.
This is useful for debugging purposes.-quiet
- Enables quiet mode which suppresses output statements from the bot service.
This is useful for running the bot in a headless environment.
Connection Launch Parameters:-username
- Enter the username of the bot using this parameter.
If the bot is registered with a certificate, the username must
match the username registered in the certificate.-cert
- Enter the bot client certificate path using this parameter if you are not generating a certificate at runtime.-generatecert
- Automatically generates a certificate for the bot and updates the config.ini file to include the new certificate path.-superuser
- Enter the default super user for the bot client using this parameter.-defaultchannel
- Enter the default channel the bot should join after connecting to the server.-autoreconnect
- Enables auto-reconnecting if the bot disconnects from the mumble server.-noautoreconnect
- Disables auto-reconnecting if the bot disconnects from the mumble server if enabled in the config file.-selfregister
- Enables self-registration to the connected mumble server.-noselfregister
- Disables self-registration to the connected mumble server if enabled in the config file.-comment
- Enter the comments that are shown when users view the bot comment in a server.
Web Interface Launch Parameters:-useweb
- Enable the bot web interface with this launch parameter.-noweb
- Disable the bot web interface with this launch parameter if it is enabled in the config.-webip
- Enter the IP to use for the web server (if enabled).-webport
- Enter the port to use for the web server (if enabled).-webtickrate
- Enter the tick rate of the processing loop that sends data to the web interface (if enabled).-usehttps
- Enables the usage of HTTPS for the web server, this requires a cert/key file to be provided or generated.-nohttps
- Disable the usage of HTTPS for the web interface if enabled in the config file.-websslcert
- Enter the path to the SSL certificate file for the web interface if HTTPS is enabled.-websslkey
- Enter the path to the SSL key file for the web interface if HTTPS is enabled.-webgeneratecert
- Enables automatic certificate/key creation for the web interface if HTTPS is enabled.
This is useful for local deployment, but it is recommended to use a certificate authority.
Main Settings Launch Parameters:-usedatabasebackups
- Enables automatic database backups for the bot service.-nodatabasebackups
- Disables automatic database backups for the bot service if enabled in the config file.-cmdtickrate
- Enter a custom tick rate for commands to be processed.-multicmdlimit
- Enter the maximum number of commands per multi-command input.-cmdqueuelimit
- Enter the maximum number of commands allowed to be processed in the queue.-cmdtoken
- Enter a custom command token character to identify commands in the chat (must be single character).-cmdhistlimit
- Enter the maximum number of commands to store in the command history.
Media Settings Launch Parameters:-ffmpegpath
- Enter the path to ffmpeg to be used by media plugins.-vlcpath
- Enter the path to vlc to be used by media plugins.-stereoaudio
- Enable stereo audio playback for the bot audio system.-quietaudiolib
- Suppress audio library console messages with this launch parameter.-audiolibdebug
- Enables debugging messages for the audio libraries to be displayed.-volume
- Enter the default volume to be used by the bot audio system.-audioduck
- Enables audio ducking for the bot audio system.-noaudioduck
- Disables audio ducking for the bot audio system if enabled in the config file.-audioduckvolume
- Enter the volume to duck to when audio ducking (If audio ducking enabled).-audioduckthreshold
- Enter the threshold before ducking audio (If audio ducking enabled).-audioduckdelay
- Enter the delay before ducking audio (If audio ducking enabled).-maxqueuelength
- Enter the maximum queue length allowed for the bot audio system.-mediaproxy
- Enter a proxy url used for the youtube-dl library with this launch parameter.-mediacookie
- Enter a cookies.txt directory path used for the youtube-dl library with this launch parameter.
This is useful to deal with rate limits on the bot.-tempmediadirectory
- Enter the temporary media directory path to be used by media plugins.-permmediadirectory
- Enter the permanent media directory path to be used by media plugins.
PGUI Settings Launch Parameters:-canvasbgcolor
- Enter a default background color for the PGUI system.-canvasimgbgcolor
- Enter a default background color for images in the PGUI system.-canvasalign
- Enter a default canvas alignment for the PGUI system.-canvasborder
- Enter a default canvas border size for the PGUI system.-canvastextcolor
- Enter a default text color for the PGUI system.-canvasfont
- Enter a default font for the PGUI system.-canvasheadtextcolor
- Enter a default header text color for the PGUI system.-canvasindextextcolor
- Enter a default index text color for the PGUI system.-canvassubheadtextcolor
- Enter a default sub-header text color for the PGUI system.
Logging Launch Parameters:-uselogging
- Enables event logging for the bot service.-nologging
- Disables event logging for the bot service if enabled in the config file.-maxlogs
- Enter the maximum number of logs to be stored by the logging system.-maxlogsize
- Enter the maximum size of each log generated by the logging system.-hidelogmessages
- Hide potentially sensitive information in logs such as usernames/messages.-logdirectory
- Enter the log directory path to be used by the bot to store logs.-logtrace
- Enables stack trace logging for all logged events.-nologtrace
- Disables stack trace logging for all logged events if enabled in the config file.
Example launch parameters:
Enteringpython JJMumbleBot/ -h
in your command line, results in an output similar to the image below.