You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 lines
7.8 KiB
136 lines
7.8 KiB
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>JJMumbleBot - Quick Start</title>
|
|
<link rel="stylesheet" href="https://bootswatch.com/4/darkly/bootstrap.css" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="https://duckboss.github.io/JJMumbleBot/css/content-pages.css" crossorigin="anonymous">
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
|
|
<script src="https://duckboss.github.io/JJMumbleBot/js/insert_html.js"></script>
|
|
</head>
|
|
<body>
|
|
<nav id="table_of_contents"></nav>
|
|
<div class="main-content">
|
|
<h2 id="page-title">Quick Start</h2>
|
|
<hr>
|
|
<h3 id="server-configuration">Server Configuration</h3>
|
|
<ul>
|
|
<li>Please make sure your murmur server supports sending text messages of over 90000 characters. (Configurable in
|
|
your murmur.ini file)
|
|
<ul>
|
|
<li>Although the actual character usage won't be that high, it's better to leave some buffer room
|
|
for plugins.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="web-interface">Web Interface</h3>
|
|
<ul>
|
|
<li>The web interface (if enabled by default in your <code>plugins/web_server/metadata.ini</code> file) must have the bot itself as a
|
|
high-privileged user in the user privileges.
|
|
</li>
|
|
<li>To add the bot to the user privileges, use the !addprivileges command: <code>!addprivileges MyBotName 5</code>
|
|
(This sets the bot at an equal privilege level as the owner)
|
|
</li>
|
|
<li>If the bot is already in the user privileges, use the !setprivileges command: <code>!setprivileges MyBotName
|
|
5</code> (This sets the bot at an equal privilege level as the owner)
|
|
</li>
|
|
</ul>
|
|
<h3 id="how-to-start">Already configured the bot? Here's how to start it</h3>
|
|
<ul>
|
|
<li>Use the <code>-ip</code> launch parameter to specify the server ip.</li>
|
|
<li>Use the <code>-port</code> launch parameter to specify the server port.</li>
|
|
<li>Optionally, use the <code>-password</code> launch parameter to specify the server password (if it has one).</li>
|
|
<li><a href="https://duckboss.github.io/JJMumbleBot/wiki/general/command_line_arguments.html">Full command line arguments
|
|
list</a>
|
|
<pre><code>python JJMumbleBot/ -ip <serverip> -port <serverport>
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
<h2 id="quick-start">Quick Start - 5 Steps</h2>
|
|
<ol>
|
|
<li><b>Install the required dependencies and python version.</b>
|
|
<ul>
|
|
<li>Download and install python 3.7+
|
|
<ul>
|
|
<li>Linux: Depends on the distribution.</li>
|
|
<li>Mac OSX: <a href="https://www.python.org/downloads/mac-osx/">Mac OSX Python Downloads</a></li>
|
|
<li>Windows: <a href="https://www.python.org/downloads/windows/">Windows Python Downloads</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Installing project dependencies
|
|
<ul>
|
|
<li><code>pip install -r requirements/requirements.txt</code> OR <code>python3 -m pip install -r requirements/requirements.txt</code></li>
|
|
<li><code>pip install git+git://github.com/azlux/pymumble@pymumble_py3</code> OR <code>python3 -m pip install git+git://github.com/azlux/pymumble@pymumble_py3</code></li>
|
|
<li><b>Note: You must have libopus installed and installation varies by operating system.</b></li>
|
|
</ul>
|
|
</li>
|
|
<li>Updating project dependencies
|
|
<ul>
|
|
<li><code>pip install --upgrade -r requirements/requirements.txt</code> OR <code>python3 -m pip install --upgrade -r requirements/requirements.txt</code></li>
|
|
<li><code>pip install --upgrade git+git://github.com/azlux/pymumble@pymumble_py3</code> OR <code>python3 -m pip install --upgrade git+git://github.com/azlux/pymumble@pymumble_py3</code></li>
|
|
<li><b>Note: You must have libopus installed and installation varies by operating system.</b></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><b>Generate a .pem certificate and place it in the bot's root directory.</b>
|
|
<ul>
|
|
<li>You can skip this step if your server won't be using a certificate.</li>
|
|
<li>A .p12 certificate may be generated through the mumble client's certificate wizard and converted to .pem:
|
|
<pre><code>openssl pkcs12 -in jjmumblebot.p12 -out jjmumblebot.pem -clcerts -nokeys</code></pre>
|
|
</li>
|
|
<li>Alternatively, a certificate can be generated using OpenSSL:
|
|
<pre><code>openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout jjmumblebot.pem -out jjmumblebot.pem -subj "/CN=jjmumblebot"</code></pre>
|
|
(Special thanks to <a href="https://github.com/bamtan">bamtan</a> for providing the openssl command)
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><b>Setup your config.ini file</b>
|
|
<ul>
|
|
<li>Quick rundown:
|
|
<ul>
|
|
<li>Copy the <code>config_template.ini</code> file from the <code>JJMumbleBot/cfg/templates/</code>
|
|
directory to the <code>JJMumbleBot/cfg/</code> directory and rename it to
|
|
<code>config.ini</code>
|
|
|
|
</li>
|
|
<li>Fill in the placeholder fields in the config file under each section.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Detailed explanation:
|
|
<ul>
|
|
<li>
|
|
<a href="https://duckboss.github.io/JJMumbleBot/wiki/general/config_file.html">Config.ini Setup Page</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><b>Setup your global_aliases.csv file</b>
|
|
<ul>
|
|
<li>Copy the <code>aliases_template.csv</code> file from the <code>JJMumbleBot/cfg/templates/</code>
|
|
directory into the <code>JJMumbleBot/cfg/</code> directory and rename it to
|
|
<code>global_aliases.csv</code></li>
|
|
<li>Edit the file and add/remove alias commands as much as you like. <b>(OPTIONAL)</b></li>
|
|
<li>If you are a new user, I suggest leaving the file as is, after copying it to the
|
|
<code>JJMumbleBot/cfg/</code> directory.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><b>Setup your plugins (OPTIONAL)</b>
|
|
<ul>
|
|
<li>Copy your third-party plugins into the <code>JJMumbleBot/plugins/extensions/</code> directory.</li>
|
|
<li>Modify the <code>privileges.csv</code> file for any plugin if you want to change the default command
|
|
privileges.
|
|
</li>
|
|
<li>Modify the <code>aliases.csv</code> file for any plugin if you want to change/add-to the default command
|
|
aliases.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
<footer></footer>
|
|
</body>
|
|
</html> |