strimertul/CHANGELOG.md

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [CURRENT]

### Added

- **New UI**: Strimertul now features a more slick and better organized UI.
- **Multiple database options**: Strimertul now supports multiple databases drivers. BadgerDB will remain as default (and currently the only option) for the time being but other databases are coming in the future.
- **Database operations**: You can now export and import the entire database as JSON files
- **Database backups**: The database will periodically save optimized copies of itself in a backup directory, directory and intervals are both configurable, though for the time being you might need to periodically clean it before it becomes too large.
- **Exposed internal metrics via keys**: `twitch/chat-activity` and `twitch/stream-status` now expose previously internal-only info about the current stream.

### Changed

- The logging library has been changed to zap, the format of logs will therefore be wildly different.
- A lot of the command line parameters have changed syntax (eg. from -noheader to -no-header), please check the new formats using `-h` if you rely on them.
- Database schema has slightly changed, strimertul will auto-migrate to the new format if it detects old schema in use.

### Removed

- Twitch chat history doesn't have an explicit toggle anymore, they are always enabled unless the `chat_history` setting is set to 0.
- Loyalty point migration from v1.2.0 and earlier has been removed. If you are somehow running such an old version of strimertul and using loyalty points, run any version of strimertul between v1.3.0 and v1.7.0 first to make sure all points are migrated to the new format.

## [1.7.0] - 2021-12-07

### Added

- **Chat alerts based on webhooks**: You can now add follow/sub/cheer/raid messages in chat. Basic messages are fully functional, advanced features are still in works (such as variations for certain thresholds, e.g. a different raid message if the raid has more than X viewers coming in).
- Strimertul now prints its own version when starting up, useful for troubleshooting.

### Changed

- Timers do not have a "enabled" toggle anymore, they are always enabled (just non-functional if you have none).

### Fixed

- Twitch bot: fixed command checking, previous matching only checked for prefix (eg. !verylong could be called by writing !verylonglongbaaah)
- DB was not getting garbage collected, this is now fixed with a GC run every 15 minutes.

## [1.6.3] - 2021-11-30

### Added

- ACL on bot commands are now fully working and not a placeholder anymore!
- ACL level "Subscriber" for Twitch subscribers

## [1.6.2] - 2021-11-24

### Fixed

- Fixed oversight in bot timer cooldown calculation that made them never start
- Fixed timer configuration never getting applied when changed

## [1.6.1] - 2021-11-24

### Changed

- Twitch and Stulbe modules now reload/restart when their configuration changes instead of requiring strimertul to be closed and reopened manually.

## [1.6.0] - 2021-11-21

### Added

- KV Authentication using Kilovolt v6, check out [the authentication documentation](https://github.com/strimertul/kilovolt/blob/main/PROTOCOL.md#authentication) for more info.

### Changed

- The webserver now restarts when the bind address is changed, and the Web UI should auto-redirect to the new URL.
- The static server will react to configuration changes and auto-restart instead of requiring strimertul to be closed and reopened manually.
- Added a couple buttons in the secret debug page to dump all keys and their content

## [1.5.3] - 2021-11-12

### Added

- Added KV RPC `twitch/@send-chat-message` for writing text messages to chat

## [1.5.2] - 2021-11-05

### Added

- Chat timers

## [1.5.1] - 2021-10-05

### Added

- Stulbe integration for alerts

[current]: https://github.com/strimertul/strimertul/compare/v1.7.0...HEAD
[1.7.0]: https://github.com/strimertul/strimertul/compare/v1.6.3...v1.7.0
[1.6.3]: https://github.com/strimertul/strimertul/compare/v1.6.2...v1.6.3
[1.6.2]: https://github.com/strimertul/strimertul/compare/v1.6.1...v1.6.2
[1.6.1]: https://github.com/strimertul/strimertul/compare/v1.6.0...v1.6.1
[1.6.0]: https://github.com/strimertul/strimertul/compare/v1.5.3...v1.6.0
[1.5.3]: https://github.com/strimertul/strimertul/compare/v1.5.2...v1.5.3
[1.5.2]: https://github.com/strimertul/strimertul/compare/v1.5.1...v1.5.2
[1.5.1]: https://github.com/strimertul/strimertul/compare/v1.5.0...v1.5.1
Add changelog 2021-11-24 11:19:04 +00:00			`# Changelog`

			`All notable changes to this project will be documented in this file.`

			`The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),`
			`and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`

Update changelog 2021-12-09 12:41:16 +00:00			`## [CURRENT]`

			`### Added`

Update changelog 2022-01-02 10:50:37 +00:00			`- New UI: Strimertul now features a more slick and better organized UI.`
Multiple databases! 2022-02-01 11:35:34 +00:00			`- Multiple database options: Strimertul now supports multiple databases drivers. BadgerDB will remain as default (and currently the only option) for the time being but other databases are coming in the future.`
Update changelog 2022-01-02 10:50:37 +00:00			`- Database operations: You can now export and import the entire database as JSON files`
			`- Database backups: The database will periodically save optimized copies of itself in a backup directory, directory and intervals are both configurable, though for the time being you might need to periodically clean it before it becomes too large.`
Expose a couple internal metrics to show in the dashboard 2022-01-22 12:05:24 +00:00			- Exposed internal metrics via keys: `twitch/chat-activity` and `twitch/stream-status` now expose previously internal-only info about the current stream.
Update changelog 2021-12-09 12:41:16 +00:00
			`### Changed`

Multiple databases! 2022-02-01 11:35:34 +00:00			`- The logging library has been changed to zap, the format of logs will therefore be wildly different.`
Update changelog 2022-01-02 10:50:37 +00:00			- A lot of the command line parameters have changed syntax (eg. from -noheader to -no-header), please check the new formats using `-h` if you rely on them.
Update changelog 2021-12-09 12:41:16 +00:00			`- Database schema has slightly changed, strimertul will auto-migrate to the new format if it detects old schema in use.`
Multiple databases! 2022-02-01 11:35:34 +00:00
			`### Removed`

Expose a couple internal metrics to show in the dashboard 2022-01-22 12:05:24 +00:00			- Twitch chat history doesn't have an explicit toggle anymore, they are always enabled unless the `chat_history` setting is set to 0.
Multiple databases! 2022-02-01 11:35:34 +00:00			`- Loyalty point migration from v1.2.0 and earlier has been removed. If you are somehow running such an old version of strimertul and using loyalty points, run any version of strimertul between v1.3.0 and v1.7.0 first to make sure all points are migrated to the new format.`
Update changelog 2021-12-09 12:41:16 +00:00
Update changelog 2021-12-07 00:24:18 +00:00			`## [1.7.0] - 2021-12-07`
Fix twitch bot custom command checking 2021-12-01 22:32:51 +00:00
Update changelog and release script 2021-12-06 14:15:14 +00:00			`### Added`

			`- Chat alerts based on webhooks: You can now add follow/sub/cheer/raid messages in chat. Basic messages are fully functional, advanced features are still in works (such as variations for certain thresholds, e.g. a different raid message if the raid has more than X viewers coming in).`
			`- Strimertul now prints its own version when starting up, useful for troubleshooting.`

			`### Changed`

			`- Timers do not have a "enabled" toggle anymore, they are always enabled (just non-functional if you have none).`

Fix twitch bot custom command checking 2021-12-01 22:32:51 +00:00			`### Fixed`

			`- Twitch bot: fixed command checking, previous matching only checked for prefix (eg. !verylong could be called by writing !verylonglongbaaah)`
Update changelog and release script 2021-12-06 14:15:14 +00:00			`- DB was not getting garbage collected, this is now fixed with a GC run every 15 minutes.`
Fix twitch bot custom command checking 2021-12-01 22:32:51 +00:00
Update Changelog 2021-11-30 16:42:44 +00:00			`## [1.6.3] - 2021-11-30`

			`### Added`

			`- ACL on bot commands are now fully working and not a placeholder anymore!`
			`- ACL level "Subscriber" for Twitch subscribers`

Update changelog 2021-11-24 11:47:04 +00:00			`## [1.6.2] - 2021-11-24`

			`### Fixed`

			`- Fixed oversight in bot timer cooldown calculation that made them never start`
			`- Fixed timer configuration never getting applied when changed`

Add changelog 2021-11-24 11:19:04 +00:00			`## [1.6.1] - 2021-11-24`

			`### Changed`

			`- Twitch and Stulbe modules now reload/restart when their configuration changes instead of requiring strimertul to be closed and reopened manually.`

			`## [1.6.0] - 2021-11-21`

			`### Added`

			`- KV Authentication using Kilovolt v6, check out [the authentication documentation](https://github.com/strimertul/kilovolt/blob/main/PROTOCOL.md#authentication) for more info.`

			`### Changed`

			`- The webserver now restarts when the bind address is changed, and the Web UI should auto-redirect to the new URL.`
			`- The static server will react to configuration changes and auto-restart instead of requiring strimertul to be closed and reopened manually.`
			`- Added a couple buttons in the secret debug page to dump all keys and their content`

			`## [1.5.3] - 2021-11-12`

			`### Added`

			- Added KV RPC `twitch/@send-chat-message` for writing text messages to chat

			`## [1.5.2] - 2021-11-05`

			`### Added`

			`- Chat timers`

			`## [1.5.1] - 2021-10-05`

			`### Added`

			`- Stulbe integration for alerts`

Update changelog 2022-01-02 10:50:37 +00:00			`[current]: https://github.com/strimertul/strimertul/compare/v1.7.0...HEAD`
Update changelog 2021-12-07 00:24:18 +00:00			`[1.7.0]: https://github.com/strimertul/strimertul/compare/v1.6.3...v1.7.0`
Update Changelog 2021-11-30 16:42:44 +00:00			`[1.6.3]: https://github.com/strimertul/strimertul/compare/v1.6.2...v1.6.3`
Fix changelog link 2021-11-24 11:47:47 +00:00			`[1.6.2]: https://github.com/strimertul/strimertul/compare/v1.6.1...v1.6.2`
Add changelog 2021-11-24 11:19:04 +00:00			`[1.6.1]: https://github.com/strimertul/strimertul/compare/v1.6.0...v1.6.1`
			`[1.6.0]: https://github.com/strimertul/strimertul/compare/v1.5.3...v1.6.0`
			`[1.5.3]: https://github.com/strimertul/strimertul/compare/v1.5.2...v1.5.3`
			`[1.5.2]: https://github.com/strimertul/strimertul/compare/v1.5.1...v1.5.2`
			`[1.5.1]: https://github.com/strimertul/strimertul/compare/v1.5.0...v1.5.1`