Free Kruiz Control v2.1.0

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord

Fixing the Twitch Integrations​

BREAKING CHANGES

• The Twitch setting, code.txt, must be regenerated to pick up new authentication scopes.
• There is a new Chat settings process. The Chat component now uses the same authentication flow as the Twitch component. For more information, see the new Chat settings.

New

• MQTT integration (credit: Yannick Mauray): OnMQTT and MQTT Publish
• OBS Recording-related triggers: OnOBSRecordingPaused, OnOBSRecordingResumed, OnOBSRecordingStarted, OnOBSRecordingStopped
• OBS Recording-related actions: OBS PauseRecording, OBS RecordingStatus, OBS ResumeRecording, OBS StartRecording, and OBS StopRecording.
• OnTWChatClear to detect when the Twitch chat is cleared by a moderator.
• OnTWChatClearUser to detect when a specific user's chat messages are cleared by a moderator.
• OnTWSuspiciousUser to detect when a suspicious (due to ban evasion, etc.) user sends a chat message.
• OnTWUnVIP for when a VIP is removed from the channel.
• OnTWVIP for when a VIP is added to the channel.
• Added additional logging to all Twitch API calls when using Debug Twitch

Fixes

• The OBS integration would fail to set up correctly if Kruiz Control sent messages before the OBS websocket was ready.
• Rebuilt Twitch EventSub integration to manage its own credentials and properly refresh the connection and subscriptions. Resolves issues where Twitch would disconnect after the authentication token expired.
• Twitch PubSub reconnects when connection closes (handles OnCommunityGoalProgress, OnCommunityGoalStart, and OnCommunityGoalStop)
• Twitch APIs wait for a new authentication token if it is expired.
• Twitch AdSchedule returns valid next_ad_time and next_snooze_time parameter values.
• Updated Twitch AdSchedule documentation to note use of -1 when no ads scheduled.
• The _kc_event_id_ broke in the v2.0.6 release, causing issues with Playing audio. Play wouldn't exit properly when using the wait input.
• Updated _kc_event_id_ documentation to note that it's a UUID, not a number.
• The _successful_ and _unsuccessful_ parameters now properly track the Voicemod connection.
• README uses OnTWChannelPoint instead of OnChannelPoint.
• All markdown links are now relative to the specific branch of Kruiz Control.

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord

Quality of Life Updates​

New

• SETTING: variable/autoload.txt. Allows users to configure variables (including global variables) to automatically load in all events.
• Inputs are now allowed to be multi-line.
• Twitch AdSchedule to retrieve upcoming scheduled ad, snooze, and pre-roll related information.

Fixes

• Twitch User now returns a profile_image parameter.
• Fixed Twitch Commercial API call to properly pass inputs.

OBS and Twitch updates!​

THIS UPDATE REQUIRES RE-AUTHENTICATING TWITCH SETTINGS
Follow the Twitch Settings instructions under the Code header.

New

• OBS StreamStatus for checking if OBS is streaming or reconnecting.
• OnTWAd trigger for Twitch Ad breaks.
• Added an optional_reason input to Twitch Ban.
• Twitch RewardCost, Twitch RewardDescription, and Twitch RewardName for updating Channel Point information.
• Twitch Warn for using Twitch's mod warn system.

Fixes

• Fixed an issue where special characters caused parameter manipulation to enter an infinite loop or fail. (Thanks, VictoryPointGaming)
• Updated all [True/False] notes in the documentation to [true/false] to match what needs to be checked.

Minor List and Twitch Update!​

New

• List Unique to remove duplicates from a list.

Fixes

• Updated the Twitch EventSub library to v1.0.3 to Fix token refresh error when token validation fails.
• Changed the tutorial link on the homepage to the latest tutorial.
• Updated List documentation to detail inputs more.

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord

Twitch Hype Chats and Twitch Auth fixes!​

New

• OnHypeChat trigger for Twitch Hype Chats.
• Twitch Auth returns a channel_id parameter

Fixes

• Twitch authentication token will refresh if it expires without requiring a Reset
• Remove deprecated documentation example from Discord Send.

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord ​

Minor Twitch fixes and OBS reordering!​

New

• OBS Order action for reordering OBS sources within a list.

Fixes

• OnTWSubMessage and OnTWSubGift were not triggering properly.
• OBS Image could throw errors and stop an event early.
• Added missing documentation for Twitch Unraid
• Removed extra parameters under Twitch Slowoff documentation.
• Fixed Twitch Description documentation.
• Updated Twitch Code settings language for clarity.
• Updated Twitch clientSecret.txt settings information.

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord

Twitch fixes and improvements!​

New

• Twitch CreateReward action for creating new channel point rewards.
• Twitch CreateClip action now provides parameters with the clip information.

Fixes

• OnTWHypeTrainConductor, OnTWHypeTrainLevel, OnTWCheer, OnTWRaid, OnTWShieldStart, and OnTWShieldStop were not triggering properly.
• Loop parameters, loop and loop_i, were not correct when used with nested loops.
• OnTWSubMessage documentation incorrectly mentioned gifted subs.
• List Set link in documentation table of contents was incorrect.

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord

Super Twitchy and Voicemod Support!​

NEW TWITCH SETTINGS
This update adds a new Twitch integration to take advantage of the Twitch EventSub and APIs! Please see the settings page for more information on getting started.

Breaking Changes​

The OnCommand and OnKeyword permission set was updated.

• f - Follower (previously f was used for Founder)
• o - Founder

THE FOLLOWING TRIGGERS ARE RENAMED AND HAVE UPDATED PARAMETERS:

• OnChannelPoint -> OnTWChannelPoint
• OnCommunityGoalComplete -> OnTWCommunityGoalComplete
• OnCommunityGoalProgress -> OnTWCommunityGoalProgress
• OnCommunityGoalStart -> OnTWCommunityGoalStart
• OnHypeTrainConductor -> OnTWHypeTrainConductor
• OnHypeTrainEnd -> OnTWHypeTrainEnd
• OnHypeTrainProgress -> OnTWHypeTrainProgress
• OnHypeTrainLevel -> OnTWHypeTrainLevel
• OnHypeTrainStart -> OnTWHypeTrainStart

THE FOLLOWING TRIGGERS ARE DEPRECATED (no longer supported):

• OnHypeTrainCooldownExpired

Changelog​

New

• New Twitch functionality: 42 triggers and 76 actions. Go look at the Documentation.
• New Voicemod actions for controlling voicemod sound effects and voice changers.
• Updated Founder OnCommand and OnKeyword permission from f to o.
• Added f as Follower permission for OnCommand and OnKeyword.
• Update user OnCommand and OnKeyword permission to support multiple users when comma delimited.
• OBS Image for setting an image source's file. (Idea: ItalianGrandma)
• OnSpeak now supports multiple user inputs (aliases). (Idea: Epyxx)
• Added in_count parameter to OnCommand.
• Added arg_count parameter to OnCommand and OnKeyword. (Idea: ItalianGrandma)
• Added message_id parameter to OnCommand, OnEveryChatMessage, OnKeyword, and OnSpeak.
• Added loop and loop_i parameter to Loop to track the loop iteration.
• OBS Version returns a version of Disconnected if the websocket is not connected. (Idea: Epyxx)
• Added additional OBS websocket connection disconnect and close logging.
• SLOBS websocket errors are now logged properly. This should help with debugging.
• Added Ignore action (used internally).

Fixes

• Removed old OnSECommunityGiftSub documentation. (Thanks, Johnnycyan)
• Removed old OBS Websocket info from documentation. (Thanks, Penwywern)

Home Page | Installation | Documentation | Tutorial | Patreon | Support Discord

More OBS Source control, TTS options, and fixes!​

New

• OBS Flip for horizontally or vertically flipping a source.
• OBS Rotate for rotating a source.
• OBS Stats for retrieving OBS stream statistics.
• TTS now supports pitch and rate inputs for modifying the voice.
• Added a log statement when KC initializes that logs the current version.
• Added a log statement when connecting to OBS that logs the OBS Websocket version.

Fixes

• Fixed KC failing to load when a file in fileTriggers.txt cannot be read.

Making Groups easier in OBS Websocket v5!​

Upgraded OBS triggers and actions that treat groups like scenes to support using the scene name instead.

---

Fixes​

- OnOBSSourceVisibility works properly when a source within a group is updated.
- OBS Position, OBS SceneSource, and OBS Size can update sources within a group without changing the value of <scene> to the group name.
- OBS Source can update sources within a group in the current scene.

Notes​

- OnOBSSourceVisibility no longer supports putting the group as the <scene> if listening for a source within a group.