Creating Reward
Setuping the reward
Rewards are located in the rewards folder, where each reward corresponds to one file. The file name then denotes the identifier of the reward.
General Settings
The tutorial is explained for the Time Reward, note that each reward type has its own properties in addition to the shared properties - you can set these properties for each of the reward types.
Enable Reward Claiming
enabled: Set to
true
to allow rewards to be claimable.
Reward Type
type: Specifies the type of reward. All reward type are listed here. Use
time_reward
for time-based rewards.
Reward Tag
tag: A label for the reward, used for identification.
(Optional) Reward Command
command: The command by which the reward can be claimed, /timereward in this case.
Cooldown Settings
Cooldown Duration
cooldown: Number of units before the reward can be claimed again.
Cooldown Unit
unit: Unit of time for the cooldown (e.g.,
hours
,minutes
).
General Cooldown Display Format
cooldown-general-format: Format for displaying the general cooldown time.
Specific Cooldown Display Format
cooldown-format: Format for displaying the cooldown in reward GUIs.
Availability Settings
(Optional) Available After First Join
available-after-first-join: Set to
true
to make the reward available immediately after a player's first join.
(Optional) Live Reminder
live-reminder-enabled: Notifies players when the reward is available.
(Optional) Required Inventory Slots
required-slots: Number of free inventory slots required to claim the reward.
(Optional) Permission Requirement
permission: Permission node required for the player to claim the reward.
Item and Display Settings
Available Item Display
available-item: Item displayed when the reward is claimable.
available-display-name: Display name for the available reward item.
available-lore: Lore description for the available reward item.
Unavailable Item Display
unavailable-item: Item displayed when the reward is under cooldown.
unavailable-display-name: Display name for the unavailable reward item.
unavailable-lore: Lore description for the unavailable reward item.
No Permission Item Display
no-permission-item: Item displayed when the player lacks permission.
no-permission-display-name: Display name for the no-permission reward item.
no-permission-lore: Lore description for the no-permission reward item.
Commands Executed on Reward Claim
actions: List of actions and commands executed when a reward is claimed. Find out more about the chances at randomization
80: Set of actions with 80% execution chance.
20: Actions with a 20% execution chance.
Reward Variants
variants: Optional reward variants based on player permissions.
premium: Example variant with specific permissions and actions.
Linking (displaying) a reward in the menu
The created and set reward can be displayed in the menu. The guis.yml file is used for this purpose.
Each reward can be assigned a position in the spcific menu. In the case of rewards that have more than one position (Advent Calendar, Streak Rewards, Pickable Reward, etc...) you can specify individual sub-rewards.
Last updated