v5.3.0 Update

New Features and Fixes

Github Download Link

Update Guide To v5.3.0 For v5.2.0 Users
Click Here To View Guide
  • Required Update Config.ini File
    Update your config.ini file to include the two new audio ducking fields under the [Media Settings] section:
                            [Media Settings]
                            DuckingStartDelay = 1.0
                            DuckingEndDelay = 1.0
                        
    Be sure to remove the DuckingDelayfield if it exists. Refer to the /templates/ directory to see a template of the file.
Update Guide To v5.3.0 For v5.1.0 and v5.1.1 Users
Click Here To View Guide
  • Required Update Config.ini File
    Update your config.ini file to include EnableDatabaseIntegrityCheck=True under the [Main Settings] section:
                            [Main Settings]
                            EnableDatabaseIntegrityCheck = True
                        
    Update your config.ini file to include the two new audio ducking fields under the [Media Settings] section:
                            [Media Settings]
                            DuckingStartDelay = 1.0
                            DuckingEndDelay = 1.0
                        
    Be sure to remove the DuckingDelayfield if it exists. Refer to the /templates/ directory to see a template of the file.
  • Optional Setup Custom Aliases File
    Rename your global_aliases.csv file to custom_aliases.csv
    Alternatively, if you don't have custom aliases under global_aliases.csv you can simply delete it.
  • Optional Setup Custom User Privileges File
    Create a custom_user_privileges.csv file (template provided in /templates/ folder) and fill it with custom user privileges as required.
    This is important since the new update will require the database to be regenerated, so doing this will prevent any loss of custom user privileges.
  • Optional Setup Custom Command Permissions File
    Create a custom_permissions.csv file (template provided in /templates/ folder) and fill it with custom command permissions as required.
    This is important since the new update will require the database to be regenerated, so doing this will prevent any loss of custom command permissions.

Radio Streaming Support for Media Plugin NEW
    Added support for streaming audio from radio stations.
  • !radiolink 'url': Start streaming audio from compatible radio stations.
  • Please note that radio streaming isn't supported for all radio stations and it requires a direct link to the icecast stream.
    Some examples of working radio station links are provided in the plugin's metadata file.

    You can use existing audio commands with radio streaming such as !stop/!pause/!resume/!playing
    Radio streaming isn't supported for all radio stations and it requires a direct link to the icecast stream.
    Some examples of working radio station links are provided in the plugin's metadata file.

  • Here are some examples of working icecast radio streams:

    • Rock:!radiolink http://stream.radioreklama.bg:80/radio1rock128
    • Latin/Spanish:!radiolink http://radio35.virtualtronics.com:8129/stream"
    • Korean Misc:!radiolink https://das-edge13-live365-dal02.cdnstream.com/a48202
    • KPOP:!radiolink https://antares.dribbcast.com/proxy/kpop?mp=/s
    • JPOP:!radiolink https://antares.dribbcast.com/proxy/jpop?mp=/s
    • NPR News:!radiolink https://npr-ice.streamguys1.com/live.mp3
    • Video Game Music:!radiolink http://stream.rpgamers.net:8000/rpgn
Audio Ducking Updates UPDATED

Split the audio ducking delay option into two separate delay options for finer control over the audio ducking feature:

  • Removed !duckdelay command and replaced it with !duckstartdelay and !duckenddelay.
  • Use !duckstartdelay to specify how long the bot should wait before ducking the audio volume when it detects user voice activity.
  • Use !duckenddelay to specify how long the bot should wait before restoring the ducked volume back to the original value when it detects no user voice activity.
  • Updated command line arguments and config options to match the above changes.
Adjusted !sbrandom... Related Commands Logic for Sound Board Plugin UPDATED

Adjusted logic for the !sbrandom... related commands to choose a different audio clip if it picks the same audio clip as the last time it was run. This change is to mitigate cases when it chooses the same audio clip back to back, making it feel less random.

Dependency Updates UPDATED

This project now requires a minimum of Python 3.9+ (previously 3.7+) to improve compatibility with the yt-dlp dependency and newer VLC versions which is heavily used for audio-related plugins.

The project has been updated to use yt-dlp instead of youtube-dl since the original project is no longer in development.
This new library works identically and is actively maintained.

I've updated the pymumble dependency to use a stable fork that I've created of another fork by oopsbagel which aims to improve and modernize pymumble since the original project is no longer in active development.
I've decided to fork it into my own repository so I can verify patches and ensure stability for usage in this bot.

Bug Fixes FIXES
  • Fixed an issue where image thumbnails could not be generated due to an outdated API.
  • Added missing default user connection sound file to server tools plugin: default_user_sound.wav
  • Improved and fixed documentation in several plugins.
Other Changes MISC
  • General formatting fixes and test cases updates.
  • Updated plugin templating to improve plugin creation experience.
  • Updated pymumble and pymumble callback references to use updated API.
  • Updated wiki with new requirements, upgrade guide, and release pages.
  • Optimized logging and debugging messages in the internal database library.
  • Added utility methods to find audio clips from the plugin media directory and integrate better with the sound board plugin.
  • Refactored user privilege checks.
  • Updated repository README to allow new users to better understand the features of JJMumbleBot.
  • Updated Quick Setup Utility web utility for v5.2.0
  • Updated bot internal version and updated plugins to v5.2.0
Known Issues KNOWN ISSUES

Server Tools Plugin: The feature to play a 'connection sound' when a user connects to the server is currently broken.
I highly suggest not using this feature. I don't plan on fixing it in this project and I will be addressing it in the larger rework project 'Mumimo'.
If you still decide to use it and the audio queue freezes, simply use !stop to flush the audio queue.

Text to Speech Plugin: The text to speech plugin is not functional to dynamically convert text to speech and currently only works for TTS clips that have already been downloaded previously.
An update is required to use a new endpoint that still works.