Repository navigation
Pre-Release Bridigeipealgo v2.0.0-pr2
Pre-release
Pre-release
This is a pre-release of 2.0, some features may be incomplete or unstable. Please use at your own risk.
If you explode your room, please don't come crying to me. (because I'll cry too)
The datapackage reloading (see below), and manually clearing the internal directories, will be addressed in a pr3 / full 2.0 release.
I also plan (I hope) to have Discord -> AP chat running in time for 2.0.
No additional features will be considered for v2.0. All other features in milestones have been moved to a v2.X release.
!!! This release publishes a new .env.template. !!!
!!! Please update your existing .env with the new template. !!!
What's Changed in pr1 + pr2
- Core: Removed unused core dependencies
- Core: Reflowed global queue variables a bit
- Core: Added datapackage verification
- Datapackages will now be verified when the bot connects to a room. This will make sure you have the correct datapackage for the room the bot is connected to.
- If the datapackage is incorrect, it will fetch a new copy.
- If an error is detected (unable to verify datapackage) the bot will exit.
- Core: Added in CycleDiscord .env option for users who have issues with DiscordBot connectivity.
- Setting this value to greater than 0 will cause the discord bot to restart every X seconds.
- Good for unstable connections that cause Discord to break.
- Core: Added in reload commands for tracker and discord
- $reloadtracker and $reloaddiscord can be used to reload the processes if you notice the bot gets stuck not processing things.
- It's good to refresh the tracker first (when no checks are coming in), then discord second.
- Data is preserved in this manner, and should allow the queued-checks to flow freely.
- Core: Removed $reloadbot command in favor of $reloadtracker
- Core: Overhauled error logging to /logs/errorlog.txt
- Core: $setenv <key> <value> to dynamically change the tracker's configuration within discord.
- Running $reloadtracker should set the tracker to the new values
- More options will be added in v2.1+
- KNOWN ISSUE: Swapping rooms / ports doesn't clear the ItemQueues, RegistrationData, or current loaded datapackage
- ArchData will be replaced when the bot detects the changes in datapackages, but it does not LOAD the new packages (yet)
- Core: Converted to JSON storage for RegistrationData
- Core: Added QueueOverclock to speed up processing of queues by Discord
- Core: Updated to
websocketsinstead ofwebsocket-clientby @pyrox0 in #12 - Docs: Updated docs for new commands, env options, and readability (from pr1)
Dependencies change
- Due to the switch from
websocket-clienttowebsockets, you will need to run the pip install bits again.- I forgot to say that in pr1. Oops.
.env
Last update of the .env was v2.0.0-pr2 - If your version of the bot is older, please update with the new .env.template
Known issues:
- Swapping rooms / ports doesn't clear the ItemQueues or RegistrationData directories causing cross-room issues, or reload datapackages into memory.
- You'll need to clear the directories yourself. Restarting Bridgeipelago entirely will reload the datapackages into memory.
- This may/will cause issues with the datapackage and ItemQueues since you cant clear those in Discord at the moment
- Registration data can be cleared for yourself by running $clearreg
- It'll probably break somehow lol use at your own risk.