Reward Types

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 NEW

• ADVENT CALENDAR

• COUPON REWARD SOON

• DISCORD REWARD SOON

• PICKABLE REWARD NEW

• TIME REWARD

• TIME FIXED REWARD

• STREAK REWARD

• STREAK FIXED REWARD

• VOTE REWARD

• PER VOTE REWARD

• RENEWABLE VOTE REWARD

• STREAK VOTE REWARD

• PLAY TIME REWARD

• RENEWABLE PLAY TIME REWARD

• REFERRAL REWARD

• RENEWABLE REFERRAL REWARD

• PURCHASABLE REWARD

• RE-PURCHASABLE REWARD

• ONE TIME REWARD

• TIME LIMITED REWARD

• CUSTOM REWARD

• MULTIPLE CUSTOM REWARD NEW

Shared Properties

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

• enabled [true/false] - whether the reward is active

• command [text] - the command by which the reward can be collected NEW!

• disabled-worlds [list] - worlds where reward can't be obtained

• tag [text] - reward's tag

• permission [text] - limits the reward to players with this permission

• actions [text] - a list of actions that will be performed after the reward is activated - about actions is whole following section.

• 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)

• required-slots [number] - how many slots a player needs to have available to collect a reward

• 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)

• 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)