Releases: DuckBoss/JJMumbleBot
v3.0.7 - Bug Fixes, New/Changed Commands
Changes/New Updates
Help Commands
- The !help command can now be used without any additional parameters to display the available help commands for all the plugins.
Example Usage:
!help: Displays a list of the help commands for all the available plugins.
(or)
!help 'plugin_name': Displays all the commands available for the given plugin.
User Comment For Bot
- Added new field : "DefaultComment" for users to add custom comments to bot via their config file.
- The "DefaultComment" field is set to "Hello! I am JJMumbleBot" by default but can be changed by the user.
- !comment command : Sets the bot's user comment with the given text.
!comment 'comment_text': Sets the bot's user comment with the given text.
- !resetcomment command: Resets the bot's user comment to the default text.
!resetcomment: Resets the bot's user comment to the default text.
Youtube Plugin
- The !link and !linkfront commands now displays an error when a playlist link is provided.
- The !playlist command now displays an error when a playlist link isn't provided.
Other Updates and Bug Fixes
- Removed debug print statements.
- Changed AllowedRootChannelsForTempChannels value in the config_template.ini to "Root" instead of "Default" since that's what the default murmur server uses.
- Added new field: SubHeaderTextColor to further customize the GUI text colors.
- The wiki has been updated to reflect these changes/additions.
Thanks to @ajmandourah for pointing out many issues that were fixed in this update.
v3.0.6 - Bug Fixes in config and youtube plugin
v3.0.5 - Bug Fixes, Youtube Plugin Fixed! 🥳 🥳
New Features
Sound Board Plugin
- !sbskip command : Allows users to skip to 'X' seconds into the song.
!sbskip 'seconds' : Skips ahead in the current sound board track by the given amount of seconds.
Youtube Plugin
- Fixed the youtube plugin, so videos work again!!! 🥳 🥳 🥳 🥳 🥳 🥳
- The youtube plugin gives an error message when a thumbnail is not able to be retrieved.
v3.0.4 - Bug Fixes, New Features, Wiki Updated
New Features
Sound Board Plugin
- Added !sbloop command which functions identically to the !sb command except the audio files loop until stopped.
!sbloop 'sound_clip': Plays a locally saved wav file, but endlessly loops until it is stopped.
Youtube Plugin
- Added !loop command which toggles the youtube plugin queue's loop mode. If enabled, songs will loop endlessly unless skipped/stopped.
!loop: Toggles the loop mode for the youtube plugin.
Wiki
- The wiki has been updated to v3.0+
All Updates
- The !help command now displays the plugin name on the help screen.
- Updated sound board to use 1024 byte buffers (up from 480).
- Added new alias: !saferestart for the command !safereboot.
- Added new metadata tags to allow the sound_board vlc instance to run with 'quiet mode' enabled or disabled.
- Added new metadata tags to allow the youtube vlc instance to run with 'quiet mode' enabled or disabled.
- Fixed Help data not updating in the database, when the html files are updated.
- Updated all version numbers for plugins.
- Updated bot version in metadata for 3.0.4 release.
- Added missing !help command to privileges, metadata, and help html file.
- Fixed issue where alias.csv files were missing for plugins.
- Updated 'about' text in the config_template.
- Removed unused reference to !botstatus command in help html file.
- Updated the plugin template for custom third party plugin developers to be in line with v3.0+.
- The wiki has been updated for v3.0+.
v3.0.3 - New sound board command and various bug fixes
New Features
- Added the !sbplaying command to the sound_board plugin so users can now see what the currently playing sound_board track is.
!sbplaying: Displays the current sound board clip that is being played and the duration of the clip.
Bug Fixes And Other Updates
- Removed code that attempted to filter out any sound clips over 6 seconds long that would have been played with the !sbrandom command.
- Any sound board clip now has an equal chance of playing with the !sbrandom command.
- Fixed typo in sound_board plugin so !sbrandom should work now.
- The youtube plugin !song command now displays which plugin the command is coming from when a song is not being currently played.
v3.0.2 - Fixed !sleep command and added missing metadata tags
All Updates
- Added missing metadata tag in youtube plugin.
- Fixed !sleep command by adding it to the ThreadWaitForCommands list in the core_commands metadata.ini file.
v3.0.1 - Fixed new aliases not registering properly at runtime
All Updates
- Fixed new aliases not registering properly at runtime
- Removed submodule references from legacy branch
- Added new items to .gitignore
v3.0.0 - Major Overhaul Update
NOTICE:
v3.0.0 does not currently have updated documentation. I am working on it!
The release notes below will be updated with the new documentation links as soon as it is available, but for now they will just have placeholder texts.
I will try to answer as many questions/issues as I can while the documentation is being updated.
Python Version
JJMumbleBot has been updated through multiple python revisions,
and with this update it will now require Python 3.7 or higher.
Aliases
There is now a global_aliases.csv file that must be placed in the JJMumbleBot/cfg/ directory, which will function similarly as the previous versions of the aliases.csv file.
In addition, individual plugins now require an aliases.csv file which will contain any command aliases related to that plugin.
The directory structure of this new system can be seen in the Plugins section below.
Plugins
Plugins are now separated into 'core' and 'extensions' folders.
Third party plugins that extend the functionality of the bot should be placed in the 'extensions' folder.
Various changes such as separating the help data and metadata into individual files have been made to improve the development and functionality of plugins.
Due to these changes, all existing custom third party plugins must be updated to the new format.
Plugin Development Changes
Plugins now require the following base heirarchy:
- plugin_name/
- resources/
- strings.py:contains static string references using in the metadata/script
- utility/ (optional directory to store utility scripts for your plugin)
- help.html : contains the help data for the plugin commands
- metadata.ini : contains plugin information and plugin-specific settings
- privileges.csv : contains user privilege requirements for plugin commands
- aliases.csv: contains aliases specifically to commands in the plugin
- plugin_name.py : main driver python script for the plugin
- resources/
Any additional utility files, scripts, folders or media can be added to this.
For more information on creating custom plugins, look at this documentation. ADD DOC HERE
Core Commands Plugin [NEW]
The core commands of the bot service has now been separated into it's own core plugin.
This plugin contains all critical service commands for the bot.
This includes all commands relating to aliases, rebooting, refreshing plugins, exiting the bot, etc.
Added new commands:
- Clears the bot command history.
!clearhistory
Bot Commands Plugin
Added new commands:
- Removes the current channel if it's created by the bot service.
!remove - Removed 'spam_test' command.
Text To Speech Plugin [NEW]
A plugin that allows users to type messages that can be read out by various TTS voices.
The plugin also allows users to download TTS clips to be played at a later time like the sound board plugin.
- Stream TTS message with specified voice
!tts 'voice_name' 'message' - Displays a list of all the TTS voices available
!ttsvoices - Download TTS message with specified voice into a clip
ttsdownload 'clip_name' 'voice_name' 'message' - Play existing TTS clip
!ttsplay 'clip_name' - Delete existing TTS clips
!ttsdelete 'clip_name' - Adjust TTS volume
!ttsv '0...1' - And MORE...
...
For a full list of commands, please check the documentation provided here. ADD DOC HERE
Auto-Updater Plugin [NEW]
A plugin that allows server administrators to check for bot dependency updates and update dependency packages as necessary
through commands in the plugin.
- Check for updates on a dependency (example: pymumble)
!checkforupdates youtube-dl - Update dependencies that are outdated (example: pymumble)
!updatedependency pymumble
Other Updates
Removed Web Interface Plugin
The previous web interface plugin implementation was very messy and experimental.
I will be releasing v3.0.0 without a web interface plugin, and will work on implementing
it properly in the near future.
New Default Aliases
For the full list of default aliases, please check the documentation provided here. ADD DOC HERE
Safe Mode Changes
Users can now set what plugins are included in safe mode by modifying the 'SafeModePlugins' list in their bot config.
Please note that you should always include the 'bot_commands' and 'core_commands' plugins in the list of safe mode plugins!
v2.3.2 - Bug Fixes in Sound_Board Plugin
Release Notes
- Fixed various path issues/bugs in the sound_board plugin that prevented users from playing audio clips.
v2.3.1 - Web Interface Enhancements And Bug Fixes!
Major Updates
Web Interface
- Added clear history button to command history page
- Added clear queue button to youtube queue page
Bug Fixes
- Fixed the navigation bar on the web interface
Other Updates
- Added missing third party licenses
- Updated bot version to v2.3.1
- Updated unit tests to v2.3.1
Note: Dependencies in this release may be outdated. Please update them after installation.