> For the complete documentation index, see [llms.txt](https://docs.mcgsoft.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mcgsoft.eu/mcg-streamer-gui/subscriber-rewards.md).

# Subscriber Rewards

Sometimes you as twitch partner are offering subscriptions to your user. after many people requesting this i added it Commands and actions for the subscriptions!

### How does it work?

Twitch handles subscriptions in  4 tiers (tier 1 , tier 2 , tier 3 and Prime)\
the prime one is a free tier 1 subscription they get when they use their prime sub.\
the others are self explanitory.

### How do i set it up?

```yaml
MCGSubscriberlink:
  enabled: false << enable or disable the entire system
  tier1:
    enabled: true << enable or disable this tier
    actions: << The actions to execute (see below)
    - "CMD#say hey thanks for the tier1 subscription {player} !"
    - "WHITELIST#player"
  tier2:
    enabled: true
    actions:
    - "CMD#say hey thanks for the tier2 subscription {player} !"
    - "WHITELIST#player"
  tier3:
    enabled: true
    actions:
    - "CMD#say hey thanks for the tier3 subscription {player} !"
    - "WHITELIST#player"
  prime:
    enabled: true
    actions:
    - "CMD#say hey thanks for the PRIME subscription {player} !"
    - "WHITELIST#player"
  unsub: << called when someones sub expires or is unsubscribed
    enabled: true
    actions:
    - "CMD#say hey thanks for the tier1 subscription {player} !"
    - "BLACKLIST#player"
    - "UNSUBKICK#player"
```

### The actions?

| Action    | Arguments | Example                   | ?                                                                             |
| --------- | --------- | ------------------------- | ----------------------------------------------------------------------------- |
| CMD       | command   | CMD#give {player} apple 1 | Executes given command                                                        |
| BLACKLIST | player    | BLACKLIST#player          | Removes player from the whitelist                                             |
| WHITELIST | player    | WHITELIST#player          | Whitelists player on your server                                              |
| UNSUBKICK | player    | UNSUBKICK#player          | Kicks the player from the server usefull after blacklisting to prevent rejoin |