Skip to content

Commit 8bb503b

Browse files
committed
Kick Trigger Subscriptions Args, Minor other things
1 parent 182e26e commit 8bb503b

File tree

10 files changed

+135
-14
lines changed

10 files changed

+135
-14
lines changed
23.3 KB
Loading
22.2 KB
Loading

streamerbot/2.guide/8.settings/credits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Streamer.bot has a built in 'Credits' system. It allows Broadcaster
44
---
55

66
## Setup
7-
In order to use the Credits, navigate to `Settings -> Credits` and from there, check the events you want included.
7+
In order to use the Credits, navigate to `Services -> Credits` and from there, check the events you want included.
88

99
![Credits Settings](assets/credits_1.png)
1010

streamerbot/2.guide/8.settings/quotes.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,19 @@ title: Quotes
33
description: Streamer.bot has a built in quote system. It allows to add, display and delete quotes. Adding a quote automatically assigns an ID and saves a timestamp, the quoting user, the platform as well as the current category (like "Just Chatting").
44
---
55

6+
::warning
7+
The quote system has been reworked since version `1.0.0`. You can currently read more about how to set up quotes in the examples. Guide will be updated soon.
8+
::
9+
10+
:read-more{to="/get-started/examples/quotes-commands"}
11+
612
## Setup
7-
In order to use the built in quote system, navigate to `Settings -> Quotes` and check `Enabled`.
813

914
![Quote Settings](assets/quotes_6.png)
1015

11-
In here you'll see all quotes that have been added to your Streamer.bot already and you'll also be able to change the permissions to add quotes.
16+
In here you'll see all quotes that have been added to your Streamer.bot.
1217

13-
![Quote Permissions](assets/quotes_2.png)
18+
![Quote Permissions](assets/quotes_2.png)
1419

1520
::tip
1621
Deleting quotes is reserved for the broadcaster and moderators only.

streamerbot/2.guide/8.settings/timed-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Timed Actions can be used a an action trigger that will trigger aft
44
---
55

66
## Setup
7-
Navigate to `Settings -> Timed Actions`, rightclick the white area and click `Add`.
7+
Navigate to `Services -> Timers`, rightclick the empty area and click `Add`.
88

99
![Timed Actions Navigation](assets/timed-actions-2.png)
1010

streamerbot/3.api/2.triggers/custom/custom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ csharpMethods:
1414
---
1515

1616
## Details
17-
This event can **only** be triggered with the [`CPH.TriggerEvent`](#csharp-usage) C# Method.
17+
This event can be triggered with the [`CPH.TriggerEvent`](#csharp-usage) C# Method or the sub-action [Trigger Custom Event](/api/sub-actions/core/triggers/custom-event-trigger).
1818

1919
## Variables
2020
Variables are dependent on the custom event.

streamerbot/3.api/2.triggers/kick/subscriptions/gift-subscription.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,48 @@
11
---
22
title: Gift Subscription
33
description: Trigger for a Kick Gift Subscription
4+
variables:
5+
- name: isAnonymous
6+
type: boolean
7+
description: |
8+
Whether the gift subscription was made anonymously
9+
value: false
10+
- name: subscribedAt
11+
type: DateTime
12+
description: |
13+
The date and time when the subscription was created
14+
value: 2025/12/31 23:59:59
15+
- name: expiresAt
16+
type: DateTime
17+
description: |
18+
The date and time when the subscription will expire
19+
value: 2025/12/31 23:59:59
20+
- name: recipient.userId
21+
type: string
22+
description: |
23+
The user ID of the recipient of the gift subscription
24+
value: 123456
25+
- name: recipient.userLogin
26+
type: string
27+
description: |
28+
The user login of the recipient of the gift subscription
29+
value: genericuser
30+
- name: recipient.userName
31+
type: string
32+
description: |
33+
The display name of the recipient of the gift subscription
34+
value: genericUser
35+
- name: recipient.profilePicture
36+
type: string
37+
description: |
38+
The profile picture URL of the recipient of the gift subscription
39+
value: https://example.com/profile.jpg
40+
- name: recipient.platform
41+
type: string
42+
description: |
43+
The platform of the recipient of the gift subscription
44+
value: genericUser
445
commonVariables:
546
- KickBroadcaster
47+
- KickUser
648
---
7-
8-
:wip

streamerbot/3.api/2.triggers/kick/subscriptions/mass-gift-subscription.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,59 @@
11
---
22
title: Mass Gift Subscription
33
description: Trigger for a Kick Mass Gift Subscription
4+
variables:
5+
- name: isAnonymous
6+
type: boolean
7+
description: |
8+
Whether the gift subscription was made anonymously
9+
value: false
10+
- name: subscribedAt
11+
type: DateTime
12+
description: |
13+
The date and time when the subscription was created
14+
value: 2025/12/31 23:59:59
15+
- name: expiresAt
16+
type: DateTime
17+
description: |
18+
The date and time when the subscription will expire
19+
value: 2025/12/31 23:59:59
20+
- name: recipient#.userId
21+
type: string
22+
description: |
23+
The user ID of the recipient of the gift subscription
24+
25+
The '#' is an index which starts at 0 and increments for each recipient in the mass gift
26+
value: 123456
27+
- name: recipient#.userLogin
28+
type: string
29+
description: |
30+
The user login of the recipient of the gift subscription
31+
32+
The '#' is an index which starts at 0 and increments for each recipient in the mass gift
33+
value: genericuser
34+
- name: recipient#.userName
35+
type: string
36+
description: |
37+
The display name of the recipient of the gift subscription
38+
39+
The '#' is an index which starts at 0 and increments for each recipient in the mass gift
40+
value: genericUser
41+
- name: recipient#.profilePicture
42+
type: string
43+
description: |
44+
The profile picture URL of the recipient of the gift subscription
45+
46+
The '#' is an index which starts at 0 and increments for each recipient in the mass gift
47+
value: https://example.com/profile.jpg
48+
- name: recipient#.platform
49+
type: string
50+
description: |
51+
The platform of the recipient of the gift subscription
52+
53+
The '#' is an index which starts at 0 and increments for each recipient in the mass gift
54+
value: genericUser
455
commonVariables:
556
- KickBroadcaster
57+
- KickUser
658
---
759

8-
:wip

streamerbot/3.api/2.triggers/kick/subscriptions/resubscription.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
---
2-
title: Gift Resubscription
2+
title: Resubscription
33
description: Trigger for a Kick Resubscription
4+
variables:
5+
- name: expiresAt
6+
type: DateTime
7+
description: |
8+
The date and time when the subscription will expire
9+
value: 2025/12/31 23:59:59
10+
- name: duration
11+
type: Number
12+
description: |
13+
The duration of the subscription
14+
value: 3
15+
- name: monthsSubscribed
16+
type: Number
17+
description: |
18+
The total amount of months the user has been subscribed
19+
value: 6
420
commonVariables:
521
- KickBroadcaster
22+
- KickUser
623
---
7-
8-
:wip

streamerbot/3.api/2.triggers/kick/subscriptions/subscription.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
---
22
title: Subscription
33
description: Trigger for a Kick Subscription
4+
variables:
5+
- name: expiresAt
6+
type: DateTime
7+
description: |
8+
The date and time when the subscription will expire
9+
value: 2025/12/31 23:59:59
10+
- name: duration
11+
type: Number
12+
description: |
13+
The duration of the subscription
14+
value: 1
415
commonVariables:
516
- KickBroadcaster
17+
- KickUser
618
---
7-
8-
:wip

0 commit comments

Comments
 (0)