Credits sub-actions¶
Add custom credit¶
Adds a person to the end credits of your stream, like "Special thanks". Good for thanking someone who does not show up in follows or tips.
| Setting | What to put in |
|---|---|
| Section | Which part of the credits. Use a built-in one (follows, tips, raids...) or any title you make up, like "Special thanks". Starts as: Special thanks. |
| User | The person's name. The default %user% is whoever started the action. Starts as: %user%. |
| Platform | The site the person is on, like twitch. The default %platform% is whoever started the action. Starts as: %platform%. |
| Amount | A number added to the person's total in this section, like a tip amount. 0 if it does not matter. Starts as: 0. |
| Detail | Optional extra text shown next to the name, like "for the great clip". |
Type id: credits.addCustom
Get credits¶
Reads the credits collected so far and saves them in variables, for example the names of all new followers. Handy for a "thanks to everyone" chat message.
| Setting | What to put in |
|---|---|
| Use test data | Tick to use made-up sample credits, for trying out an overlay design. Starts as: false. |
Variables it adds
| Variable | What it holds |
|---|---|
%creditsFollows% |
The names of all new followers, separated by commas |
%creditsSubscriptions% |
The names of everyone who subscribed |
%creditsTips% |
The names of everyone who tipped |
%creditsRaids% |
The names of everyone who raided |
%creditsChatters% |
The names of everyone who chatted |
%creditsTotal% |
How many names there are in all |
Type id: credits.get
Reset credits¶
Clears the collected credits so the next ones start fresh. Good at the start of a new stream.
Type id: credits.reset