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.
138 lines
7.5 KiB
138 lines
7.5 KiB
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>JJMumbleBot - Requirements</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">Requirements</h2>
|
|
<hr>
|
|
<p><b>Note: Some third-party plugins may require additional dependencies</b></p>
|
|
<h3 id="dependency-installation">Dependency Installation/Updating</h3>
|
|
<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>
|
|
<li>Please make sure your murmur server supports sending text messages of over 90000 characters. (Configurable in your murmur.ini file)</li>
|
|
<li>Please check the <a href="https://duckboss.github.io/JJMumbleBot/wiki">Wiki</a> for setup procedures and more information.</li>
|
|
<li>JJMumbleBot has been tested on Linux/Windows platforms. MacOS is untested, but it should theoretically work.</li>
|
|
</ul>
|
|
<hr>
|
|
<h4 id="base-requirements">Base Requirements</h4>
|
|
<ul>
|
|
<li><a href="https://www.python.org/downloads/">Python 3.7+</a></li>
|
|
<li><a href="https://ffmpeg.org/">FFmpeg</a> and <a href="https://www.videolan.org/vlc/index.html">VLC</a> must be installed on your system.</li>
|
|
<li>You must have libopus installed and installation varies by operating system.</li>
|
|
</ul>
|
|
<h4 id="dependencies">Dependencies (Can be installed with pip)</h4>
|
|
<ul>
|
|
<li><a href="https://pypi.org/project/pymumble/">pymumble</a><br/>
|
|
I highly recommend installing the updated version directly from github like so: <code>pip install git+git://github.com/azlux/pymumble@pymumble_py3</code>
|
|
<ul>
|
|
<li>Core python wrapper for mumble interaction.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/beautifulsoup4/">beautifulsoup4</a>
|
|
<ul>
|
|
<li>Used to extract data from web pages and format urls.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/requests/">requests</a>
|
|
<ul>
|
|
<li>Used for http requests to get information from web pages.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://github.com/ytdl-org/youtube-dl#installation">youtube-dl</a> (This is updated often, so the
|
|
requirements.txt might be outdated)
|
|
<ul>
|
|
<li>Allows interaction with media sharing websites such as Youtube to stream/download media content.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/Pillow/">Pillow</a>
|
|
<ul>
|
|
<li>Used for image processing to support displaying images.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/fuzzywuzzy/">fuzzywuzzy</a>
|
|
<ul>
|
|
<li>Used to provide better searching by a method called "fuzzy searching".</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/python-Levenshtein/">python-Levenshtein</a>
|
|
<ul>
|
|
<li>Speeds up fuzzy searching processing by a large amount.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 id="additional-dependencies">Additional Dependencies (Requirements vary by plugin)</h4>
|
|
<ul>
|
|
<li>
|
|
<h5 id="dependency-web_server">Web Server Plugin</h5>
|
|
<p>Installation:<br>
|
|
<code>pip install -r requirements/web_server.txt</code> OR <code>python3 -m pip install -r requirements/web_server.txt</code><br/>
|
|
</p>
|
|
<p>Upgrading:<br>
|
|
<code>pip install --upgrade -r requirements/web_server.txt</code> OR <code>python3 -m pip install --upgrade -r requirements/requirements.txt</code><br/>
|
|
</p>
|
|
<ul>
|
|
<li><a href="https://pypi.org/project/websockets/">websockets</a>
|
|
<ul>
|
|
<li>Provides continuous data to the web interface.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/fastapi/">fastapi</a>
|
|
<ul>
|
|
<li>Internal framework for the web interface that provides the main API and web page.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/fastapi-utils/">fastapi-utils</a>
|
|
<ul>
|
|
<li>Additional required utilities for the FastAPI framework.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/uvicorn/">uvicorn</a>
|
|
<ul>
|
|
<li>Web server for the web interface.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/pydantic/">pydantic</a>
|
|
<ul>
|
|
<li>Used to create appropriate data models for web data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://pypi.org/project/aiofiles/">aiofiles</a>
|
|
<ul>
|
|
<li>Utilized by fastapi's underlying starlette module.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<footer></footer>
|
|
</body>
|
|
</html> |