¶ Streamer.bot v0.1.19 (Current)
Released 2023-03-10
- DonorDrive would not reconnect properly
- DonorDrive incentive event was not being triggered
- Some DonorDrive events were not propagating to the UI
- DonorDrive events on the UI were not being sorted correctly when new events happened
- Fix Patreon events not firing
- Fix potential issue with Kofi events
- Fix internal tracking of moderator/vips
- Fix isModerator and isVip related variables for actions, and add target info sub-action
- Update Twitch Clear Chat sub-action to use broadcaster account
- Prevent Test button of some OBS sub-actions when using variables from crashing
- Fix C# method ClearUsersFromGroup()
- Twitch EventSub Follow event has been updated to version 2
- Twitch Raid event no longer includes raider's names, see note below
- Remove option to use old style Sub-action menu
- Tweaks to Twitch EventSub connection
- Tweaks to how Twitch retry timers were handled
- Some tweaks to internal viewer object, hopefully duplicate users no longer show
- Play Sound sub-action now supports variables
- Play Sound from Folder sub-action now supports variables
¶ Important Notes for Twitch
Currently the Raid Event adds a %raiderNames% variable with information on who it thinks is part of the raid. Because the tmi end point is being retired, this variable will no longer be available, as there are no replacement methods that can be used publicly.
As of April 3rd, 2023, the tmi endpoint for obtaining a channel's list of chatters will be removed, Streamer.bot will be removing the aforementioned
%raiderNames%variable sometime in March with an update.
¶ Streamer.bot v0.1.18
Released 2023-02-22
- Fix Set Channel Tags sub-action, was limited to 5
- Handle crash from Midi In events that can not be decoded properly
- Fix Custom Websocket Client close action not being triggered
- Fix crash if a tab was hidden and you use the bottom right status to try to navigate to it
- Fix not being able to use a named hostname for an OBS connection
- Fix crash when adding a Custom Websocket server and emptying the port field
- TipeeeStream credentials were not being saved correctly, causing it to lose them every restart
- VoiceMod integration works again, for VoiceMod v2.38.1 and higher
- Fix manual disconnect of Twitch Bot Chat Client
- Fix wording in Set Action group state sub-action
- Fix the Twitch Set Follower Mode/Chat Delay methods
- Fix being able to delete Twitch Hype Train level
- Fix issue with api calls to retrieve list of Twitch banned/timed out users, Twitch changed something with this endpoint
- Fix YouTube Stream EndEvent not triggering
- Adjust SSL protocol capabilities for Chat, PubSub and EventSub connections
- Fix potential crash with OBS Websocket 5 and null values in an item's transform (not sure how this is even possible)
- Fix YouTube present viewers slider value, was using Twitch's slider bar
- Fix test button for Twitch Stream Update, it will now grab the game info from your channel, if no game is selected
- Fix visual bug with VIP and Mod still showing checked (or unchecked) on a user after selecting it.
- Fix clear check box not being disables in the Set Action Queue Pause State sub-action by default
- Fix Twitch Raid Send, Cancel and Go test not working correctly
- Update Twitch Add Target Info to include the target's channel title, this will be available in
%targetChannelTitle% - Request new scope
moderator:manage:banned_usersfor the Twitch Bot account, this was missing for banning users to work - Streamer.bot no longer uses the
games.datdata file for Twitch game categories, it is now realtime search capable - Updates to the DonorDrive integration
- Update Add Broadcaster information to add new variables
- Move Add Follow Age to a new Followers sub-menu
- Switch to new Twitch Follow event sub beta subscription
- Switch to new Twitch Get Followers api call
- Internally handle Twitch Moderator add/remove, updating users without waiting for them to perform an action
- Update Twitch Add Target Info sub-action to include subscription tier, if user is subscribed
- Update retry timer for Twitch services to reset when cancelling the retry
- Update retry timer for Twitch services to have a hard limit of 2 minutes
- Twitch's Shout Out endpoint and EventSub subscriptions have been moved out of beta to general availability
- Rename TwitchSpeaker sub-action
- Add ability to delete an group in the Action list
- Add ability to delete a group in the Command list
- Add deletion confirmation for Commands
- Add ability to select multiple Actions, and delete them
- Add an
isTestargument to some Twitch events, this will be set when the event comes from the Test button within Streamer.bot - Read Lines From File sub-action now supports variables in the path, you can edit the path
- Read Random Line From File sub-action now supports variables in the path, you can edit the path
- Write To File sub-action now supports variables in the path, you can edit the path, as well, the path will be created if it does not exist
- Streamer.bot is now tracking Twitch Bit donations.
- New C# method to obtain a users total bits donated (this uses the above tracked data)
- Add 2 new sub-actions to add/remove a Twitch VIP
- Add 2 new sub-actions to add/remove a Twitch Moderator
- Add auto-indentation to Execute C# Code sub-action editor
- Add basic auto-completion for the
CPHobject in the Execute C# Code sub-action editor - Add new C# method to get list of Twitch Rewards
- Add Incentive event to DonorDrive
- Add 2 new sub-actions to get the Latest Twitch Subscriber and Follower
- Add new sub-action to get your Twitch Follower Count
- Add new sub-action to get your Twitch Subscriber Count and Subscriber Points
- Add an
isTestvariable to the Community Goal event - Add last and previous active to Twitch Add Target Info sub-action
- Request new Twitch scope,
moderator:read:followers - Add Twitch Chat Cleared event
- Track subscriptions in local Twitch DB
- Add new C# method TwitchIsUserSubscribed
- Add a new inline method
$length()$, this will get the length of a string, and variables are supported, any variable used will be treated as a string - Streamer.bot will now recognize when a user is given VIP, and update data internally, unfortunately, there is no event for when VIP is removed at the moment
- Provide a notice when Importing commands, that they will be disabled
- Add new sub-action, Read Specific Line from File
- Add new Twitch sub-actions, Ban User, Unban User, and UnTimeout User
- Add ability to set the queue/group of multiple actions at once
- Added some extra logging for Twitch NOTICE responses to help diagnose potential issues
¶ Important Notes for Twitch
There 2 pending changes for the Twitch API:
The first involves IRC slash commands and 3rd party applications.
As of Februray 24th, 2023, 3rd party apps will no longer be able to use IRC slash commands. Streamer.bot has already been updated with support for the new API methods to perform these commands
The second, involves the old, undocumented API to retrieve a channels list of chatters. Currently the Raid Event adds a %raiderNames% variable with information on who it thinks is part of the raid. Because this end point is being retired, this variable will no longer be available, as there are no replacement methods that can be used publicly.
As of April 3rd, 2023, the tmi endpoint for obtaining a channel's list of chatters will be removed, Streamer.bot will be removing the afformentioned
%raiderNames%variable sometime in March with an update.
¶ New C# Methods
long TwitchGetBitsDonatedByUserId(string userId);
bool TwitchIsUserSubscribed(string userId, out string tier);
List<TwitchReward> TwitchGetRewards()
Structure of TwitchReward
public class TwitchReward
{
public string Id { get; set; }
public string Title { get; set; }
public string Prompt { get; set; }
public int Cost { get; set; }
public bool InputRequired { get; set; }
public string BackgroundColor { get; set; }
public bool Paused { get; set; }
public bool Enabled { get; set; }
public bool IsOurs { get; set; }
}
¶ Twitch Game Categories
Trying to manage the games.dat file was starting to get out of hand, so with v0.1.18, it is gone completely, and in its place, when selecting specific games, you're able to perform realtime searches against Twitch's own categories, so you'll always have the most current data moving forward.
Internally, because of this change, some methods were also updated to handle the data file no longer existing.
¶ Twitch Data
¶ Twitch Bit Donations
Starting with Streamer.bot v0.1.18, it will now keep a record of any bit donations that it sees, this means if something comes in when it is not open, it will never know it happened (since there is no way to get past data from Twitch on this).
The total amount that has been seen is also shown in the user's information in the UI
If you do a test event, this will be ignored and not added to whomever shows up for the test event.
¶ DonorDrive Updates
The DonorDrive integration now pulls a list of known charities from the DonorDrive api, and uses this for the different provider types now. This is mostly a quality of life improvement so you do not have to try and figure out the endpoint to use for a custom provider.
If the charity you are setting up, doesn't happen to be in the new list, you'll still be able to configure a custom provider
¶ New Sub-Actions
¶ Twitch Follower Count
This sub-action will get your current follower count
Variables available:
| Name | Description |
|---|---|
followerCount |
Your follower count |
¶ Twitch Latest Follower
This sub-action will get the last user that followed your channel
Variables available:
| Name | Description |
|---|---|
latestFollower.user |
The display name of the user that followed you |
latestFollower.userName |
The login of the user that followed you |
latestFollower.userId |
The ID of the user that followed you |
¶ Twitch Subscriber Count
This sub-action will get your current subscriber count and point total
Variables available:
| Name | Description |
|---|---|
subscriberCount |
Your subscriber count |
subscriberPoints |
The total number of subscriber points you have |
¶ Twitch Ban User
This sub-action will let you ban a user, you will be able to either enter in a specific user nname, or use a variable. You can also specify a reason, and use variables in this field
Variables available:
| Name | Description |
|---|---|
banResult |
True / False if the ban was successful |
These variables are only available if the sub-action was successful.
| Name | Description |
|---|---|
bannedUserId |
The user id of the user that was banned |
bannedUserName |
The user login of the user that was banned |
bannedUser |
The display name of the user that was banned |
¶ Twitch Unban User
This sub-action will let you unban a user, you will be able to either enter in a specific user name, or use a variable.
Variables available:
| Name | Description |
|---|---|
unbanResult |
True / False if the ban was successful |
These variables are only available if the sub-action was successful.
| Name | Description |
|---|---|
unbannedUserId |
The user id of the user that was banned |
unbannedUserName |
The user login of the user that was banned |
unbannedUser |
The display name of the user that was banned |
¶ Twitch UnTimeout User
This sub-action will let you ban a user, you will be able to either enter in a specific user nname, or use a variable.
Variables available:
| Name | Description |
|---|---|
banResult |
True / False if the ban was successful |
These variables are only available if the sub-action was successful.
| Name | Description |
|---|---|
unTimedOutUserId |
The user id of the user that was banned |
unTimedOutUserName |
The user login of the user that was banned |
unTimedOutUser |
THe display name of the user that was banned |
¶ Twitch Scopes
Requesting the following new scopes for the broadcaster account
moderator:read:followers
Requesting the following new scopes for the bot account, as they were missing or new
moderator:manage:banned_users
¶ Streamer.bot v0.1.17
Released 2023-01-20
- Fix some typos
- CPH Method, EnableTimer was not correctly resetting a timer
- SetTimerState sub-action was not correctly resetting a timer's line counts
- Regression, was not listening for Twitch Community Goal events
- Issue with collapsing all action groups
- Disable OK button in Set Argument sub-action dialog when loaded, so it gets validated properly
- Fix Twitch HypeTrain end event, was missing
%contributors%variable - Fix command group collapsing
- Fix initial collapsed states of Command Groups
- Fix initial collapsed states of Twitch Reward Groups
- Fix start raid C# method
- Twitch User IDs are now string across the entire application
- Twitch Channel Shield Mode EventSub events are out of beta, updated this internally
- Twitch Charity Donation event now includes the id of the donation, this has been added as a new arg
%donationId% - Updated Twitch
Add Target Infoto include tags - YouTube based events have a
%broadcastId%variable now - Events that add primary user information, now have a
%userPreviousActive%variable - StreamElements, linked the YouTube provider events
- Harden file saving routines
- Move Twitch Channel Reward counters to the twitch data db file
- Improvements to the auto-updater, cancellation support and timeout. NOTE This won't be useable until the next update.
- Disable and remove Twitch Coin Cheer events, since Twitch halted this experiment October 2022
- Enabled, Disable, Pause and Unpause Twitch Reward group context menu items no longer waits for each API call
- Update handling/broadcasting of Action start/completed
- Request new
moderator:manage:shoutoutsscope - Switch Twitch Shoutout Created event internally to new Twitch EventSub event
- Twitch Charity EventSub Events have been moved out of beta status
- Fix variables shown in the TipeeeStream tip event help button
- Wired up all the
?buttons forYouTubeevents
- Add 3 new C# methods to remove the cooldown of a command
- Add 3 new C# methods to Add To, Remove and Reset a user's cooldown that takes a string for the user id
- Add 3 new C# methods for handling adding, removing and checking if user is in group for string user ids
- Add new Websocket Event, ActionCompleted
- Ability to directly rename an Action Group, without having to edit every action
- Add filter to user permissions in Command Dialog
- Add 4 new sub-actions to Add, Remove, Clear and Set Twitch Tags
- Add 4 new C# methods to Add, Remove, Clear and Set Twitch Tags
- Add 2 new Twitch events, StreamOnline and StreamOffline
- StreamElements, add a new
%provider%variable to Tip and Merch events (can be twitch, youtube or streamelements) - StreamElements, add a new
%tipId%variable to the Tip event, this is StreamElements's internal tip id value - Add new C# method to get how many channel points a user has used, Twitch only
- Add new sub-action to clear users from a group
- Add new C# method to clear users from a group
- Add new argument to all actions,
%actionQueuedAt%, this is when the action was queued - Add 2 new sub-actions for resetting reward counts
- Add 4 new C# methods for resetting reward counts
- Add an Auto Type option to the Set Argument sub-action, if disabled, the value will be treated as a string
- Add ability to rename a Command group
- Add ability to rename a Twitch Reward group
- Add 2 new sub-actions to Set the Enabled and Paused state of a Twitch Reward group
- Add 6 new C# methods to set the Enabled and Paused state of a Twitch Reward group
- Add new sub-action to send a Twitch Shoutout, located under
Twitch->Moderation - Add 2 new C# methods to send a Twitch Shoutout
- Add new event for when you (the broadcaster) receives a Twitch Shoutout from another user
- Add 2 new sub-actions to Start and Cancel a raid on Twitch
¶ Websocket Events
¶ ActionCompleted
0.1.17 introduces a new Raw event, ActionCompleted. Subscribing to this event in the Websocket Server will get you information when an action is completed.
¶ New Sub-Actions
¶ Twitch Add, Remove, Clear and Set Channel Tags
Yes, Twitch finally added the ability to manipulate the new tags!
The Clear Channel Tags sub-action has no input, and will just clear your tags.
The Add, Remove and Set Channel Tag sub-actions all support variables.
The Add Target Info adds the following new arguments:
| Name | Description |
|---|---|
tagCount |
The number of tags |
tag# |
The tag at index position # |
tags |
A List<string>() object for use in C# |
tagsDelimited |
A comma delimited string of the tags |
At the moment, there is a bug in the Twitch Helix endpoint, where its unable to clear the tags completely. So for the time being Clear Tags and Removing the last tag will fail. Once Twitch fixes this, they should start working.
If you keep at least 1 tag active, you'll be able to add/remove tags at will. And for setting all tags, at least 1 needs to be set.
¶ Twitch Send Shoutout
This is a basic sub-action, either use a variable, or a fixed user login to send a shoutout to the user.
You may send a Shoutout once every 2 minutes, and to the same broadcaster once every 60 minutes.
¶ Clear Users From a Group
This sub-action will allow you to select one of your groups, so you can clear the users belonging to it during an action
¶ Twitch Start and Cancel Raid
Since the C# methods for this have existed for a bit, adding in sub-actions to perform this now as well.
¶ Updated Events
¶ Twitch Shoutout Created
With the Shoutout events being added to EventSub, this event has been moved from PubSub to EventSub, this unfortunately changes some of the variables. This Event has also been moved to the Moderation tab
Variables Removed
%targetUserPrimaryColorHex%%targetUserProfileImageURL%
Variables Added
| Name | Description |
|---|---|
viewerCount |
The number of users that were watching the broadcaster’s stream at the time of the Shoutout. |
cooldownEndsAt |
The DateTime of when the broadcaster may send a Shoutout to a different broadcaster. |
targetCooldownEndsAt |
The DateTime of when the broadcaster may send another Shoutout to the same broadcaster. |
¶ New Events
¶ Twitch StreamOnline and Offline events
For the new Twitch StreamOnline event, this will not be triggered if you are online and Streamer.bot connects to your Twitch account.
StreamOnline Event arguments
| Name | Description |
|---|---|
startedAt |
The date, time the stream went online |
game |
The category name |
gameId |
The category id |
tagCount |
The number of tags |
tag# |
The tag at index position # |
tags |
A List<string>() object for use in C# |
tagsDelimited |
A comma delimited string of the tags |
StreamOffline Event arguments
| Name | Description |
|---|---|
endedAt |
The date time when the stream went offline |
¶ Twitch Shoutout Received
With the new EventSub events for Shoutouts, Streamer.bot can now react to receiving a Shoutout
This event is sent only if Twitch posts the Shoutout to your activity feed.
Shoutout Received Event Arguments
| Name | Description |
|---|---|
%viewerCount% |
The number of users that were watching the from broadcaster's stream at the time of the Shoutout |
¶ New C# Methods
void CommandRemoveGlobalCooldown(string id);
void CommandRemoveUserCooldown(string id, int userId);
void CommandRemoveAllUserCooldowns(string id);
void CommandResetUserCooldown(string id, string userId);
void CommandRemoveUserCooldown(string id, string userId);
void CommandAddToUserCooldown(string id, string userId, int seconds);
bool UserIdInGroup(string userId, string groupName);
bool AddUserIdToGroup(string userId, string groupName);
bool RemoveUserIdFromGroup(string userId, string groupName);
bool TwitchClearChannelTags();
bool TwitchSetChannelTags(List<string> tags);
bool TwitchAddChannelTag(string tag);
bool TwitchRemoveChannelTag(string tag);
long TwitchGetChannelPointsUsedByUserId(string userId);
bool ClearUsersFromGroup(string groupName);
void TwitchResetRewardCounter(string rewardId);
void TwitchResetRewardUserCounters(string rewardId);
void TwitchResetUserRewardCounters(string userId, bool persisted);
void TwitchResetUserRewardCounter(string rewardId, string userId);
void TwitchRewardGroupEnable(string groupName);
void TwitchRewardGroupDisable(string groupName);
void TwitchRewardGroupToggleEnable(string groupName);
void TwitchRewardGroupPause(string groupName);
void TwitchRewardGroupUnPause(string groupName);
void TwitchRewardGroupTogglePause(string groupName);
bool TwitchSendShoutoutById(string userId);
bool TwitchSendShoutoutByLogin(string userLogin);
¶ Streamer.bot v0.1.16
Released 2022-12-31
- Starting Streamer.bot in a folder with uncommon characters should no longer cause a crash
- Fix handling of connetion retries for the Streamer.bot website
- Fix forget button for Streamer.bot Website integration, was forgetting wrong account
- Handle
Nullable<T>generics for generic global variable methods - Twitch Channel Follows, Channel Reward redemptions, and Hype Train completions were not being added to credits
- Gracefully handle errors related to invalid Donor Drive campaign IDs and Custom Endpoint urls
- Gracefully handle errors related to cleaning up Twitch EventSub subscriptions
- Some internal fixes to update download handling
- Setting an action to the TipeeeStream generic event, and deleting it would cause a crash
- Fix potential crash in Add Target Info sub-action when using variables
- StreamLabs, StreamElements, TipeeeStream and TreatStream test button no longer uses a random user, it now uses a fixed
Test Userfor tests. These 4 services do not do any username parsing - Some tweaks to Twitch Present viewer routines
- Some tweaks to shut down routines
- File/Folder Watcher changed event would crash when parsing as json
- C# Methods for controlling OBS Media State were wired up incorrectly
- C# Method ObsSetMediaSource was inverting a flag for local/url sources
¶ Streamer.bot v0.1.15
Released 2022-12-22
- Misc fixes/tweaks
- Testing OBS Raw should no longer crash if the call to OBS errors
- Twitch artificial present viewers tick could return YouTube users as well
- Double clicking on a Channel Reward when not connected to Twitch would cause a crash
- Double clicking in empty area, or headers in inspect variable dialog would cause a crash
- Right clicking in empty area, or headers in inspect variable dialog would cause a crash
- Add a check for OBS port being out of range
- Add a check for a possible null ref in loading 7TV emotes
- Fix being able to drag sub-action groups into groups
- First pass of networking code improvements
- Prevent channel reward costs from exceeding 2,147,483,647 points
- Fix possible crash when exporting actions
- Fix OBS Event dialog not validating correctly when editing an event
- Fix Quotes not being removed in the UI
- Fix Twitch Gift Sub Bomb test not using the correct anonymous check box
- Fix Anonymous Twitch Gift Bomb causing a silent crash
- Add the ability to change the avatar image for the Basic Discord Hook
- Update
CPH.TwitchRunCommercial(...)to return abool,Trueif it was successful,Falseotherwise - Add option to disable auto completion of braces and quotes in
Execute C# Codeeditor, default is enabled - Add
firstMessageargument toTwitch First Wordsevent - Update arguments for
Twitch First Wordsevent to be more like a chat message event since they are near identical - Update the Websocket message that is broadcast for a
Twitch First Wordsevent, this could be a breaking change - Discord Webhook sub-action now supports
%variables%for the Webhook URL, URL check is performed when sub-action is run now - Prevent empty messages, and messages longer than 200 characters from being sent to YouTube, they will be logged
- Prevent empty messages, and messages longer than 500 characters from being sent to Twitch, they will be logged
- Command settings have been split from the main settings file into their own file
- Twitch Account tab has a new look
- Split various Twitch services, so when one is disconnected, it won't bring them all down
- Lumia Stream Set Color sub-action now supports variables for the color
- Split auth tokens into separate file, reducing how often main settings is saved
- Convert globals file to new database file, this should be transparent for most users
- For twitch events that provide the user's color, if it is not set, do not add the color variable
- Added new library to make use of Twitch EventSub, a handful of events are moved over to this service now
- Some Twitch specific user data has been moved to its own database, this includes channel point rewards redeems and pyramid
creations/breakings. This will drastically lower the file size of the users.dat file - Twitch Rewards have been moved to their own data file
- Twitch Reward Configure sub-action, now sends calls all at once instead of waiting for results
- Some tweaks to Patreon events that come through the Streamer.bot website
- Tab order of Actions dialog and Twitch Channel Rewards dialog have been updated
- Show
<null>in the Inspect Variable dialog, when the value is null, instead of an empty space - Update visual display of Logic If sub-action, else will always show now
- Update Twitch Gift Sub Bomb test to send out gift subs that match the Gift Bomb event
- Still send Websocket message for Twitch gift subs that come from a sub bomb even if they're ignored
- Set Voice Control Command sub-action can now change any voice control command type, instead of
Anywhereonly - Update tab order for most dialogs
- Added the ability to use MIDI!
- Request new Twitch Scopes
- Add 3 new sub-actions for MIDI Out,
Note On,Control ChangeandGeneric - Batch request support for v5.x OBS Raw sub-action
- Add 3 new comparison options for
Logic Ifsub-action,Equals (Ignore Case),Not Equals (Ignore Case)andIs Null or Empty, data is assumed to be a string - Add an artificial Present Viewers tick to YouTube
- Add a setting to name your instance of Streamer.bot
- Add a
ConnectedandDisconnectedevent to an OBS Websocket Connection - Add option to
Execute C# Codeto save the result (true/false) to a variable - Add option to
Execute C# Methodto save the result (true/false) to a variable - Add option to disable logging of Voice Control dictation entries, this is now disabled by default
- New C# methods to start/cancel a raid
- Add 2 new Twitch sub-actions, Get Shield Mode Status, and Update Shield Mode Status
- Add 2 new Twitch Events, Shield Mode Start and End
- Refresh the Account tab for Twitch and Streamer.bot Integrations
- When inspecting variables in the Action History, you can now copy all variable names, and/or copy all the data as a text table
- A new menu layout for adding sub-actions, with a config option to use old style
- A way to favorite sub-actions to show in a Favorite Sub-action menu item (only applies to the new layout)
- Add a new Twitch Event, Ad Mid-Roll, this event typically fires 5s before an ad runs
- New Service Status indicator in the status bar of Streamer.bot
- Add a Decrement option to the Global (Set) sub-action
- Add header options to Fetch URL sub-action
- Add new setting to customize the color of a disabled sub-action
- Add new setting to customize the color of a comment sub-action
- Add color setting to comment sub-action to be able to override application default
- New Twitch sub-action Follow Mode, and C# Method
¶ MIDI Support
Yes, you read the correctly, as of Streamer.bot v0.1.15, there will be MIDI support!
¶ MIDI In
So, it will now be possible to run actions by using your MIDI Piano, and MIDI synth, oh, even your MIDI wind instrument, or anything that supports MIDI!
When adding an Event, you will be able to just press the key, turn the knob, or flick the wheel to have it auto populate all the settings for you.
This section is a WIP for information, but to get you started, here are some screenshots.
Add a new MIDI In device
Add a new MIDI event
Editing a MIDI event
To get started with MIDI follow these steps:
- Add a Device, to do this, right click in the top section of the MIDI tab, and click Add
- Pick your device from the drop down, and give it a name, and click Ok
- Select the device you just added
- Right click anywhere in the bottom list, and Add an event.
- With the Add Event dialog open, you can press any of the keys on your device to have it fill in all the data for you and show an example of what the arguments will look like.
¶ MIDI Out
The other side of MIDI, being able to send MIDI events out to your devices or DAWs.
Much like MIDI In, you create a device mapping within Streamer.bot, and you can use 1 of 3 new sub-actions to send MIDI events.
¶ New Twitch Broadcaster Scopes
channel:manage:raidschannel:read:hype_trainchannel:read:goalsmoderator:manage:shield_mode
¶ Twitch EventSub
Twitch updated there eventsub to support websocket connections, so after trialing it for a bit, I have added a new library to connect to this new service, and subscribe to various events.
¶ Events that are now on EventSub
- Twitch Poll Events
- Twitch Prediction Events
- Twitch Channel Reward Events
- Twitch Follow Event
- Twitch Hype Train Events
- Twitch Charity Events (improved and some new)
- Twitch Channel Goals (new)
- Twitch Shield Mode (new)
¶ Twitch Charity Events
Despite there already being support for Twitch Charity Donate, switching over to EventSub has introduced 3 new events (Started, Progress and Stop), as well as update the Donate event with more data.
¶ Twitch Channel Goals
These are the goals you can configure, new follower goal, subscription goal, etc. Now you can get udpates on these by way of 3 new events, Goal Begin, Goal Progress and Goal End
¶ Twitch Hype Train Events
The hype train events have been altered slightly, and are no longer restricted to 5 levels, they can go on forever now. The calculations for % complete have also been tweaked and hopefully are more accurate now.
¶ Twitch Channel Reward Events
These events mostly remain unchanged, there is a slight re-organization of data, but is ver minimal.
¶ Twitch Shield Mode Events
There are 2 new events for Twitch's Shield Mode, Begin and End. You can assign actions to these and have your stream react when your Shield Mode is enabled/disabled.
¶ Twitch Prediction and Poll Events
Largely remain unchanged from the previous events.
¶ Service Status
With Streamer.bot v0.1.15 you can see, at a glance, if all your services are connected.
In the bottom right hand corner of Streamer.bot, there is now an indicator that shows if you're connected to your services. If you click on this, you'll be presented with a detailed list of what is all connected, and, you can click on any of the services to be taken to the settings page for it.
¶ New Sub-actions
¶ Twitch Follow Mode
Turn follow mode on, or off with the new sub-action, or by the new C# method
¶ MIDI Out Sub-Actions
- Control Change
- Note On
- Generic Event
¶ New C# Methods
There is no way, by API to send a raid yet, can only create, and cancel a raid
bool TwitchStartRaidById(string userId);
bool TwitchStartRaidByName(string userName);
bool TwitchCancelRaid();
void TwitchFollowMode(bool enabled = true, int duration = 0);
¶ OBS Websocket v5.x Batch Requests
You can now perform batch requests to a v5.x obs-websocket with OBS Raw
{
"haltOnFailure": false,
"executionType": -1
"requests": [
{
"requestType": "<string>",
"requestData": { ... }
}
]
}
| Name | Description |
|---|---|
haltOnFailure |
True/False, setting to true will stop processing requests if one fails, default is False and can be omitted |
executionType |
A number value, -1, 0, 1, 2 to indicate how to perform the requests, default is -1 and can be omitted |
requests |
This is the array of your requests, each request takes on the same format as a single request |
¶ Streamer.bot v0.1.14
Released 2022-10-27
- Typos
- Blocking state of a queue was not updating visually
- OBS Take Screenshot sub-action was halting an action when used with OBS websocket v5
- Lumia Stream Send Command sub-action dialog would crash if there are no commands
- Lumia Stream disconnect button would not work
- Lumia Stream Set Color sub-action dialog could possibly crash
- Catch exceptions thrown by speech recognition initialization, log and try to be more graceful about it
- Handle potential crash with an internal Users Joined event, when an API call failed
- Small startup improvements
- Twitch Add Target Info should have the correct VIP/Subscriber boolean values now
- Some Twitch API calls weren't being routed through proper internal calls, causing tokens not to be refreshed as needed
- Some potential crashes in obs-websocket 5 data handling (there may still be more unfortunately)
- Lumia Stream set color sub-action should correctly pickup manual changes to the color field now
- Custom Websocket Server would crash when using an invalid address
- File/Folder watcher was not updating the filter correctly when changed
- Some logging was not behaving correctly, should behave now
- Some error may be caught properly now, and longer full crash Streamer.bot
- DoAction and C# RunAction should now create a new argument dictionary when not running immediately, no longer sharing it
- CTRL+D shortcut on sub-actions will now duplicate a group correctly
- VoiceMod Set Background Effect State should work correctly now
- C# method SetChannelGame should no longer throw an exception when used
- Comment sub-action should behave correctly now (no longer disappearing, or moving around on its own)
- Forgetting Twitch broadcaster account forgot bot account (woops)
- Stop saving config when a channel reward is updated
- Fix File/Folder watch init to check for existence of folder
- New Twitch Scopes requested for both broadcaster and bot accounts
- Add new C# method,
CPH.ObsTakeScreenshot - Twitch commands have a new argument,
%msgId%which is the id of the message - Remove caret from Twitch username text boxes, so there's no indication you should type in them
- Remove caret from YouTube username text boxes, so there's no indication you should type in them
- Updates to LumiaSDK, hopefully its a bit more stable and working better
- Twitch Whisper has been updated to use the new API, this is part of a change away from slash commands being deprecated
- C# method for sending a whisper on Twitch, has been updated,
bool SendWhisper(string userName, string message, bool bot = true) - Internally, update various methods to use API calls, instead of IRC commands, as these are being deprecated
- Update internal methods for adding/removing moderators/VIPs to use API calls
- Update internal methods for deleting a chat message, to use API call
- Read Random Line from file sub-action now includes the line number as a variable,
%randomLineNumber#% - MathParser-mXparser updated to v5.0.7
- Updated Google YouTube C# Libraries to current
- Twitch sub-action Set Channel Game, now adds game variables if you've picked a game from the list
- Streamer.bot's built in websocket server can now listen on any address, just enter
*for the ip address - Custom websocket servers can now listen on any address, just enter
*for the ip address - Since Hosts are going away soon on Twitch, they have been removed from Streamer.bot
- Better handling of Twitch disconnects, this is part of ongoing improvements
- Timed Action line counts now support YouTube chat, at the moment, line counts work for either service, if you have both connected, line counts will not be used
- Update endpoint used to get a users current chatters to the new GetChatters API
- Decrease present viewers tick to 1 minute, with the change to the new GetChatters API
- Remove LootDevil support, as they closed down
- Wrap sub-action handling within an action in a try/catch, to catch generic exceptions, this will also halt an action
- Performance improvements when handling large amounts of viewers
- Performance improvements when connecting to Twitch
- Disable verbose logging on Twitch Bot Account
- Stop saving config when a channel reward is updated
- Forgetting broadcaster account forgot bot account (woops)
- Add more verbose logging
- Changes to the Twitch Present Viewer Tick
- Updates to File/Folder watch to show error if you try to enable a watcher with a missing folder
- Move Twitch timeout and ban events to use PubSub events, this provides who, as well as reason in addition to existing data.
- Updated line count handling for Timed Actions, this is no longer a debounced event, it should happen as the line counts increase. This may change depending how it behaves with performance.
- Add some checks when using
Set Reward TitleandReward Updatesub-actions to prevent setting titles longer then 45 characters, and prompt longer then 200 characters
- Streamer.bot now has an Auto Updater!
- Add a new menu item for OBS connections that lets you assign ALL OBS related sub-actions to that connection
- Add a new OBS Set Color Source Color sub-action and C# methods
- Request new scope
whispers:readon bot account, you will need to re-authorize your bot account - Add new CPH method for logging
LogVerbose(string logLine) - Add new CPH method for LumiaStream
LumiaSetToDefault() - Add new CPH method for LumiaStream
LumiaSendCommand() - Add new event for Twitch, Bot Whisper, can now react to whispers the bot account receives
- Add new command source Twitch Bot Whisper, can now react to whispers the bot account receives
- Add new CPH method for taking a screen shot in OBS, the source can be either a source, or a scene
- Add a new sub-action,
OBS->Get Status to add OBS status information - Add a new sub-action,
Twitch->Add Viewer Count to add your current Twitch viewer count as a variable - Add new CPH methods for adding/removing moderators/VIPs
- Add internal method for clearing chat using API call
- Add new CPH method for clearing chat,
bool TwitchClearChatMessages(bool bot = true) - Add new CPH method for deleting a chat message,
bool TwitchDeleteChatMessage(string messageId, bool bot = true) - Add new CPH methods for banning/unbanning and timing out a user
- Add new CPH method for checking if an action exists, or if its enabled/disabled
- Support for Twitch Charity, with 2 new events, Donation and Completed
- Add new sub-action to fetch the latest Twitch Charity Campaign
- Support for Coin Cheer (this is experimental and could break)
- Support for Shopify Webhooks!
- Add new sub-action Discord Basic Webhook, to enable posting basic text to a discord webhook
- Add new CPH method,
DiscordPostTextToWebhookto post text to a discord webhook - Add new event for Twitch, Shoutout Created, this is triggered when the
/shoutoutcommand is used, if your channel has the ability - Added option to enable/disable present viewer tick, default disabled
- Added option to change present viewer tick from 1 to 10 minutes, default of 5 minutes
- Added new context menu item for actions to set their queue
¶ Auto Updater
With version 0.1.14, the ground work has been put in to include an auto updater, which means, this is the last version that will require you to manually update. Moving forward, starting with version 0.1.15, you will be able to update within Streamer.bot itself.
If you have been using the recent betas, or are part of alpha testing, you've already been giving this feature a try!
When you launch Streamer.bot it will perform a check to see if there is an update, and if there is, you will see a screen pop-up similar to the one below.
After you click Download, and the update is downloaded, you will be able to install the update by clicking on Install
As you can see, there are update channels, stable, beta, alpha. By default everyone will be on the stable channel, which are the public releases.
To be able to select any other update channel, you will need to have Streamer.bot connected to the website, under Integrations, and have the appropriate roles in the Discord.
¶ New Twitch Broadcaster Scopes
channel:read:charitymoderator:manage:chat_messagesmoderator:read:chatters
¶ New Twitch Bot Scopes
moderator:manage:chat_messages
¶ Twitch Present Viewer Tick
I have gone through and changed how the present viewer tick operates, it is still possible to have the same behavior as 0.1.12, so continue reading.
The present viewer tick will always happen, but you now have the ability to have it "live update" from twitch, or artificially mark someone as present.
Under the Present Viewer action selector, there are 2 new setttings, a Live Update check box, and a slider bar.
When Live Update is checked, the slider next to it is how often this update will occur, between 1 and 10 minutes, this will also still execute the action at this interval.
When Live Update is not checked, the slider next to it behaves as a threshold. The timer runs every minute, and checks the current time minus the user's last active time, if this is less then the threshold, they are marked as present, otherwise they are marked as not present. The action will still be executed, but, it will occur every minute.
The default setting is Live Update not checked, and the slider set to 5 minutes. To have the same functionality as 0.1.12 and earlier, enable Live Update and make sure the slider is set to 5 minutes.
¶ Twitch Charity
The newly released Charity feature of Twitch is now supported within Streamer.bot
This introduces 2 new events, Donation and Completed
¶ Twitch Timeout and Ban Events
Switching these events to use the data that comes from PubSub, they may happen quicker, as well, more variables are available.
Both the ban and timeout events gain the following variables
| Name | Description |
|---|---|
createdAt |
The date and time the ban or timeout was created |
createdById |
The Twitch ID of the user who created the ban or timeout |
createdByUsername |
The user name of the user who created the ban or timeout |
createdByDisplayName |
The display name of the user who created the ban or timeout |
reason |
The reason for the ban or timeout |
¶ Donation Event
The donation event occurs when someone has donated to your charity.
Variable that are included are as follows:
| Name | Description |
|---|---|
baseAmount |
The amount of the donation as a whole number |
donationAmount |
The amount of the donation in decimal form |
charity.name |
The name of the charity you are supporting |
currency.code |
The 3 letter ISO currency code |
currency.exponent |
Divide base amount by 10 to the power of this number to get the decimal value |
Twitch is providing amount values for Charity calls as whole numbers, so $42.00 will return as 4200.
¶ Completed Event
When donations come through, a check is made if your current donation amount matches what your goal is, and will send a completed event if this is true.
Variable that are included are as follows:
| Name | Description |
|---|---|
charity.id |
Twitch's internal ID for your campaign |
charity.timestamp |
The timestamp of the event |
charity.currency |
The 3 letter ISO currency code |
charity.donationTotal |
How much you have raised so far, asa whole number |
charity.goalTarget |
Your campaign's target amount as a whole number |
Twitch is providing amount values for Charity calls as whole numbers, so $42.00 will return as 4200.
¶ Twitch Shoutout
Twitch recently added, as a beta feature a new /shoutout command, so for those users who have this on there channel, you can now react to when you, or a moderator uses this command, and treat it like a !so chat command!
The user who was given the shoutout will be contained in the target* variables.
Available variables:
| Name | Description |
|---|---|
shoutoutId |
Twitch's internal ID for the shoutout |
targetUserId |
The user's id |
targetUserLogin |
The user's login name |
targetUserDisplayName |
The user's display name |
targetUserPrimaryColorHex |
The user's primary color in hex |
targetUserProfileImageURL |
The user's profile image |
¶ Shopify
By using the Streamer.bot website, you can now add webhooks to your Shopify store front!
Supported webhook events include
Order creationandOrder payment
There are 2 new events within Streamer.bot that you can associate an action with, Order Createdand Order Paid. Both of these events will provide you with almost all the information that is provided by the webhook.
The best way to check the variables, is to setup your webhooks, and assign an empty action, then check the available variables in the Action History tab under Action Queues
¶ New Sub-actions
¶ OBS Set Color Source Color
Added a new sub-action that lets you set the color of a color source within OBS. All fields support %variable% replacement, and there is an option to just set a random color.
¶ OBS Get Status
This will add up to 3 new variables to your action for the selected OBS connection.
| Name | Description |
|---|---|
isConnected |
Boolean value indicating if the selected OBS connection is connected True/False |
isStreaming |
Boolean value indicating if the selected OBS connection is streaming True/False |
isRecording |
Boolean value indicating if the selected OBS connection is recording True/False |
¶ Twitch Add Viewer Count
This will let you add your current Twitch viewer count as a variable to your action.
This value is only updated every 30 seconds
| Name | Description |
|---|---|
viewerCount |
Your current Twitch viewer count |
¶ Twitch Get Latest Charity Campaign
This sub-action will fetch your latest Twitch Charity campaign and add the information as variables.
| Name | Description |
|---|---|
campaignId |
Twitch's internal ID for your campaign |
charity.name |
The name of the charity you are supporting |
charity.description |
The description of the charity you are supporting |
charity.logoUrl |
The logo of the charity you are supporting |
charity.websiteUrl |
The website to the charity you are supporting |
currentAmount |
How much you have raised so far, asa whole number |
targetAmount |
Your campaign's target amount as a whole number |
Twitch is providing amount values for Charity calls as whole numbers, so $42.00 will return as 4200.
¶ Discord Basic Webhook
This is the first of a few new Discord specific sub-actions that will be added. Up first is a friendlier way to post to a webhook you setup in your discord. This one only allows for basic text posting.
Username, content, and image can contain variables and will be parsed.
Username, and image are also optional
¶ New C# Methods
Add the following new C# methods
¶ Logging
void LogVerbose(string logLine);
¶ Twitch
bool SendWhisper(string userName, string message, bool bot = true);
bool TwitchAddModerator(string userName);
bool TwitchRemoveModerator(string userName);
bool TwitchAddVip(string userName);
bool TwitchRemoveVip(string userName);
bool TwitchClearChatMessages(bool bot = true);
bool TwitchDeleteChatMessage(string messageId, bool bot = true);
bool TwitchBanUser(string userName, string reason = null, bool bot = false);
bool TwitchUnbanUser(string userName, bool bot = false);
bool TwitchTimeoutUser(string username, int duration, string reason = null, bool bot = false);
¶ OBS
bool ObsTakeScreenshot(string source, string path, int quality = -1, int connection = 0);
void ObsSetColorSourceColor(string scene, string source, int a, int r, int g, int b, int connection = 0);
void ObsSetColorSourceColor(string scene, string source, string hexColor, int connection = 0);
void ObsSetColorSourceRandomColor(string scene, string source, int connection = 0);
¶ Lumia Stream
void LumiaSendCommand(string command);
void LumiaSetToDefault();
¶ Actions
bool ActionExists(string actionName);
¶ Discord
bool DiscordPostTextToWebhook(string webhookUrl, string content, string username = null, bool textToSpeech = false);
¶ Twitch Whisper
Some important notes with how Twitch Whispers appear to be handled now, this is a copy from the Twitch development documentation.
The user sending the whisper must have a verified phone number (see the Phone Number setting in your Security and Privacy settings).
The API may silently drop whispers that it suspects of violating Twitch policies, it will still indicate success even if the message is dropped.
Rate Limits: You may whisper to a maximum of 40 unique recipients per day. Within the per day limit, you may whisper a maximum of 3 whispers per second and a maximum of 100 whispers per minute.
The maximum message lengths are:
- 500 characters if the user you're sending the message to hasn't whispered you before.
- 10,000 characters if the user you're sending the message to has whispered you before.
Messages that exceed the maximum length are truncated.
¶ Streamer.bot v0.1.12
Released 2022-08-31
This is a hotfix release
- OBS Websocket 5.x source visibility sub-action was not working, when the source is in a group
- OBS Websocket 4.9.x, issues with deserialization of a few calls
- Silent crash in OBS Hide Group's Sources
- Potential crash in OBS group related sub-actions, if group no longer exists when editing
¶ Streamer.bot v0.1.11
Released 2022-08-31
- Commands in an import will be disabled by default, this is more of a security precaution
- Action updates were not properly being sent to the Streamer.bot website for decks
- Pyramids not resetting correctly if a single emote is used after a previous single emote
- Twitch Reward Set Global Cooldown sub-action, properly lists rewards now
- Crash when using Ctrl+C on a group in an action
inputUrlEncoded#variables to actually be the word, and not the entire message for each one- Get Team Info For Target silently crashing
- Better handling for the Twitch Get Present Viewers tick, optimizations to limit potential API calls
- OBS Raw sub-action was not saving the prefix
- Silent null ref crash for timed actions when Twitch is not connected, should be completely decoupled now
- Twitch GiftSubs from a GiftBomb were being counted twice in the sub-counter
CPH.RunActionproperly checks if an action is enabled when trying to run it
- New Twitch scopes requested
- Twitch Announcements have been updated with the new endpoint and scope, can send announcements in all colors now
- Extend First Chat event to YouTube
- Some updates to how YouTube streams are found, this is still very much a WIP and more fixes will come
- Auto strip newline and whitespace at the end of an import string when pasting
- Remove Bits from Twitch Polls, as it's being removed outright by Twitch
Execute C# Codesub-action will now warn if you try to close it by the X and you have unsaved changes- Inspect variables dialog saves its size now when closed
- Right click context menu on cells in the inspect variable dialog to copy the data, as text, to your clipboard
- Double clicking on a cell in the inspect variables dialog will copy the value, as text, to your clipboard
- OBS Websocket v5.x Support
- Added new variable
%wsIdx%to WebsocketClient action arguments, which is the index of the client, 0 based, -1 if not found - Added new variable
%wssIdx%to CustomWebsocketServer action arguments, which is the index of the server, 0 based, -1 if not found - Added new variable
%wssId%to CustomWebsocketServer action arguments, which is the ID of the websocket server - Add new VoiceMod sub-action to play a soundboard sound
- Add new VoiceMod sub-action to stop playing all VoiceMod sounds
- Regex commands will now add match group values as arguments,
%match[#]%, as well as named match groups, if you're using?<groupName>in your regex - Lumia Stream integration!
- New sub-action Send Command for Lumia Stream
- New sub-action Set Color for Lumia Stream
- New sub-action Set to Default for Lumia Stream
- New integration, Loot Devil
¶ OBS Websocket v5.x
Support for OBS Websocket v5.0 comes to Streamer.bot v0.1.11. For the most part this is a transparent change for users, just edit your OBS Websocket within Streamer.bot and change to v5.x.
Unfortunately, the OBS Raw sub-action will not work between v4.9.x and v5.x; the methods to obtain and set information are incompatible. Even having a translation layer on this leaves too much to chance and likely have the wrong output.
OBS Raw Sub-action will not be compatible between the 2 versions
More information on upgrading your OBS Raw sub-actions will be forthcoming.
The new OBS Raw format for OBS Websocket v5.x is the following:
{
"requestType": "request method",
"requestData": { ... }
}
¶ Get Scene Item Properties Sub-Action
A quick note about this sub-action, while I tried to keep data structures the same between the 2 versions, the data for this one unfortunately changed. There is now a common format for the data
{
"name": "name",
"itemId": 0,
"visible": true,
"locked": false,
"transform": {
"alignment": 0,
"boundsAlignment": 0,
"boundsHeight": 0.0,
"boundsType": "string",
"boundsWidth": 0.0,
"cropBottom": 0,
"cropLeft": 0,
"cropRight": 0,
"cropTop": 0,
"height": 0.0,
"positionX": 0.0,
"positionY": 0.0,
"rotation": 0.0,
"scaleX": 0.0,
"scaleY": 0.0,
"sourceHeight": 0.0,
"sourceWidth": 0.0,
"width": 0.0
}
}
¶ Lumia Stream
Streamer.bot gains another integration, Lumia Stream! You can now connect to Lumia Stream and set light colors from within Streamer.bot
¶ Loot Devil
Some have been asking for it, well now it's here, you can connect Loot Devil to Streamer.bot now! To use this, requires the use of the Streamer.bot website to configure the web hook, and connecting the application to the website to receive gifting events.
¶ Twitch New Scopes
When you connect with your broadcaster account, the following new scopes will be requested
moderator:manage:announcementschannel:manage:moderatorschannel:manage:vipsuser:manage:whispers
When you connect with your bot account, the following new scopes will be requested
moderator:manage:announcementsuser:manage:whispers
¶ Streamer.bot v0.1.10
Released 2022-06-24
- An issue with authentication for some integrations
- Crash when an else action in an if/else sub-action is not set on export
- Display of if/else sub-action
- Weighted sub-action option was not being shown correctly, and will also show but be disabled if random is disabled for action or group
- Visual indicator of how many actions/commands are checked updates properly now
- Able to type a reason in the Twitch Timeout sub-action now
- No longer soft errors when getting bits leaderboard, this was not breaking anything
- Updated UI for Gift Subs to avoid confusion, ranges are gift sub milestones for the gifter
- Gift Sub and Gift bomb test events when anonymous should work now
- Importing/Exporting commands clears the persistent counters
- Add a hard limit of how many items are shown in Actions pending/history
- Better handling of primary config on startup and alert if issue detected
- Remove unused check box, Use Bot Account for Messaged in Twitch Accounts tab
- Add new option for high volume actions to not be included in Action Queue display
- Added 2 new properties to
CPHclass to get the Twitch Client ID, and the Broadcaster's access token - New Twitch event Ad Run
- Add context menu item for commands to reset counters
- Save the UI positioning of the Action/SubAction list in the Actions tab
¶ New C# Properties
Added the ability to get Streamer.bot's Twitch Client ID by using CPH.TwitchClientId, and the broadcaster's access token by using CPH.TwitchOAuthToken
I will not be adding the same capability to the YouTube information, since there are quotas involved.
¶ Twitch Ad Run Event
There is a new event that will be triggered when an ad is run on your channel.
This event may get some tweaking over time as I can gather more data
| Name | Description |
|---|---|
%adLength% |
The length of the ad in seconds |
%adScheduled% |
If this ad was a scheduled ad |
¶ Streamer.bot v0.1.9
Released 2022-06-16
- Obligatory misc fixes
- Updating some tooltips
- PlaySound sub-action Test button being disabled when editing an existing sub-action
- Updated import/export to properly handle Get/Set Action State sub-action
- Context menu for Twitch user crashing when clicking ban
- Gracefully handle authentication error with OBS websocket
- Editing a Queue name did not update in the list of Queues
- Prediction badges would cause a silent crash, essentially causing Streamer.bot to no longer react to chat
- Handle potential crash in Add Target Info sub-action
- Handle potential crash when banning an already banned user from context menu
- Potential crash when connecting to Twitch account
- Adding/deleting range actions to properly clear the action selection button
- Twitch forget broadcaster/bot account buttons finally work properly
- Streamlabs Desktop should work again, my bad on missing this for 0.1.8
- Update Twitch Predictions to support up to 10 outcomes, new C# method as well
- Support new YouTube gifting events
- Add a context menu to the Export dialog action list, to select all actions, and all commands
- Rename Broadcasters tab to Stream Apps, to avoid any confusion
- Remove deprecated scope and update to current, this will cause a re-authentication for the Broadcaster account
- Can open multiple instances of Streamer.bot from different folders
- YouTube Super Chat and Super Sticker events have been updated to have range based actions
- Added new context menu item to collapse/expand all groups in commands list
- Pulsoid heart rate event now has ranges
- HypeRate heart rate event now has ranges
- Increase variable length limit to 64 characters (to handle some obsRaw variables that can parse quite long)
- Add a prefix setting to ObsRaw, to be able to customize the variable used for storing the results
- Twitch Bot account was missing
channel:moderatescope, you will need to re-auth this account. - Add new option to file/folder watcher to include subdirectories
- Logic If sub-action now has an else condition, and is hence forth known as the Logif If/Else sub-action
- Twitch Reward C# methods were updated
- Add new Send Announcement to Channel sub-action to send a /announce to your channel
- Add Ctrl+C and Ctrl+V shortcuts for sub-actions to copy pasta.
- Add new Get Reward Info sub-action to add information about a Twitch reward to arguments
- Set default sort order for action queues, and save column widths and sorting on save/close
- Add new event for Twitch Announcements
- Any service that requires you to connect your account, will now timeout after 60 seconds if you close the browser, so you can try again
- Added a save button to the Execute C# Code sub-action when you edit it, this will allow you to save without closing the dialog
¶ New C# Methods
void TwitchAnnounce(string message, bool bot = false, string color = null);
Even though the color parameter is present, currently, due to a Twitch limitation, only null is supported, this will use the default announce command. When Twitch fixes this, supported values will be
blue,orange,green,purple
string TwitchPredictionCreate(string title, List<string> options, int duration);
¶ Updated C# Methods
¶ Twitch Reward C# Methods
The following methods have had there return value changed from void to bool, to indicate success or failure.
bool UpdateRewardTitle(string rewardId, string title);
bool UpdateRewardPrompt(string rewardId, string prompt);
bool UpdateReward(string rewardId, string title = null, string prompt = null, int? cost = null);
Any use of these methods should be uneffected, as calling without using the bool is the same as calling a void method, the result is just thrown away
¶ Updated Sub-actions
¶ Logic If/Else
The Logif If/Else sub-action got a bit smarter, you can now have an else condition.
¶ New Sub-actions
¶ Send Announcement to Channel
With this sub-action you can send an /announce to your channel. While there is a drop down to pick the color, this is disabled on purpose, as the color specific commands currently do not work outside of the main Twitch chat. Once this is enabled on Twitch's side, I will enable this dropdown
Due to a Twitch limitation, only the default announce command is currently supported. When Twitch fixes this, the other colors (
blue,orange,green,purple) will be supported.
¶ Get Reward Info
This sub-action will add information about the selected reward to the arguments
¶ Streamer.bot v0.1.8
Released 2022-06-01
- Misc fixes
- DonorDrive profile updated event was sending wrong websocket event type
- Updated the Action picker to show better message when there are no actions
- GetActionGroupState sub-action was configured wrong, also a settings upgrade to correct any existing sub-actions
- ObsSetReplayBufferState was starting/stopping stream, not the buffer
- ObsSetReplayBufferState had incorrect states
- Removal of channel reward from the UI should be working correctly now
- Get/Set Command State sub-actions would cause a crash if there are no commands
- Set Reward Cooldown sub-action would crash if no Twitch auth data was present
- OBS Set Audio Track state would toggle when explicitly setting active, this is a bug in obs-websocket 4.x, workaround applied
- The file selection button in the OBS Take Screenshot sub-action now works
- Date calculations for Follow Age Info sub-action are now correct
- Twitch Sub-Counter should no longer cause crashes if file/path is not found
- Can no longer rename a group to an empty string
- ObsSourceMute C# methods had an extra unused parameter, this has been removed
- OBS SetMediaSourceFile sub-action was not parsing scene and source names
- OBS SetImageSourceFile sub-action was not parsing scene and source names
- How play not found option works, was stopping the sound even if you were playing via default device
- Group collapsing for Actions
- Sub-action dragging to groups
- Max length for importing actions, there was a 32kb hard limit on the text box, it is now int.MaxValue
- Vorbis library updated
- Read Random Line sub-action now has a count option, this will add however many lines count is, removing the need to add multiple sub-actions
- Update Twitch Timeout sub-action to be able to include a reason
- Some tabs related to specific Twitch features have been moved under the Twitch tab
- All streaming platforms have been moved to there own combined top level tab
- All broadcasting software tabs have been moved to there own combined top level tab
- All integrations have been moved to there own combined top level tab
- Commands have a new variable available,
%commandId%which contains the ID of the command that was triggered, this applies for a cooldown action as well. - Added a new variable
%userType%, this will be present for any actions that adds user information to the arguments - Broadcaster information and random users will no longer be added to every action, this is replaced by sub-actions for the various streaming services
- Add Target Info got a new target source, Broadcaster, which will add the broadcasters extended information to the arguments
- Requesting new scopes for your Twitch account
- Some updates to the Sub-action context menu, slightly different behaviour and updated text
- Move some Twitch classes to a common library for better use within C# code, this may cause some breaking changes
- StreamElements now uses OAuth to access the service, you no longer need to enter your JWT token.
- File Watcher has been updated to support folder watching with filename filters
- Cleaned up how Tabs can me moved around and hidden, right click on a tab to bring up a context menu if they can be hidden
- Rename SLOBS to Streamlabs Desktop throughout the app
- Under the hood, actions have been moved to there own data file
- Minor tweaks to the way settings files are saved
- Export Actions list is now sorted alphabetically
- Remove big Twitch Connect button
- Action importing handles Execute C# Code sub-actions a bit better now, and is more intelligent on how references are handled
- Various libraries updated
- Change default options when creating a Wasapi device for the default device, now matches specific device creation
- Alter how device selection works when overriding device in Play Sound and Play Sound from Folder sub-actions
- Moved save button to a toolbar at the top of the main window
- Moved import/export to buttons on the toolbar, and removed them from the actions context menu
- Add Twitch First Time Chat indicator, there is a new argument for messages
%firstMessage%, this is a boolean, true or false - Wildcard can be used when subscribing to websocket events
- New sub-action Add Team Info, can get team information for a user
- ObsRaw has a new option to not add return data to the argument stack; the raw JSON will still be added. This defaults to true to prevent breaking of existing actions
- New sub-action Obs Hide Scene Sources and C# method to hide all the sources of a scene, this is the same behaviour as Obs Hide Group Sources, except for scenes.
- New sub-action Obs Set Random Scene Source Visible and C# method to set a random source in a scene to visible, this is the same behaviour as Obs Set Random Group Source visible, except for scenes.
- Provided as a 64-bit build
- YouTube has been added and is currently a WIP and is being tested.
- Added a new C# method to run an action by it's id
RunActionById(string actionId, bool runImmediately = true) - New sub-action Add Broadcaster Information, to add the broadcaster's information to arguments
- New sub-action Add Random Users, to add a specific number of random Twitch users to the arguments
- Parse the subscription length from Twitch messages and pass that information forward, will be added as
%monthsSubscribed%if it is greather then 0 - Sub-actions can now be enabled/disabled, disabled sub-actions are marked as red in the list
- Added new C# methods
- Now parsing the badge-info tag from Twitch chat, and passing the subscriber duration along
- The
Ignore Botflag for commands now takes into account if the bot account is the same as the broadcaster account and does nothing instead of ignoring, applies to Twitch only - VoiceMod integration! Control VoiceMod from Streamer.bot
- Direct Pulsoid integration
- Direct HypeRate integration
- OBS Connections can be flagged as default, and/or forced.
- New sub-action Set Voice Control Command State to set the state of a Voice Control Command
- New sub-action Set Voice Control Command to set the command of an anywhere type Voice Control Command
- Integration with PolyPop
- Messages sent via the broadcaster to twitch are now looped back to itself with emote parsing in tow
- Twemoji parsing for Twitch messages, this will parse Unicode emotes to images
- Broadcaster information is auto added for certain events where a source is known
- A new authorization success page will show, instead of a single line of text
- Twitch/YouTube message sub-actions support multi-line, dialogs have been updated as well
- Add new GetBroadcaster request to websocket
- Add new GetBroadcaster endpoint to http server
- Add new Broken event to Pyramids
- New event for StreamElements, Merch, trigger actions from merchandise purchases
- Action Queues, you can now see actions running in realtime, and see a history of them
- Streamer.bot Website integration
- Integration with Kofi
- Integration with Patreon
- Added C# Compiler settings, specifically, you can add common references that will be included with all Execute C# Code sub-actions
- Custom C# libraries used as references, can now be places in a dlls subfolder
- Added the StreamElements merch event
- Twitch Badges are now parsed and added as arguments for relevant events
- Integration with TipeeeStream
- Integration with TreatStream
- Added new Log sub-action, to allow logging from within an action
- Execute C# Code window sizing is saved now, it will open at the last used size
- Add selected file information to arguments for Play Sound from Folder sub-action; %randomSoundFile% contains the full path of the file and %randomSoundFileName% contains just the file name
- Commands can be imported/exported along side actions
- In Execute C# Code window, you can right click to copy the compile log to clipboard
- Add filtering to Actions list, this will only filter on the action name at the moment
- Add filtering to Commands list, this will only filter on the command at the moment
- Add filtering to Action selection dialog, this will only filter on the action name at the moment
¶ YouTube Integration
Probably one of the most requested features has finally been added, more details will be added to this section over the next few days.
You'll be able to authorize with your YouTube account, and monitor chat, giving you the ability to react to chat messages, super chat, super stickers and more!
More information will follow!
See YouTube for information on how to get started!
¶ 64-bit Build
Moving forward, Streamer.bot will be offered in a 64-bit build, as opposed to a 32-bit build. This opens up the ability to interface with more librariries and tools using the integrated C# capabilities.
¶ Twitch New Scopes
When you connect with your broadcaster account, the following new scopes will be requested
moderator:manage:banned_usersmoderator:read:blocked_termsmoderator:manage:blocked_termsmoderator:manage:automodmoderator:read:automod_settingsmoderator:manage:automod_settingsmoderator:read:chat_settingsmoderator:manage:chat_settingswhispers:edituser:read:follows
Since I needed to add the moderation scopes, I decided to finally add the whisper edit scope, this will allow the broadcaster account to send whispers. The restrictions by twitch are still in place!
¶ New C# Methods
Add the following new C# methods
¶ User Variables
T GetTwitchUserVar<T>(string userName, string varName, bool persisted = true);
T GetYouTubeUserVar<T>(string userName, string varName, bool persisted = true);
void SetTwitchUserVar(string userName, string varName, object value, bool persisted = true);
void SetYouTubeUserVar(string userName, string varName, object value, bool persisted = true);
void UnsetTwitchUserVar(string userName, string varName, bool persisted = true);
void UnsetYouTubeUserVar(string userName, string varName, bool persisted = true);
void UnsetTwitchUser(string userName, bool persisted = true);
void UnsetYouTubeUser(string userName, bool persisted = true);
¶ YouTube Methods
void SendYouTubeMessage(string message);
¶ Actions
bool RunActionById(string actionId, bool runImmediately = true);
¶ Websocket Custom Servers
int WebsocketCustomServerGetConnectionByName(string name);
¶ OBS Connections
OBS connections have 2 new properties in the context menu when you Right-click on them, Default and Forced.
Setting a connection to default means if the OBS Websocket an OBS sub-action is using is not found, it will use the default selected OBS connection.
Setting a connection to forced, will override all OBS sub-actions and OBS C# methods to use this connection until it is toggled off, or Streamer.bot is restarted.
¶ Streamer.bot Website Integration
Decks, it's all about Decks! With this integration, Decks can now be fully remote! They can be opened on any browser, any device, anywhere in the world and control your Streamer.bot through button presses.
Under the Integrations tab, there is a new Streamer.bot Website tab, Click the Settings tab and connect to the Streamer.bot Website, this uses the same login mechanism that you used to sign into the website to create your Decks
Expect more things to come with this new feature!
A huge thanks to Whipstickgostop for getting the website side of things all working!
¶ Kofi Integration
A long asked for integration is finally here, you'll be able to react to events that come from Kofi!
Since Kofi uses WebHooks, this functionality is done through the Streamer.bot website, and configured there.
This REQUIRES you to be connected to the Streamer.bot Website to use
¶ Patreon Integration
You can now react to Patreon events as they happen!
Patreon also uses WebHooks, so this is done through the Streamer.bot website as well.
This REQUIRES you to be connected to the Streamer.bot Website to use
¶ VoiceMod Integration
With 0.1.8, you'll be able to select voices, and change options of VoiceMod from within Streamer.bot
The following new Sub-Actions are available:
- Get Current Voice
- Select Voice
- Select Random Voice
- Set Censor State
- Set Hear My Voice State
- Set Mute State
- Set Voice Changer State
New C# Methods available for use.
void VoiceModSelectVoice(string voiceId);
string VoiceModGetCurrentVoice();
bool VoiceModGetHearMyselfStatus();
bool VoiceModHearMyVoiceOn();
bool VoiceModHearMyVoiceOff();
bool VoiceModGetVoiceChangerStatus();
bool VoiceModVoiceChangerOn();
bool VoiceModVoiceChangerOff();
void VoiceModCensorOn();
void VoiceModCensorOff();
¶ Pulsoid Integration
Streamer.bot now has a direct integration with Pulsoid, attach an action to the Heart Rate Pulse event to receive your heart rate events.
The Heart Rate event happens every second while data is being transmitted from Pulsoid, be aware of this.
| Name | Description |
|---|---|
%measuredAt% |
Time the measurement was taken |
%heartRate% |
Heart Rate value |
¶ HypeRate Integration
Streamer.bot now has a direct integration with HypeRate.io, attach an action to the Heart Rate Pulse event to receive your heart rate events.
The Heart Rate event happens every second while data is being transmitted from HypeRate, be aware of this.
| Name | Description |
|---|---|
%heartRate% |
Heart Rate value |
¶ StreamElements
The need to find and enter your JWT token are gone. You can now authenticate with StreamElements to give Streamer.bot access to your account to use features from this service.
If you were using StreamElements prior to this version, you will need to login in order to resume functionality.
¶ PolyPop Integration
Requires the plugin PolyPop WebSocket Plugin from Jabbey92 in order to work.
Once configured, you'll be able to trigger PolyPop alerts from within Streamer.bot using the PolyPop Trigger Alert sub-action
¶ TipeeeStream Integration
Assign an action to donations that are sent through TipeeeStream
¶ TreatStream Integration
Assign an action to whenever someone sends you a treat through TreatStream!
¶ Action Queues
A brand new tab at the top level, Action Queues has been added, you'll be able to find your Queues here now, instead of a drop down on the General tab under Settings. You'll be able to add, create, delete your queues, pause them, resume them from here as well.
In addition to this, there are 2 additional tabs under Action Queues; Pending Actions and Action History
¶ Pending Actions
Here you will be able to see Streamer.bot working, showing you actions as they get queued up, and when they start running.
Right clicking on an Action will let you inspect the variables that the action was run with.
¶ Action History
Here you will be able to see actions that have complete, along with how long it took for them to run.
Right clicking on an action will bring up a context menu, letting you inspect the variables this action was run with, inspecting the variables after it was completed, as well as requeuing the action as if it was just ran.
¶ New Sub-Actions
¶ Obs Hide Scene Sources
Much like it's counter part, Obs Hide Group sources, this will hide all the sources within a scene.
¶ Obs Set Random Scene Source Visible
Much like it's counter part, Obs Set Random Group Source Visible, this will set a random source within a scene to visible.
¶ Set Voice Control Command State
Set the state of a Voice Control Command, either enable it or disable it, or toggle its current state.
¶ Set Voice Control Command
Set the command of a Voice Control Command to the value specified, supports parsing of values.
This only works for Voice Control Commands that are Anywhere
¶ Streamer.bot v0.1.7
Released 2022-01-16
- Get/Set Action State sub-action had incorrect title in dialog
- OBS Set Replay Buffer state was using incorrect data, should work correctly now
- Fix typo in Logic if
- Voice control commands will delete correctly now if it's not active
- Set Media Source should set a local file correctly now
- /me no longer causes issues with Twitch emote parsing
- 7TV DNS resolution failures should no longer cause a startup crash
- GetClips should be working correctly now when specifying date ranges
With the addition to being able to specify date ranges/counts for clips, they are no longer returned in newest to oldest, they are returned oldest to newest, as this is how the Twitch API returns the data. There is no mechanism in the API to change the sort order. Wiki entries will be updated to indicate this
- Command cooldown action now applies to any command type, instead of exact/start only
- FetchURL is now type aware, the variable the result is put into will attempt to match its contents to the proper type, this is an interm update until more can be done. If you want explicit control, use C# to fetch data
- Updated Newtonsoft.Json library to 13.0.1
¶ Streamer.bot v0.1.6
Released 2021-12-27
- Changing category would cause a crash
- Clearing chat caused the Banned event to fire
- Multi-word commands are now checked correctly
- Custom websocket server would crash when the connection was terminated
¶ Archives
View changelogs for older releases
- Streamer.bot 0.1.5
- Streamer.bot 0.1.4
- Streamer.bot 0.1.3
- Streamer.bot 0.1.2
- Streamer.bot 0.1.1
- Streamer.bot 0.1.0
- Streamer.bot 0.0.63
- Streamer.bot 0.0.62
- Streamer.bot 0.0.61
- Streamer.bot 0.0.60
- Streamer.bot 0.0.59
- Streamer.bot 0.0.58
- Streamer.bot 0.0.57
- Streamer.bot 0.0.56
- Streamer.bot 0.0.55
- Streamer.bot 0.0.54
- Streamer.bot 0.0.53
- Streamer.bot 0.0.52
- Streamer.bot 0.0.51
- Streamer.bot 0.0.50
- Streamer.bot 0.0.44
- Streamer.bot 0.0.43
- Streamer.bot 0.0.42
- Streamer.bot 0.0.41
- Streamer.bot 0.0.40
- Streamer.bot 0.0.39
- Streamer.bot 0.0.38
- Streamer.bot 0.0.37
- Streamer.bot 0.0.36
- Streamer.bot 0.0.35
- Streamer.bot 0.0.33
- Streamer.bot 0.0.32
- Streamer.bot 0.0.31
- Streamer.bot 0.0.30