Quick Start

---

Server Configuration

• Please make sure your murmur server supports sending text messages of over 90000 characters. (Configurable in your murmur.ini file)
  • Although the actual character usage won't be that high, it's better to leave some buffer room for plugins.

Web Interface

• The web interface (if enabled by default in your plugins/web_server/metadata.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 MyBotName 5 (This sets the bot at an equal privilege level as the owner)

Already configured the bot? Here's how to start 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>
              

Quick Start - 5 Steps

1. Install the required dependencies and python version.
   • Download and install python 3.7+
     • Linux: Depends on the distribution.
     • Mac OSX: Mac OSX Python Downloads
     • Windows: Windows Python Downloads
   • Installing project dependencies
     • pip install -r requirements/requirements.txt OR python3 -m pip install -r requirements/requirements.txt
     • pip install git+git://github.com/azlux/pymumble@pymumble_py3 OR python3 -m pip install git+git://github.com/azlux/pymumble@pymumble_py3
     • Note: You must have libopus installed and installation varies by operating system.
   • Updating project dependencies
     • pip install --upgrade -r requirements/requirements.txt OR python3 -m pip install --upgrade -r requirements/requirements.txt
     • pip install --upgrade git+git://github.com/azlux/pymumble@pymumble_py3 OR python3 -m pip install --upgrade git+git://github.com/azlux/pymumble@pymumble_py3
     • Note: You must have libopus installed and installation varies by operating system.
2. Generate a .pem certificate and place it in the bot's root directory.
   • You can skip this step if your server won't be using a certificate.
   • A .p12 certificate may be generated through the mumble client's certificate wizard and converted to .pem:

     openssl pkcs12 -in jjmumblebot.p12 -out jjmumblebot.pem -clcerts -nokeys

   • Alternatively, a certificate can be generated using OpenSSL:

     openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout jjmumblebot.pem -out jjmumblebot.pem -subj "/CN=jjmumblebot"

     (Special thanks to bamtan for providing the openssl command)
3. Setup your config.ini file
   • Quick rundown:
     • Copy the config_template.ini file from the JJMumbleBot/cfg/templates/ directory to the JJMumbleBot/cfg/ directory and rename it to config.ini
     • Fill in the placeholder fields in the config file under each section.
   • Detailed explanation:
     • Config.ini Setup Page
4. Setup your global_aliases.csv file
   • Copy the aliases_template.csv file from the JJMumbleBot/cfg/templates/ directory into the JJMumbleBot/cfg/ directory and rename it to global_aliases.csv
   • Edit the file and add/remove alias commands as much as you like. (OPTIONAL)
   • If you are a new user, I suggest leaving the file as is, after copying it to the JJMumbleBot/cfg/ directory.
5. Setup your plugins (OPTIONAL)
   • Copy your third-party plugins into the JJMumbleBot/plugins/extensions/ directory.
   • Modify the privileges.csv file for any plugin if you want to change the default command privileges.
   • Modify the aliases.csv file for any plugin if you want to change/add-to the default command aliases.