Setting up your Config.ini File

Manual Method

1. Copy the config_template.ini file from your JJMumbleBot/cfg/templates/ directory to your JJMumbleBot/cfg folder.
2. Follow the instructions in the individual sections of the config below to setup your own config.ini file.
Note: Don't use quotations in any text elements in the config.ini file
Note: Use absolute paths for all directories/paths in the config.ini file

Web Interface Method

1. Visit this link: Quick Setup Utility - Web Interface for Config.ini File Creation
2. Fill in all the required fields, and click the "Download Config.ini File" button to generate the config.ini file for the bot.
3. Place the config.ini file in your JJMumbleBot/cfg folder.

---

[Connection Settings]

• UserID: Enter your bot username here, If the bot is registered with a certificate, the name must match the name in the certificate.
• UserCertification: Enter the file path to your certificate. If your server doesn't require a certificate, leave this blank.
• AutoReconnect: Enable/Disable Auto-Reconnect to the server if connection is lost.
• DefaultChannel: The default channel the bot joins when it connects to the server
• DefaultSuperUser: 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.
• SelfRegister: Allows the bot to attempt to self-register to the server.
• DefaultComment: Custom bot comments that are shown when users view the bot's comment. This can be left blank.

            [Connection Settings]
            UserID = USERNAME
            UserCertification = CERT_FILE_PATH
            AutoReconnect = False
            DefaultChannel = DEFAULT_CHANNEL_NAME
            DefaultSuperUser = DEFAULT_SUPER_USER_NAME
            SelfRegister = False
            DefaultComment = Hello! I am JJMumbleBot!
        

[Media Settings]

• FfmpegPath: FFmpeg location
• VlcPath: VLC location
• UseStereoAudio: Enable/Disable Stereo Audio
• AudioLibraryRunQuiet: Enable/Disable Audio Library Console Messages
• DefaultVolume: The default volume when the bot starts (default=0.3)
• AudioDuck: Enable Audio Ducking (off by default, use !duckaudio to toggle on and off)
• DuckingVolume: The default audio ducking volume (How low the volume will drop down when ducking) (default=0.05)
• DuckingThreshold: The default threshold before audio is ducked (default=2500.0)
• DuckingDelay: The default delay before the audio ducking reacts to user voices (default=1.0)
• MaxQueueLength: The default maximum queue length for the audio interface (default=50)
• YoutubeDLProxyURL: Optional Proxy URL - If you want to use a proxy server to use the youtube-dl library, fill this out
• YoutubeDLCookieFile: Optionally use a cookies.txt file for the youtube-dl library (useful to deal with rate limits).
• TemporaryMediaDirectory: Temporary images directory to store youtube thumbnails and other images content. This directory is cleared when the bot exits.
• PermanentMediaDirectory: Permanent media directory to store sound board clips, and other media that won't be deleted when the bot exits.

            [Media Settings]
            FfmpegPath = ffmpeg
            VlcPath = vlc
            UseStereoAudio = True
            AudioLibraryRunQuiet = True
            DefaultVolume = 0.3
            AudioDuck = False
            DuckingVolume = 0.05
            DuckingThreshold = 2500.0
            DuckingDelay = 1.0
            MaxQueueLength = 50
            YoutubeDLProxyURL =
            YoutubeDLCookieFile =
            TemporaryMediaDirectory = TEMP_MEDIA_DIR_PATH
            PermanentMediaDirectory = PERM_MEDIA_DIR_PATH
        

[Logging]

• EnableLogging: Enable Logging Flag
• MaxLogs: Maximum Log Limit
• MaxLogSize: Maximum size per log (in Bytes)
• HideMessageLogging: Enable/Disable channel message logging (Enabling it will hide message logs to: Message Received: [User -> #####])
• LogDirectory: Path to the logs directory. All bot logs will be stored in this directory.
• LogStackTrace: Enable/Disable Stack Trace Logging. This will create large log files and log the stack trace of each logging event.

            [Logging]
            EnableLogging = False
            MaxLogs = 20
            MaxLogSize = 1500000
            HideMessageLogging = True
            LogDirectory =
            LogStackTrace = False
        

[Plugin Settings]

• DisabledPlugins: Disables plugins that are included in this list for regular operation.
• SafeModePlugins: Plugins to use during safe mode operation.
• AllowedRootChannelsForTempChannels: Root channels in which the creation of temporary channels are allowed.

            [Plugin Settings]
            DisabledPlugins = []
            SafeModePlugins = ["core_commands", "bot_commands"]
            AllowedRootChannelsForTempChannels = ["Root"]
        

[Main Settings]

• EnableDatabaseIntegrityCheck: Enable or disable version/plugin integrity checking for the database.
  Disabling this may cause database conflicts after code updates, plugin updates, or plugin addition/removal!
• EnableDatabaseBackup: Enable or disable automatic internal database backups
• CommandTickRate: The execution tick rate of commands in the command queue [Must be an integer/float]
• MultiCommandLimit: Maximum commands in a multi-command input (this includes multi-commands in aliases) [Must be an integer]
• CommandQueueLimit: Maximum commands per queue (this includes commands in aliases) [Must be an integer]
• CommandToken: The command token to identify commands in the chat [Must be a single character]
• CommandHistoryLimit: The number of commands to store in the command history tracker [Must be an integer]

            [Main Settings]
            EnableDatabaseIntegrityCheck = True
            EnableDatabaseBackup = False
            CommandTickRate = 0.1
            MultiCommandLimit = 200
            CommandQueueLimit = 600
            CommandToken = !
            CommandHistoryLimit = 25
        

[PGUI Settings]

Limitations: https://doc.qt.io/qt-5/richtext-html-subset.html

• CanvasBGColor: Default Canvas BG Color (https://doc.qt.io/qt-5/qcolor.html#setNamedColor)
• CanvasImageBGColor: Default Canvas Image BG Color
• CanvasAlignment: Default Canvas Alignment
• CanvasBorder: Default Canvas Border
• CanvasTextColor: Default Canvas Text Color
• DefaultFont: Default font for all GUIs (Can use all fonts supported by Qt5)
• HeaderTextColor: Default Header Text Color
• IndexTextColor: Default Index Text Color
• SubHeaderTextColor: Default Sub-Header Text Color

            [PGUI Settings]
            CanvasBGColor = black
            CanvasImageBGColor = black
            CanvasAlignment = center
            CanvasBorder = 0
            CanvasTextColor = Snow
            DefaultFont = Georgia
            HeaderTextColor = red
            IndexTextColor = cyan
            SubHeaderTextColor = yellow