Pre-Alpha 3 Release
Pre-releaseSince the last release @daniel0611 became an active member of our team and we made a lot of progress.
Our main goal with this release was to improve the overall usabillity of the framework, espacially to make the life of plugin developers a lot easier.
Major changes
Let's summarize the most important changes, bug fixes and enhancements of the chat overflow project first:
- Reworked plugin structure and loading to hold all metadata in a xml file instead of Pluggable.
For plugin developers: Take a look at the migration guide to migrate your plugins to this new format - Added metadata to connectors
- Added a platform connector for RCON and StreamElements
- Added Cheer, Raid and Host events to Tipeeestream and StreamElements
- Added documentation for every platform to the wiki
- Added automatic updater for end-user deployments
- Updated versioning of all components to follow semantic versioning 2
Detailed changes
It's hard to document all the changes since the last release. We resolved over 40 issues since the last release which makes up a ton of new features and resolved bugs.
Framework
- Reworked plugin structure and loading to hold all metadata in a xml file instead of
Pluggable
(#41) - Added xml metadata file creation in the sbt
create
task (#20) - Added a flag to save logs to the
log/
directory (#107) - Added a deployment for plugin developers with precompiled framework, build-project and gui (#21)
- Added support for plugin dependencies that are downloaded at runtime using coursier (#105)
- Added
EventManager
andEventConnector
to simplify development of event-based platform connectors (#110) - Host REST-API npm package using GitHub Package Registry instead of npm (#133)
API / Platform Support
- Added a sbt generator that automatically generates requirements (#53)
- Made
Requirements
read-only to plugins (#79) - Added the possibility to get the username of the bot and ignore the bots messages to the TwitchChatConnector (#104)
- Removed leagacy MockupChat (#30)
- Fixed various json parsing exceptions in the TipeeestreamConnector (#132)
- Updated TipeeeStreamConnector to send the authentication token as a url parameter (#127)
- Added basic StreamElements platform support (#129)
- Added Cheer, Raid and Host events to Tipeeestream and StreamElements (#131)
- Added metadata xml files to all connectors (#40)
- Added everything required to publish the API to GitHub Package Registry (#130)
- Added RCON Connector (#62)
- Added documentation for every platform to the wiki (#38)
GUI
- Added realtime Sever-Sent events for plugin instance logs (#78)
- Split GUI into its own jar instead of residing in the jar of the framework (#109)
- Added connector metadata (#40)
- Fixed that the GUI couldn't refresh requirements if you tried to set a parameter with a invalid value (#153)
Launcher
- Added dependency management using coursier (#128)
- Added automatic updater for end-user deployments (#101)
- Split launcher to separate codeoverflow-org/chatoverflow-laucher repository (#137)
- Added a proper README to the deployments (#22)
Other
- Java- and Scaldoc of the framework and the api is now hosted at http://docs.codeoverflow.org and codeoverflow-org/chatoverflow-gh-pages (#92)
- Added scripts to setup the developer environment into the codeoverflow-org/chatoverflow-setup repository (#63)
- Added logging of all used versions at startup (#146)
- Updated versioning of all components to follow semantic versioning 2 (#118)
Pull Requests
The development progress of chat overflow was further pushed trough amazing pull requests. A big thank you to all contributors! The most outstanding:
- #68/codeoverflow-org/chatoverflow-api#8 by @strifel: Adding RCON Connector
- #78/codeoverflow-org/chatoverflow-gui#2 by @cesmec: Added realtime updates
- #126 by @derNiklaas: Added new metadata files and added a description to the TwitchChatConnector
- #148/codeoverflow-org/chatoverflow-api#18 by @derNiklaas: Added new parameter
- codeoverflow-org/chatoverflow-wiki#5 by @DragonCoder01: English fix
- codeoverflow-org/chatoverflow-setup#3 by @justgerd: Add initial version of script
- codeoverflow-org/chatoverflow-setup#4 by @derNiklaas: Create install.bat
Final words
All these changes bring us closer and closer to a first alpha release.
With the important framework improvements done we can now concentrate on implementing all the different services that we would really like to integrate into the framework.
There is already a long list of ideas, so feel free to join us!
The completely revised wiki will tell you all you need to know for contributing.
Thank you for accompanying us on this journey!