CPH.ObsTakeScreenshot
%msgId%
which is the id of the messagebool SendWhisper(string userName, string message, bool bot = true)
%randomLineNumber#%
*
for the ip address*
for the ip addressSet Reward Title
and Reward Update
sub-actions to prevent setting titles longer then 45 characters, and prompt longer then 200 characters
whispers:read
on bot account, you will need to re-authorize your bot accountLogVerbose(string logLine)
LumiaSetToDefault()
LumiaSendCommand()
OBS
->Get Status to add OBS status informationTwitch
->Add Viewer Count to add your current Twitch viewer count as a variablebool TwitchClearChatMessages(bool bot = true)
bool TwitchDeleteChatMessage(string messageId, bool bot = true)
DiscordPostTextToWebhook
to post text to a discord webhook/shoutout
command is used, if your channel has the abilityWith 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.
channel:read:charity
moderator:manage:chat_messages
moderator:read:chatters
moderator:manage:chat_messages
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.
The newly released Charity feature of Twitch is now supported within Streamer.bot
This introduces 2 new events, Donation and Completed
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 |
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.
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 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 |
By using the Streamer.bot website, you can now add webhooks to your Shopify store front!
Supported webhook events include
Order creation
andOrder payment
There are 2 new events within Streamer.bot that you can associate an action with, Order Created
and 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
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.
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 |
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 |
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.
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
Add the following new C# methods
void LogVerbose(string logLine);
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);
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);
void LumiaSendCommand(string command);
void LumiaSetToDefault();
bool ActionExists(string actionName);
bool DiscordPostTextToWebhook(string webhookUrl, string content, string username = null, bool textToSpeech = false);
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:
Messages that exceed the maximum length are truncated.