Frequently Asked Questions - F.A.Q.

---

How do I run/start the bot?

• Quick Start Guide

How can I contribute to the project?

• Feel free to post issue reports to the Github project if you encounter any issues or have suggestions.
• Fork the project and make changes as necessary and send a pull request.
• If you want to support me monetarily, I have a sponsor link available at the top of the repository.

How do I start the bot once I've configured it?

• Use the -ip launch parameter to specify the server ip.
• Use the -port launch parameter to specify the server port.
• Optionally, use the -password launch parameter to specify the server password (if it has one).
• Full command line arguments list
  python JJMumbleBot/ -ip <serverip> -port <serverport>

There is a runtime error, what do I do?

• Try downloading the latest release (even if you have the same version) because I update the bot frequently and fix bugs regularly.
• Make sure the dependencies are up to date according to the requirements.txt file in the master branch.
• Make sure you're running the latest python 3 version.
• If the previous suggestions doesn't solve your problem, please post an issue here: Issue Reports

How do I check what commands are available?

• Message the !help command to the bot for it to display a list of available plugins and commands for individual plugins.
• Alternatively, Check the plugins in the wiki for an extensive list of commands.

The commands aren't working on the web interface, what's wrong?

• The web interface (if enabled in your config.ini file) must have the bot itself as a high-privileged user in the user privileges.
• To add the bot to the user privileges, use the !addprivileges command:
  !addprivileges MyBotName 5 (This sets the bot at an equal privilege level as the owner)
• If the bot is already in the user privileges, use the !setprivileges command:
  !setprivileges MyBotName5 (This sets the bot at an equal privilege level as the owner)

I don't need all these plugins, can I pick and choose?

• YES! Apart from the plugins in the core plugins folder, you can do whatever you like. All extension plugins are completely optional and can be removed if needed.

Can I disable plugins without removing them?

• You can disable plugins by listing the plugin name within your config.ini file in the "DisabledPlugins" field. This will tell the bot not to initialize them so they won't be used.

My media directories are created but the files can't be accessed?

• Please check that the media directories use only absolute paths in the config.ini file.
  (This should fix issues where plugins can download files but not play/access them)

The youtube plugin keeps giving me errors about extracting information

• Update the youtube_dl dependency to the newest available release.
• Youtube frequently changes their meta information which means that youtube_dl has to update to account for these changes. They usually update within a day or two.

The youtube plugin stopped was working, but it has stopped working for some reason.

• Youtube is constantly changing their infrastructures for video/metadata extraction and sometimes the thumbnails stop working, or the video stops working. This can be resolved in 2 ways:
  • Update the youtube-dl python package (sometimes it may take 1-3 days for the package to be updated to fix youtube issues)

My bot can't make channels, what's wrong?

• If the !make command isn't working, make sure that the bot has higher user privileges in your murmur server by registering the bot.
• The bot can self-register if the option is enabled in the config.ini file.

My bot has a SSL: TLS Protocol error!

• From past issues, it seems that this is caused by outdated .pem certificates.
• Try to create and use a new .pem certificate generated with OpenSSL or by the mumble client certificate wizard.

The server doesn't require a password/certificate, what do I do?

• Leave the server password/certificate field blank in the config.ini.

I want to rename the bot to customize it for my server, how do I do that?

• In the config.ini, change the name of your UserID field but make sure the certificate you use is registered with the name or it won't be able to authenticate (if the bot is registered already).

The bot can't authenticate during start up.

• This can be caused by an outdated certificate.
• This can be caused by a bot name that doesn't match the certificate's registered name.
• If the bot is already registered to the server, the name cannot be changed unless a new certificate is generated.

How do I generate a certificate?

• Luckily, this is a generic mumble certificate. You can find instruction on how to do that here:
  Mumble Certification Creation Tutorial
• The quick start guide has a short segment to help with generating an OpenSSL certificate as well:
  Quick Start Guide

What is this bot's compatibility?

• This bot is compatible with Linux and Windows (and possibly Mac OS, but it is untested.)
• Please note that windows compatibility is based on if you're able to get the opus library installed and working.

I'm encountering weird alias/privilege errors after updating recently, what's wrong?

• There might be a mismatch between the current version of JJMumbleBot and an older version which may require you to regenerate your internal database. This can be done easily by deleting the jjmumblebot.db file in your JJMumbleBot/cfg directory and letting the bot automatically regenerate the database on startup.

How do I backup the internal database?

• The internal database is backed up automatically to the JJMumbleBot/cfg/backups folder everytime the bot is launched. The file name is created with a date-stamp.(This feature can be enabled/disabled in your config.ini file)
• Alternatively, you can manually back up your internal database however you like.

I'm receiving logging errors in the console, but the bot is still functional?

• I've noticed that sometimes the logging module in python tends to corrupt during runtime. This is almost always fixed by simply restarting the bot.