diff --git a/streamerbot/3.api/1.sub-actions/core/commands/get-commands.md b/streamerbot/3.api/1.sub-actions/core/commands/get-commands.md index 1503051e..f9bab23e 100755 --- a/streamerbot/3.api/1.sub-actions/core/commands/get-commands.md +++ b/streamerbot/3.api/1.sub-actions/core/commands/get-commands.md @@ -9,11 +9,16 @@ variables: - name: 'List' type: List description: C# List object containing all commands matching your specified criteria -csharpMethods: [] +csharpMethods: + - GetCommands --- This sub-action is useful if you want to output a list of commands to your chat. +::warning +The Get-Commands sub-action will not include commands that have their location set to `Anywhere` +:: + ## Configuration ::field-group ::field{name=Group type=Dropdown required} diff --git a/streamerbot/3.api/2.triggers/twitch/chat/bits-badge-tier.md b/streamerbot/3.api/2.triggers/twitch/chat/bits-badge-tier.md index f80bc15c..7b5f490e 100644 --- a/streamerbot/3.api/2.triggers/twitch/chat/bits-badge-tier.md +++ b/streamerbot/3.api/2.triggers/twitch/chat/bits-badge-tier.md @@ -1,5 +1,5 @@ --- -name: Bits Badge Tier +title: Bits Badge Tier description: Triggered when a user's bit badge tier is upgraded twitchService: EventSub version: 0.2.5 diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/announcement.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/announcement.md index b8a8f033..d4d972f6 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/announcement.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/announcement.md @@ -1,6 +1,6 @@ --- title: Shared Announcement -description: Triggered when an announcement is shared between both chats +description: Triggered When an Announcement Is Made in a Shared Chat twitchService: EventSub version: 0.2.5 variables: @@ -31,4 +31,5 @@ variables: commonVariables: - TwitchChat - TwitchUser + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/community-sub-gift.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/community-sub-gift.md index 7b7a29b7..6e31be98 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/community-sub-gift.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/community-sub-gift.md @@ -1,6 +1,6 @@ --- title: Shared Community Sub Gift -description: Triggered when a user gifts community subscriptions in the shared chat +description: Triggered When a User Gifts Community Subscriptions in the Shared Chat twitchService: EventSub version: 0.2.5 variables: @@ -28,4 +28,5 @@ variables: commonVariables: - TwitchUser - TwitchChat + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/gift-paid-upgrade.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/gift-paid-upgrade.md index 7cdcfb37..e05c7efd 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/gift-paid-upgrade.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/gift-paid-upgrade.md @@ -1,9 +1,10 @@ --- title: Shared Gift Paid Upgrade -description: Triggered when a user upgrades their gifted subscription in the shared chat +description: Triggered When a User Upgrades Their Gifted Subscription in the Shared Chat twitchService: EventSub version: 0.2.5 variables: [] commonVariables: - TwitchUser + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/message-deleted.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/message-deleted.md new file mode 100644 index 00000000..2e29b7c1 --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/message-deleted.md @@ -0,0 +1,17 @@ +--- +title: Shared Chat Message Deleted +description: Trigger for When a Twitch Chat Message Is Deleted in a Shared Chat +version: 0.2.5 +twitchService: EventSub +variables: + - name: targetMessageId + type: string + description: The unique identifier for the message that has been deleted + - name: message + type: string + description: The content of the chat message that has been deleted + value: My chat message +commonVariables: + - TwitchUser + - TwitchSharedChatSource +--- \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/pay-it-forward.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/pay-it-forward.md index d382ab45..f9ba5ced 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/pay-it-forward.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/pay-it-forward.md @@ -1,9 +1,10 @@ --- title: Shared Pay It Forward -description: Triggered when a user pays forward their gifted subscription in the shared chat +description: Triggered When a User Pays Forward Their Gifted Subscription in the Shared Chat twitchService: EventSub version: 0.2.5 variables: [] commonVariables: - TwitchUser + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/prime-paid-upgrade.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/prime-paid-upgrade.md index a637fb3a..c1a2078d 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/prime-paid-upgrade.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/prime-paid-upgrade.md @@ -1,9 +1,10 @@ --- title: Shared Prime Paid Upgrade -description: Triggered when a user upgrades their Prime subscription to a Tier 1, 2, or 3 in the shared chat +description: Triggered When a User Upgrades Their Prime Subscription to a Tier 1, 2, or 3 in the Shared Chat twitchService: EventSub version: 0.2.5 variables: [] commonVariables: - TwitchUser + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/resub.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/resub.md index 41c7044c..46805932 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/resub.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/resub.md @@ -1,6 +1,6 @@ --- title: Shared Resub -description: Triggered when a user resubscribes in the shared chat +description: Triggered When a User Resubscribes in the Shared Chat twitchService: EventSub version: 0.2.5 variables: @@ -24,4 +24,5 @@ variables: commonVariables: - TwitchUser - TwitchChat + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/session-begin.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/session-begin.md index 00272284..bbd5d0f2 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/session-begin.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/session-begin.md @@ -1,6 +1,6 @@ --- title: Twitch Shared Chat Session Begin -description: Trigger for when Twitch Shared Chat Session begins +description: Trigger for When a Twitch Shared Chat Session Begins version: 0.2.5 twitchService: Chat Client variables: diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/session-end.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/session-end.md index ec9db14f..a6a35dfe 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/session-end.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/session-end.md @@ -1,6 +1,6 @@ --- title: Twitch Shared Chat Session End -description: Trigger for when Twitch Shared Chat Session ends +description: Trigger for When a Twitch Shared Chat Session Ends version: 0.2.5 twitchService: Chat Client variables: diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/session-update.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/session-update.md index 296dab89..f5f238d9 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/session-update.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/session-update.md @@ -1,6 +1,6 @@ --- title: Twitch Shared Chat Session Update -description: Trigger for when Twitch Shared Chat Session updates +description: Trigger for When a Twitch Shared Chat Session Updates version: 0.2.5 twitchService: Chat Client variables: diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/sub-gift.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/sub-gift.md index f70d0145..909ed39d 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/sub-gift.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/sub-gift.md @@ -1,6 +1,6 @@ --- title: Shared Sub Gift -description: Triggered when a user gifts a subscription in the shared chat +description: Triggered When a User Gifts a Subscription in a Shared Chat twitchService: EventSub version: 0.2.5 variables: @@ -46,4 +46,5 @@ variables: commonVariables: - TwitchUser - TwitchChat + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/sub.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/sub.md index 229949e7..8ff50ef3 100644 --- a/streamerbot/3.api/2.triggers/twitch/shared-chat/sub.md +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/sub.md @@ -1,6 +1,6 @@ --- title: Shared Sub -description: Triggered when a user subscribes in the shared chat +description: Triggered When a User Subscribes in a Shared Chat twitchService: EventSub version: 0.2.5 variables: @@ -11,4 +11,5 @@ variables: commonVariables: - TwitchUser - TwitchChat + - TwitchSharedChatSource --- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/user-banned.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-banned.md new file mode 100644 index 00000000..19958032 --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-banned.md @@ -0,0 +1,39 @@ +--- +title: Shared Chat User Banned +description: Trigger for When a Twitch User Is Banned in a Shared Chat +variables: + - name: user + type: string + description: Display name of user who was banned
*This will only be populated if the user has been present in chat* + value: TwitchUser123 + - name: userName + type: string + description: Login name of user who was banned + value: twitchuser123 + - name: userId + type: string + description: Twitch id of user who was banned + value: 12345 + - name: createdAt + type: DateTime + description: The timestamp when the ban was created + value: 8/4/2023 10:56:06 AM + - name: createdById + type: string + description: The Twitch user id from who created the ban + - name: createdByUsername + type: string + description: The Twitch user name from who created the ban + value: twitchuser123 + - name: createdByDisplayName + type: string + description: The Twitch display name from who created the ban + value: TwitchUser123 + - name: reason + type: string + description: The reason for the ban + value: My ban reason +commonVariables: + - TwitchUser + - TwitchSharedChatSource +--- \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/user-timedout.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-timedout.md new file mode 100644 index 00000000..5ac5663a --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-timedout.md @@ -0,0 +1,43 @@ +--- +title: Shared Chat User Timed Out +description: Trigger for When a Twitch User Is Timed Out in a Shared Chat +variables: + - name: user + type: string + description: The user who was timed out
*This will only be populated if the user has been present in chat* + value: TwitchUser123 + - name: userName + type: string + description: Login name of user who was timed out + value: twitchuser123 + - name: userId + type: string + description: Twitch id of user who was timed out + value: 12345 + - name: createdAt + type: DateTime + description: The timestamp when the timeout was created + value: 8/4/2023 10:56:06 AM + - name: createdById + type: string + description: The Twitch user id from who created the timeout + - name: createdByUsername + type: string + description: The Twitch user name from who created the timeout + value: twitchuser123 + - name: createdByDisplayName + type: string + description: The Twitch display name from who created the timeout + value: TwitchUser123 + - name: reason + type: string + description: The reason for the timeout + value: My timeout reason + - name: duration + type: number + description: The duration of the timeout + value: 300 +commonVariables: + - TwitchUser + - TwitchSharedChatSource +--- \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/user-unbanned.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-unbanned.md new file mode 100644 index 00000000..caa57635 --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-unbanned.md @@ -0,0 +1,25 @@ +--- +title: Shared Chat User Unbanned +description: Trigger for When a Twitch User Is Unbanned in a Shared Chat +version: 0.2.4 +variables: + - name: createdAt + type: datetime + description: datetime of the unban + value: 28.06.2024 20:13:20 + - name: createdByDisplayName + type: string + description: display name of the user who did the unban + value: Lyfesaver74 + - name: createdByUsername + type: string + description: login name of the user who did the unban + value: lyfesaver74 + - name: createdById + type: string + description: display name of the user who did the unban + value: 161545467 +commonVariables: + - TwitchUser + - TwitchSharedChatSource +--- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/user-untimedout.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-untimedout.md new file mode 100644 index 00000000..62550cc0 --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/user-untimedout.md @@ -0,0 +1,25 @@ +--- +title: Shared Chat User Untimed Out +description: Trigger for When a Twitch User Is Untimed Out in a Shared Chat +version: 0.2.4 +variables: + - name: createdAt + type: datetime + description: datetime of the unban + value: 28.06.2024 20:13:20 + - name: createdByDisplayName + type: string + description: display name of the user who did the unban + value: Lyfesaver74 + - name: createdByUsername + type: string + description: login name of the user who did the unban + value: lyfesaver74 + - name: createdById + type: string + description: display name of the user who did the unban + value: 161545467 +commonVariables: + - TwitchUser + - TwitchSharedChatSource +--- diff --git a/streamerbot/3.api/2.triggers/twitch/subscriptions/gift-paid-upgrade.md b/streamerbot/3.api/2.triggers/twitch/subscriptions/gift-paid-upgrade.md index a8911bcc..2def4383 100644 --- a/streamerbot/3.api/2.triggers/twitch/subscriptions/gift-paid-upgrade.md +++ b/streamerbot/3.api/2.triggers/twitch/subscriptions/gift-paid-upgrade.md @@ -1,5 +1,5 @@ --- -name: Gift Paid Upgrade +title: Gift Paid Upgrade description: Triggered when a user upgrades their gifted subscription twitchService: EventSub version: 0.2.5 diff --git a/streamerbot/3.api/_variables/twitch/TwitchChat.md b/streamerbot/3.api/_variables/twitch/TwitchChat.md index 255adf11..676e6d50 100644 --- a/streamerbot/3.api/_variables/twitch/TwitchChat.md +++ b/streamerbot/3.api/_variables/twitch/TwitchChat.md @@ -128,4 +128,10 @@ variables: - name: inputUrlEncoded# type: string description: The indexed word URL encoded + - name: inSharedChat + type: boolean + description: Whether or not the broadcaster is currently in a shared chat + - name: fromSharedChat + type: boolean + description: Whether or not the message originated from a different broadcaster in shared chat --- diff --git a/streamerbot/3.api/_variables/twitch/TwitchSharedChatSource.md b/streamerbot/3.api/_variables/twitch/TwitchSharedChatSource.md new file mode 100644 index 00000000..9c6f74f1 --- /dev/null +++ b/streamerbot/3.api/_variables/twitch/TwitchSharedChatSource.md @@ -0,0 +1,29 @@ +--- +title: Shared Chat Source +navigation.title: Shared Chat +variables: + - name: source.userId + type: string + description: The Twitch user ID from which chat the event originated + value: 123456789 + - name: source.userLogin + type: string + description: The Twitch user login name from which chat the event originated + value: twitchuser123 + - name: source.userName + type: string + description: The Twitch display name from which chat the event originated + value: TwitchUser123 + - name: source.isSubscribed + type: boolean + description: Whether or not the source chat owner is subscribed in your channel + value: False + - name: source.isModerator + type: boolean + description: Whether or not the source chat owner is a moderator in your channel + value: True + - name: source.isVip + type: boolean + description: Whether or not the source chat owner is a VIP in your channel + value: False +--- \ No newline at end of file