JJMumbleBot Quick Setup Utility


Connection Settings


Enter your bot username here, If the bot is registered with a certificate, the name must match the name in the certificate.

[Example: JJMumbleBot]



Enter the file path to your certificate. If your server doesn't require a certificate, leave this blank.

[Example: /path/to/my/cert.pem]



Specify the default channel the bot should join when it connects to the server.

[Example: Root]



Enter the bot owner's display name here. The bot must have at least 1 super user to be able to control all bot commands.

[Example: SuperUserJason]



Enable self registering if you want the bot to attempt to self-register to the server.



The default comment associated with the bot that is shown to users when they view the bot's comment. This can be left blank.

[Example: Hello! This is JJMumbleBot!]


Web Interface


To enable the web interface for the bot, check the box. Uncheck it to disable.


Enter the web server IP here.

[Example: 192.168.1.100]


Enter the port of the web server for the main web interface page.

[Example: 7000]


Enter the port of the web socket on the web interface providing live data.

[Example: 7001]


Enter the tick rate of the web interface loop. [Recommended: 0.1 - 2]

[Example: 1]

Media Settings


The file path to VLC.

[Example: path/to/vlc]


To enable stereo audio for the bot, check the box. Uncheck the box for mono audio.


To enable vlc quiet mode, check the box.


The default volume when the bot starts.

[Default: 0.3]


Enable Audio Ducking (off by default, use !duckaudio to toggle on and off)



The default audio ducking volume (How low the volume will drop down when ducking)

[Default: 0.05]


The default threshold before audio is ducked.

[Default: 2500.0]


The default delay before the audio ducking reacts to user voices.

[Default: 1.0]


The default maximum queue length for the audio interface.

[Default: 50]


Optional Proxy URL - If you want to use a proxy server to use the youtube-dl library, fill this out.

[Example: socks5://myproxy:8080, https://myproxy:8080]


Optionally use a cookies.txt file for the youtube-dl library (useful to deal with rate limits).

[Example: path/to/cookies.txt]


Temporary media directory to store youtube thumbnails and other images content. This directory is cleared when the bot exits.

[Example: path/to/temp_media_dir]


Permanent media directory to store sound board clips, and other media that won't be deleted when the bot exits.

[Example: path/to/perm_media_dir]

Logging


To enable logging for the bot, check the box. Uncheck the box to disable.


This sets the maximum number of logs the bot can have at a time before it overwrites the oldest one.

[Recommended: 5-20]


Enable/Disable channel message logging (Enabling it will hide message logs to: Message Received: [User -> #####])


This is the path to directory where logs are stored. All bot logs will be stored in this directory.

[Example: my/path/to/logs]

Plugin Settings


Disables plugins that are included in this list for regular operation. You can leave the list empty.
Type the name of the plugins in quotes separated by commas.

[Example: "youtube", "sound_board"]


The list of plugins that are available during safe-mode operation of the bot.
Type the name of the plugins separated by commas.

[Example: "core_commands", "bot_commands"]


The root channels in which the creation of temporary channels are allowed.
Change this list to include the channels in your server that you allow the bot to create temporary channels in.
Type the name of the plugins separated by commas.

[Example: "Root", "MyChannel", "MyChannel2"]

Main Settings


Enable automatic internal database backups by checking the box, or disable by unchecking it.


The execution tick rate of commands in the command queue [Must be an integer/float]



Maximum commands in a multi-command input (this includes multi-commands in aliases) [Must be an integer]
This determines the number of commands that can be inputted in a single line



Maximum commands per queue (this includes commands in aliases) [Must be an integer]
This determines the maximum number of commands that the bot can process in it's queue.



The command token to identify commands in the chat [Must be a single character]

[Example: !, ~, $]


The number of commands to store in the command history tracker [Must be an integer]


PGUI Settings


Determines the default background color of the UI canvas.
Refer to the following for more information on the limitations:
Qt5 Html Subset
Qt5 Named Colors



Determines the default background color of images in the UI canvas.



Determines the default canvas alignment using html alignment tags

[Example: center, left, right]


Determines the default canvas border size [Recommended: 0]



Determines the default canvas text color

[Example: white, red, blue, (qt5 html subset colors)]


Determines the default canvas text font [Recommended: Calibri]



Determines the default header text color

[Example: white, red, blue, (qt5 html subset colors)]


Determines the default index text color

[Example: white, red, blue, (qt5 html subset colors)]


Determines the default sub-header text color

[Example: white, red, blue, (qt5 html subset colors)]