Updating HypeTrain and PrimePaidUpgrade Variables, Services Paths + images

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)
 

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<br/>
 ::
 
 ## 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)
 

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)
 

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**
 

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**
 

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**
 

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**
 

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**
 

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

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}

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

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

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

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

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