> For the complete documentation index, see [llms.txt](https://ultimaterewards.athelion.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ultimaterewards.athelion.eu/configuration/rewards/reward-types.md).

# Reward Types

The plugin offers various types of rewards for all types of occasions.

Each reward type comes with its own unique settings, along with shared parameters that are applicable to all rewards. The following is a list of currently available reward types, acknowledging the possibility of additional types being introduced in future versions:

* [**AFK REWARD**](/configuration/rewards/reward-types/afk-reward.md) <mark style="color:red;">**NEW**</mark>
* [**ADVENT CALENDAR**](/configuration/rewards/reward-types/advent-calendar.md)
* [**COUPON REWARD**](/configuration/rewards/reward-types/coupon-reward.md) *<mark style="color:yellow;">SOON</mark>*
* [**DISCORD REWARD**](/configuration/rewards/reward-types/discord-reward.md) *<mark style="color:yellow;">SOON</mark>*
* [**PICKABLE REWARD**](/configuration/rewards/reward-types/pickable-reward.md) <mark style="color:red;">**NEW**</mark>
* [**TIME REWARD**](/configuration/rewards/reward-types/time-reward.md)
* [**TIME FIXED REWARD**](/configuration/rewards/reward-types/time-fixed-reward.md)
* [**STREAK REWARD**](/configuration/rewards/reward-types/streak-reward.md)
* [**STREAK FIXED REWARD**](/configuration/rewards/reward-types/streak-fixed-reward.md)
* [**VOTE REWARD**](/configuration/rewards/reward-types/vote-reward.md)
* [**PER VOTE REWARD**](/configuration/rewards/reward-types/per-vote-reward.md)
* [**RENEWABLE VOTE REWARD**](/configuration/rewards/reward-types/renewable-vote-reward.md)
* [**STREAK VOTE REWARD**](/configuration/rewards/reward-types/streak-vote-reward.md)
* [**PLAY TIME REWARD**](/configuration/rewards/reward-types/play-time-reward.md)
* [**RENEWABLE PLAY TIME REWARD**](/configuration/rewards/reward-types/renewable-play-time-reward.md)
* [**REFERRAL REWARD**](/configuration/rewards/reward-types/referral-reward.md)
* [**RENEWABLE REFERRAL REWARD**](/configuration/rewards/reward-types/renewable-referral-reward.md)
* [**PURCHASABLE REWARD**](/configuration/rewards/reward-types/purchasable-reward.md)
* [**RE-PURCHASABLE REWARD**](/configuration/rewards/reward-types/re-purchasable-reward.md)
* [**ONE TIME REWARD**](/configuration/rewards/reward-types/one-time-reward.md)
* [**TIME LIMITED REWARD**](/configuration/rewards/reward-types/time-limited-reward.md)
* [**CUSTOM REWARD**](/configuration/rewards/reward-types/custom-reward.md)
* [**MULTIPLE CUSTOM REWARD**](/configuration/rewards/reward-types/multiple-custom-reward.md) <mark style="color:red;">**NEW**</mark>

{% hint style="info" %}
The value written into `type:` in the reward's .yml file is the type name in lower snake case, e.g. `type: time_reward`, `type: renewable_vote_reward`, `type: multiple_custom_reward`. The same names are used by `%ultimaterewards_available_{rewardType}%`.
{% endhint %}

### Shared Properties

These common parameters can be applied (by adding or removing the path to the .yml reward folder) to all rewards:

#### Basics

* `enabled` \[true/false] - whether the reward is active
* `type` \[text] - the reward type, see the list above
* `tag` \[text] - reward's tag, also available in actions as `%tag%` (defaults to the file name)
* `command` \[text] - the command by which the reward can be collected
* `permission` \[text] - limits the reward to players with this permission *(set to "" for no required permission)*
* `actions` \[list] - a list of actions that will be performed after the reward is activated\
  \- about actions is whole following [section](/configuration/rewards/reward-actions.md).

#### Requirements

* `disabled-worlds` \[list] - worlds where reward can't be obtained
* `required-slots` \[number] - how many free inventory slots a player needs to collect a reward
* `max-play-time` \[number] - time limit (in minutes) when the player can collect the reward, if he exceeds this limit - he cannot collect the reward anymore <mark style="color:red;">**NEW**</mark>
* `required-session-play-time` \[number] - how many minutes the player has to play **in the current session** before this reward can be collected (set to 0 to disable)
* `require-discord-sync` \[true/false] - the player will only be able to collect the reward if he has a synced account with your discord server (only with DiscordSRV plugin)
* `require-boosting-discord` \[true/false] - the player will only be able to collect the reward while boosting your Discord server (only with DiscordSRV plugin)

All of them are described in detail in [Reward Requirements](/configuration/rewards/reward-features/reward-requirements.md).

#### Notifications & auto-claim

* `exclude-from-reminders` \[true/false] - reward won't be included in reward available reminders
* `live-reminder-enabled` \[true/false] - enable live notification of reward availability (example: when a cooldown time reward runs out, the player is notified that they can collect it)
* `live-notification` \[list] - custom text of the live notification for this reward (falls back to lang.yml when not set)
* `included-in-auto-claim` \[true/false] - decides whether the reward should be automatically collected (if available) for the player
* `close-after-claiming` \[true/false] - decides if the menu should be closed after claiming the reward (rewrites the global setting from config.yml)

#### Appearance

Every reward state has its own item, display name and lore. The available states differ per reward type and are listed on each type's page; the ones shared by all rewards are:

* `available-item`, `available-display-name`, `available-lore` - shown while the reward can be claimed
* `available-glow` \[true/false] - adds the enchantment glow to the available item
* `no-permission-item`, `no-permission-display-name`, `no-permission-lore` - shown when the player lacks the reward's `permission`

{% hint style="info" %}
`claimable-item`, `claimable-display-name` and `claimable-lore` are still accepted as legacy names for the `available-*` keys.
{% endhint %}

#### Variants

* `variants` - permission-based overrides of display and actions, see [Reward Variants](/configuration/rewards/reward-features/reward-variants.md)