Free Kruiz Control v2.3.0

Commence "Official" File Reading​

New

• File handler to support OnFileUpdated and File Read.
• OnTWBits trigger for Twitch bit-related events.
• OBS GetSize action to retrieve the size of a source.
• Args action to extract named inputs from a given string value.
• Param Contains action to check for a value within a string.
• Added an additional log to the parser to help identify when a multi-line parsing issue occurs.

Fixes

• Update Twitch EventSub event versions to latest.
• Fixed OnTWCommunityGoal... trigger documentation issues.

Small OnInit Bug Fix​

Fixes

• On OBS start, on some computers, OnInit events could fail to trigger. (Reported by ItalianGrandma)

Fixes all around​

BREAKING CHANGES

• Additional Twitch authentication scopes were added to support Twitch whispers. Redo the Chat code.txt and Twitch code.txt settings.
• New Chat user.txt setting is used to specify the account that will be sending messages. Only required if using a separate bot account.

New

• Improved initialization! Kruiz Control now waits for all handlers (integrations) to finish initializing before starting.
• OnOBSSourceVisibility supports wildcard sources and has a new source parameter.
• Additional OBS source actions: (credit: Sabera)
  • OBS CreateSource
  • OBS Crop
  • OBS DuplicateSource
  • OBS GetCrop
  • OBS GetPosition
  • OBS GetSourceTypes
  • OBS RemoveSource
• Added a Debug config setting to allow debugging prior to Kruiz Control start.
• Added more debug options (Debug Controller and Debug Debug)
• Kruiz Control now tracks Twitch user ids to avoid repeated calls to decapi.

Fixes

• Chat Whisper was unable to send whispers. Updated to use the Twitch API instead of ComfyJS.
• Whispers to the user sending messages can now trigger commands again.
• MQTT initialization, connection, and subscription issues due to pending connections. (credit: gvsyn)
• OnTimer timers start after initialization is finished.

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.