Skip to content

A plugin-based All-In-One mumble bot solution in python 3.7+ with extensive features and support for custom plugins.

License

Notifications You must be signed in to change notification settings

DuckBoss/JJMumbleBot

Repository files navigation

JJMumbleBot

A plugin-based All-In-One mumble bot solution in python 3.7+ with extensive features and support for custom plugins.


πŸ“« How to reach me: duckboss@kakao.com

Development Status

This project is actively being reworked here as the Mumimo project: Mumimo
The current version should still be functional for legacy users, but all new bugs/issues are being worked on in the reworked project.

Features πŸ”₯

Feature-rich Command, Alias, and User Privileges System

  • Multi-Command Input - Input multiple commands in a single line.
  • Command Aliases - Register custom aliases to shorten command calls, and do some nifty command combinations.
  • Custom Command Tokens - Custom command recognition tokens (ex: !command, ~command, /command, etc)
  • Command Tick Rates - Commands in the queue are processed by the tick rate assigned in the config.
  • Multi-Threaded Command Processing - Commands in the queue are handled in multiple threads for faster processing.
  • Reconfigurable Command Privileges - The user privileges required to execute commands can be completely reconfigured.

Built-in Web Interface

  • A fully featured web interface is included in JJMumbleBot by default

Built-in Plugins

Fast Multi-threaded, responsive, plugin-based system for easy expandability.

The list of features shown under each plugin is not inclusive of all the features the plugins contain, but only the most important features.
This means that most plugins have more features than the ones listed below!

Server/Web Administration Plugins List Features
Auto Updater Plugin

A System to update dependencies through bot commands

Click To List Features
  • Check For Dependency Updates
  • Update Dependencies Directly Through The Bot
Bot Commands Plugin

Enhanced interactivity and management commands

Click To List Features
  • User Administration: Kick/User/Ban/Move/Mute/Deafen Commands
  • Channel Administration: Create/Remove/Rename Temporary and Permanent Channels
  • User Privileges: Set User Privileges, Blacklist/Whitelist Users
Core Commands Plugin

Core bot administration commands

Click To List Features
  • Plugin Administration:Start/Stop/Restart Plugins At Runtime
  • Bot Information: Set Mumble Comment, Display Version/Uptime/About
  • Alias System: Add/Update/Import Aliases For Commands At Runtime
  • Command Permission System: Add/Update/Import Permissions For Commands At Runtime
  • Command History: Display Recently Used Commands
Server Tools Plugin

Additional administrative features and server callback-related events

Click To List Features
  • Display A Link To The JJMumbleBot Wiki
  • User Connection Sounds: Play Audio Clip When Users Join
Whisper Plugin

Mumble Whisper integration for audio data, which allows audio to be played to specific users only.

Click To List Features
  • User Whisper Support: Set Mumble's whisper to single/multiple users.
  • Channel Whisper Support: Set Mumble's whisper to channels.
Audio Commands Plugin

Full audio control of the bot with additional audio features like "audio ducking"


Click To List Features
  • Queue Audio/Video Clips
  • Audio Controls - Pause/Resume/Shuffle/Skip/Loop/Seek/Stop
  • Audio Ducking Integration (Method of lowering currently playing audio when users are speaking)
Web Server Plugin

Control and manage the bot with an optional web interface, which allows remote usage of the bot and administrative features.
This is a popular feature that server owners utilize to manage the bot.

Click To List Features
  • Web Interface Security: HTTPS/SSL Support
  • Web Server Commands: Start/Stop The Web Server Through Commands
  • Optional Automatic Certificate Generation
Entertainment/Media Plugins List Features
Media Plugin

Stream Youtube videos/playlists or SoundCloud tracks with thumbnail image support


Click To List Features
  • Youtube Playlist Support
  • Video Thumbnails
  • Audio Queue System
  • Direct Youtube/SoundCloud Link Support
  • Search/Browse Youtube Support
  • Mumble Whisper Integration
Images Plugin

Display images from local files or download images from the internet


Click To List Features
  • Local Images Support
  • Direct URL Images Support
  • Audio Queue System
  • Direct Youtube/SoundCloud Link Support
  • Search/Browse Youtube Support
  • Mumble Whisper Integration
Sound Board Plugin

Stream audio clips from local files or download audio tracks from Youtube


Click To List Features
  • Local Audio Clips Support
  • Download And Play Audio Clips From Youtube
  • Mumble Whisper Integration
  • Play Random Audio Clips From Library
  • Supports Popular File Types
Randomizer Plugin

Do custom dice rolls, coin flips, etc. in the channel


Click To List Features
  • Custom Dice Rolls
  • Coin Flips
  • Standard Dice Rolls (d6, d12, d100, etc.)
Text-To-Speech Plugin

Full-featured text-to-speech plugin with support for advanced Amazon Polly voices, multiple language recognition, etc!


Click To List Features
  • Choose voices from a list of over 50 voices by Amazon Polly
  • Choose a default TTS voice
  • Set maximum character limits for TTS
  • Stream or Download TTS voice clips

Easy Expansion With Custom Plugins

Additional Features

    Custom GUI System

    • Pseudo-GUI System [PGUI] - A pseudo graphical user interface built with html tags.
    • Pseudo-GUI API
Screenshots πŸ“·

    Screenshots πŸ“·

    Audio Interface System (youtube plugin, sound board plugin, etc)

    Channel Chat Image

    Web Interface - Commands Page

    Commands Tab Image

    Web Interface - Audio Page

    Audio Tab Image

    Web Interface - Debug Page

    Debug Tab Image
Installation And Setup πŸƒ
Documentation πŸ“

Got any questions or concerns? Please post an issue report πŸ‘‹