Requirements

---

Note: Some third-party plugins may require additional dependencies

Dependency Installation/Updating

• Download and install python 3.7+

  • Linux: Depends on the distribution.
  • Mac OSX: Mac OSX Python Downloads
  • Windows: Windows Python Downloads

• Installing Core 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.

• Installing Web Server Dependencies [Optional]

  • You don't need to do this if you're disabling the web interface.
  • pip install -r requirements/web_server.txt OR python3 -m pip install -r requirements/web_server.txt
    

• 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.


• Please make sure your murmur server supports sending text messages of over 90000 characters. (Configurable in your murmur.ini file)
• JJMumbleBot has been tested on Linux/Windows platforms. MacOS is untested, but it should theoretically work.

---

Base Requirements

• Python 3.7+
• FFmpeg and VLC must be installed on your system.
• You must have libopus installed and installation varies by operating system.

Dependencies (Can be installed with pip)

• pymumble
  I highly recommend installing the updated version directly from github like so: pip install git+git://github.com/azlux/pymumble@pymumble_py3
  • Core python wrapper for mumble interaction.
• beautifulsoup4
  • Used to extract data from web pages and format urls.
• requests
  • Used for http requests to get information from web pages.
• youtube-dl (This is updated often, so the requirements.txt might be outdated)
  • Allows interaction with media sharing websites such as Youtube to stream/download media content.
• Pillow
  • Used for image processing to support displaying images.
• fuzzywuzzy
  • Used to provide better searching by a method called "fuzzy searching".
• python-Levenshtein
  • Speeds up fuzzy searching processing by a large amount.

Additional Dependencies (Requirements vary by plugin)

• Web Server Plugin

  Installation:
  pip install -r requirements/web_server.txt OR python3 -m pip install -r requirements/web_server.txt
  

  Upgrading:
  pip install --upgrade -r requirements/web_server.txt OR python3 -m pip install --upgrade -r requirements/requirements.txt
  

  • websockets
    • Provides continuous data to the web interface.
  • fastapi
    • Internal framework for the web interface that provides the main API and web page.
  • fastapi-utils
    • Additional required utilities for the FastAPI framework.
  • uvicorn
    • Web server for the web interface.
  • pydantic
    • Used to create appropriate data models for web data.
  • aiofiles
    • Utilized by fastapi's underlying starlette module.