diff --git a/streamerbot/2.guide/08.settings/assets/credits_1.png b/streamerbot/2.guide/08.settings/assets/credits_1.png index 1c393726..1ef748c4 100644 Binary files a/streamerbot/2.guide/08.settings/assets/credits_1.png and b/streamerbot/2.guide/08.settings/assets/credits_1.png differ diff --git a/streamerbot/2.guide/08.settings/assets/timed-actions-2.png b/streamerbot/2.guide/08.settings/assets/timed-actions-2.png index 3cea014c..fa651c6c 100644 Binary files a/streamerbot/2.guide/08.settings/assets/timed-actions-2.png and b/streamerbot/2.guide/08.settings/assets/timed-actions-2.png differ diff --git a/streamerbot/2.guide/08.settings/credits.md b/streamerbot/2.guide/08.settings/credits.md index aa61fdbf..846c796e 100644 --- a/streamerbot/2.guide/08.settings/credits.md +++ b/streamerbot/2.guide/08.settings/credits.md @@ -4,7 +4,7 @@ description: Streamer.bot has a built in 'Credits' system. It allows Broadcaster --- ## Setup -In order to use the Credits, navigate to `Settings -> Credits` and from there, check the events you want included. +In order to use the Credits, navigate to `Services -> Credits` and from there, check the events you want included. ![Credits Settings](assets/credits_1.png) diff --git a/streamerbot/2.guide/08.settings/quotes.md b/streamerbot/2.guide/08.settings/quotes.md index 2f0819fe..87442133 100644 --- a/streamerbot/2.guide/08.settings/quotes.md +++ b/streamerbot/2.guide/08.settings/quotes.md @@ -9,7 +9,7 @@ This page documents the old quote system prior to Streamer.bot 1.0.0
:: ## Setup -In order to use the built in quote system, navigate to `Settings -> Quotes` and check `Enabled`. +In order to use the built in quote system, navigate to `Services -> Quotes` and check `Enabled`. ![Quote Settings](assets/quotes_6.png) diff --git a/streamerbot/2.guide/08.settings/timed-actions.md b/streamerbot/2.guide/08.settings/timed-actions.md index 4961d3b9..5c28d372 100644 --- a/streamerbot/2.guide/08.settings/timed-actions.md +++ b/streamerbot/2.guide/08.settings/timed-actions.md @@ -4,7 +4,7 @@ description: Timed Actions can be used a an action trigger that will trigger aft --- ## Setup -Navigate to `Settings -> Timed Actions`, rightclick the white area and click `Add`. +Navigate to `Services -> Timed Actions`, rightclick the white area and click `Add`. ![Timed Actions Navigation](assets/timed-actions-2.png) diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/changed.png b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/changed.png index 65821b39..226de077 100644 Binary files a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/changed.png and b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/changed.png differ diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/created.png b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/created.png index f9219668..385724cb 100644 Binary files a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/created.png and b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/created.png differ diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/deleted.png b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/deleted.png index 7de4b690..4784f6ee 100644 Binary files a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/deleted.png and b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/deleted.png differ diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/renamed.png b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/renamed.png index da493380..a2874272 100644 Binary files a/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/renamed.png and b/streamerbot/3.api/2.triggers/core/file-folder-watcher/assets/renamed.png differ diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/changed.md b/streamerbot/3.api/2.triggers/core/file-folder-watcher/changed.md index 3a0e9442..d91ffd78 100755 --- a/streamerbot/3.api/2.triggers/core/file-folder-watcher/changed.md +++ b/streamerbot/3.api/2.triggers/core/file-folder-watcher/changed.md @@ -47,7 +47,7 @@ variables: ## Parameters ::field-group ::field{name=Watcher type=Select} - Select a watcher from the Settings -> File/Folder Watcher tab. + Select a watcher from the Services -> File/Folder Watcher tab. - Select `Any` to trigger on **any watcher** diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/created.md b/streamerbot/3.api/2.triggers/core/file-folder-watcher/created.md index e61a1178..1a97b8c1 100755 --- a/streamerbot/3.api/2.triggers/core/file-folder-watcher/created.md +++ b/streamerbot/3.api/2.triggers/core/file-folder-watcher/created.md @@ -27,7 +27,7 @@ variables: ## Parameters ::field-group ::field{name=Watcher type=Select} - Select a watcher from the Settings -> File/Folder Watcher tab. + Select a watcher from the Services -> File/Folder Watcher tab. - Select `Any` to trigger on **any watcher** diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/deleted.md b/streamerbot/3.api/2.triggers/core/file-folder-watcher/deleted.md index be087b48..b8c205fb 100755 --- a/streamerbot/3.api/2.triggers/core/file-folder-watcher/deleted.md +++ b/streamerbot/3.api/2.triggers/core/file-folder-watcher/deleted.md @@ -27,7 +27,7 @@ variables: ## Parameters ::field-group ::field{name=Watcher type=Select} - Select a watcher from the Settings -> File/Folder Watcher tab. + Select a watcher from the Services -> File/Folder Watcher tab. - Select `Any` to trigger on **any watcher** diff --git a/streamerbot/3.api/2.triggers/core/file-folder-watcher/renamed.md b/streamerbot/3.api/2.triggers/core/file-folder-watcher/renamed.md index d12dd5f9..6029f469 100755 --- a/streamerbot/3.api/2.triggers/core/file-folder-watcher/renamed.md +++ b/streamerbot/3.api/2.triggers/core/file-folder-watcher/renamed.md @@ -35,7 +35,7 @@ variables: ## Parameters ::field-group ::field{name=Watcher type=Select} - Select a watcher from the Settings -> File/Folder Watcher tab. + Select a watcher from the Services -> File/Folder Watcher tab. - Select `Any` to trigger on **any watcher** diff --git a/streamerbot/3.api/2.triggers/core/file-io/file-tail/assets/changed.png b/streamerbot/3.api/2.triggers/core/file-io/file-tail/assets/changed.png index 785fc8ff..85daee9f 100644 Binary files a/streamerbot/3.api/2.triggers/core/file-io/file-tail/assets/changed.png and b/streamerbot/3.api/2.triggers/core/file-io/file-tail/assets/changed.png differ diff --git a/streamerbot/3.api/2.triggers/core/file-io/file-tail/changed.md b/streamerbot/3.api/2.triggers/core/file-io/file-tail/changed.md index 3e93b59b..aa140cf4 100644 --- a/streamerbot/3.api/2.triggers/core/file-io/file-tail/changed.md +++ b/streamerbot/3.api/2.triggers/core/file-io/file-tail/changed.md @@ -7,7 +7,7 @@ parameters: - name: Watcher type: Select description: | - Select a file tail from the Settings -> File Tails tab. + Select a file tail from the Services -> File Tails tab. - Select `Any` to trigger on **any file tail** diff --git a/streamerbot/3.api/2.triggers/core/processes/assets/process-started.png b/streamerbot/3.api/2.triggers/core/processes/assets/process-started.png index 4f57317c..5085e137 100644 Binary files a/streamerbot/3.api/2.triggers/core/processes/assets/process-started.png and b/streamerbot/3.api/2.triggers/core/processes/assets/process-started.png differ diff --git a/streamerbot/3.api/2.triggers/core/processes/assets/process-stopped.png b/streamerbot/3.api/2.triggers/core/processes/assets/process-stopped.png index 8290dff2..6c744370 100644 Binary files a/streamerbot/3.api/2.triggers/core/processes/assets/process-stopped.png and b/streamerbot/3.api/2.triggers/core/processes/assets/process-stopped.png differ diff --git a/streamerbot/3.api/2.triggers/core/processes/process-started.md b/streamerbot/3.api/2.triggers/core/processes/process-started.md index c30d053d..a1dc1c95 100644 --- a/streamerbot/3.api/2.triggers/core/processes/process-started.md +++ b/streamerbot/3.api/2.triggers/core/processes/process-started.md @@ -22,6 +22,8 @@ variables: type: string description: ID of the program that launched the process. --- +## Details +Using this trigger requires you to have the Process Watcher enabled. This can be done under `Services -> Process Watcher` ## Parameters ::field-group diff --git a/streamerbot/3.api/2.triggers/core/processes/process-stopped.md b/streamerbot/3.api/2.triggers/core/processes/process-stopped.md index e158f63c..b28ad5f2 100644 --- a/streamerbot/3.api/2.triggers/core/processes/process-stopped.md +++ b/streamerbot/3.api/2.triggers/core/processes/process-stopped.md @@ -23,6 +23,9 @@ variables: description: ID of the program that launched the process. --- +## Details +Using this trigger requires you to have the Process Watcher enabled. This can be done under `Services -> Process Watcher` + ## Parameters ::field-group ::field{name=Name type=Text} diff --git a/streamerbot/3.api/2.triggers/twitch/hype-train/end.md b/streamerbot/3.api/2.triggers/twitch/hype-train/end.md index f822fd84..d2c564d5 100644 --- a/streamerbot/3.api/2.triggers/twitch/hype-train/end.md +++ b/streamerbot/3.api/2.triggers/twitch/hype-train/end.md @@ -23,10 +23,26 @@ variables: type: boolean description: Whether or not this is a Golden Kappa Train value: True - - name: contributors - type: number - description: The amount of contributors of the hype train - value: 10 + - name: isTreasureTrain + type: boolean + description: Whether or not this is a Treasure Train + value: True + - name: trainType + type: string + value: | + Possible Values: 'regular', 'treasure', 'golden_kappa' + - name: isSharedTrain + type: boolean + description: Whether or not this is a Shared Chat Hype Train + version: 1.0.2 + - name: isInSharedChat + type: boolean + description: Whether or not the broadcast is currently in a shared chat + version: 1.0.2 + - name: isSharedChatHost + type: boolean + description: Whether or not the broadcaster is the host of the shared chat + version: 1.0.2 - name: top.bits.user type: string description: The top cheerer of this hype train display name diff --git a/streamerbot/3.api/2.triggers/twitch/hype-train/level-up.md b/streamerbot/3.api/2.triggers/twitch/hype-train/level-up.md index d7bfc0d0..1baedc2e 100644 --- a/streamerbot/3.api/2.triggers/twitch/hype-train/level-up.md +++ b/streamerbot/3.api/2.triggers/twitch/hype-train/level-up.md @@ -38,10 +38,26 @@ variables: type: boolean description: Whether or not this is a Golden Kappa Train value: True - - name: contributors - type: number - description: The amount of contributors of the hype train - value: 10 + - name: isTreasureTrain + type: boolean + description: Whether or not this is a Treasure Train + value: True + - name: trainType + type: string + value: | + Possible Values: 'regular', 'treasure', 'golden_kappa' + - name: isSharedTrain + type: boolean + description: Whether or not this is a Shared Chat Hype Train + version: 1.0.2 + - name: isInSharedChat + type: boolean + description: Whether or not the broadcast is currently in a shared chat + version: 1.0.2 + - name: isSharedChatHost + type: boolean + description: Whether or not the broadcaster is the host of the shared chat + version: 1.0.2 - name: top.bits.user type: string description: The top cheerer of this hype train display name diff --git a/streamerbot/3.api/2.triggers/twitch/hype-train/start.md b/streamerbot/3.api/2.triggers/twitch/hype-train/start.md index a1595880..7bc0ef51 100644 --- a/streamerbot/3.api/2.triggers/twitch/hype-train/start.md +++ b/streamerbot/3.api/2.triggers/twitch/hype-train/start.md @@ -31,6 +31,34 @@ variables: type: boolean description: Whether or not this is a Golden Kappa Train value: True + - name: isTreasureTrain + type: boolean + description: Whether or not this is a Treasure Train + value: True + - name: trainType + type: string + value: | + Possible Values: 'regular', 'treasure', 'golden_kappa' + - name: isSharedTrain + type: boolean + description: Whether or not this is a Shared Chat Hype Train + version: 1.0.2 + - name: isInSharedChat + type: boolean + description: Whether or not the broadcast is currently in a shared chat + version: 1.0.2 + - name: isSharedChatHost + type: boolean + description: Whether or not the broadcaster is the host of the shared chat + version: 1.0.2 + - name: allTimeHighLevel + type: number + description: The all-time high level this type of Hype Train has reached for the broadcaster + version: 1.0.4 + - name: allTimeHighTotal + type: number + description: The all-time high total of points this type of Hype Train has reached for the broadcaster + version: 1.0.4 - name: top.bits.user type: string description: The top cheerer of this hype train display name diff --git a/streamerbot/3.api/2.triggers/twitch/hype-train/update.md b/streamerbot/3.api/2.triggers/twitch/hype-train/update.md index 61b23f19..406e6706 100644 --- a/streamerbot/3.api/2.triggers/twitch/hype-train/update.md +++ b/streamerbot/3.api/2.triggers/twitch/hype-train/update.md @@ -31,10 +31,26 @@ variables: type: boolean description: Whether or not this is a Golden Kappa Train value: True - - name: contributors - type: number - description: The amount of contributors of the hype train - value: 10 + - name: isTreasureTrain + type: boolean + description: Whether or not this is a Treasure Train + value: True + - name: trainType + type: string + value: | + Possible Values: 'regular', 'treasure', 'golden_kappa' + - name: isSharedTrain + type: boolean + description: Whether or not this is a Shared Chat Hype Train + version: 1.0.2 + - name: isInSharedChat + type: boolean + description: Whether or not the broadcast is currently in a shared chat + version: 1.0.2 + - name: isSharedChatHost + type: boolean + description: Whether or not the broadcaster is the host of the shared chat + version: 1.0.2 - name: top.bits.user type: string description: The top cheerer of this hype train display name diff --git a/streamerbot/3.api/2.triggers/twitch/subscriptions/prime-paid-upgrade.md b/streamerbot/3.api/2.triggers/twitch/subscriptions/prime-paid-upgrade.md index d0cd3ffb..b6ebc5bb 100644 --- a/streamerbot/3.api/2.triggers/twitch/subscriptions/prime-paid-upgrade.md +++ b/streamerbot/3.api/2.triggers/twitch/subscriptions/prime-paid-upgrade.md @@ -3,7 +3,19 @@ title: Prime Paid Upgrade description: Triggered when a user upgrades their Prime subscription to a Tier 1, 2, or 3 twitchService: EventSub version: 0.2.5 -variables: [] +variables: + - name: systemMessage + type: string + description: The message Twitch will send into Chat on this specific event + version: 0.2.5 + - name: upgradeTier + type: number + description: The tier that the subscription was upgraded to + value: 1000 + - name: upgradeTierString + type: string + description: The tier, in text form, that the subscription was upgraded to + value: tier 1 commonVariables: - TwitchBroadcaster - TwitchUser