JJMumbleBot
A plugin-based All-In-One mumble bot solution in python 3.7+ with extensive features and support for custom plugins.
GPL-3.0 License
Stars
50
JJMumbleBot
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 commandsClick To List FeaturesCheck For Dependency UpdatesUpdate Dependencies Directly Through The Bot |
| Bot Commands Plugin | Enhanced interactivity and management commandsClick To List FeaturesUser Administration: Kick/User/Ban/Move/Mute/Deafen CommandsChannel Administration: Create/Remove/Rename Temporary and Permanent ChannelsUser Privileges: Set User Privileges, Blacklist/Whitelist Users |
| Core Commands Plugin | Core bot administration commandsClick To List FeaturesPlugin Administration:Start/Stop/Restart Plugins At RuntimeBot Information: Set Mumble Comment, Display Version/Uptime/AboutAlias System: Add/Update/Import Aliases For Commands At RuntimeCommand Permission System: Add/Update/Import Permissions For Commands At RuntimeCommand History: Display Recently Used Commands |
| Server Tools Plugin | Additional administrative features and server callback-related eventsClick To List FeaturesDisplay A Link To The JJMumbleBot WikiUser 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 FeaturesUser 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 FeaturesQueue Audio/Video ClipsAudio Controls - Pause/Resume/Shuffle/Skip/Loop/Seek/StopAudio 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 FeaturesWeb Interface Security: HTTPS/SSL SupportWeb Server Commands: Start/Stop The Web Server Through CommandsOptional Automatic Certificate Generation |
| Entertainment/Media Plugins List | Features |
|---|---|
| Media Plugin | Stream Youtube videos/playlists or SoundCloud tracks with thumbnail image supportClick To List FeaturesYoutube Playlist SupportVideo ThumbnailsAudio Queue SystemDirect Youtube/SoundCloud Link SupportSearch/Browse Youtube SupportMumble Whisper Integration |
| Images Plugin | Display images from local files or download images from the internetClick To List FeaturesLocal Images SupportDirect URL Images SupportAudio Queue SystemDirect Youtube/SoundCloud Link SupportSearch/Browse Youtube SupportMumble Whisper Integration |
| Sound Board Plugin | Stream audio clips from local files or download audio tracks from YoutubeClick To List FeaturesLocal Audio Clips SupportDownload And Play Audio Clips From YoutubeMumble Whisper IntegrationPlay Random Audio Clips From LibrarySupports Popular File Types |
| Randomizer Plugin | Do custom dice rolls, coin flips, etc. in the channelClick To List FeaturesCustom Dice RollsCoin FlipsStandard 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 FeaturesChoose voices from a list of over 50 voices by Amazon PollyChoose a default TTS voiceSet maximum character limits for TTSStream or Download TTS voice clips |
Easy Expansion With Custom Plugins
- Easily expand the features of your bot by building custom plugins with the extensive and detailed API provided by JJMumbleBot.
- Click here to check the Wiki Guide!
Custom GUI System
- Pseudo-GUI System [PGUI] - A pseudo graphical user interface built with html tags.
- Pseudo-GUI API
Screenshots 📷
Installation And Setup 🏃
Please refer to the Requirements Wiki Page for a full list of requirements, and instructions for installation. Additionally, the Quick Start Guide is also helpful for setting up the bot.
Docker Setup 🏃
Please check the Docker Setup Wiki Page for more information.
Documentation 📝
JJMumbleBot Documentation Wiki F.A.Q - Solve common issues easily Requirements and Dependencies Quick Start Guide