Custom Rewards
What are custom rewards?
Custom rewards are a feature that allows you to create your own rewards for the guilds.
An example is the ORANGE TAG color, which is originally available only for VIP guild leaders.
As other features, you can find the dedicated configuration file: rewards.yml.
How to configure the rewards system
rewards.yml
tags:
orange:
color: ORANGE
display-name: Orange
conditions:
- RANK:MASTER
- MC_PERMISSION:guilds.mvp++
max-members:
example:
amount: 5022
conditions:
- MC_PERMISSION:guilds.max-members.50
In this example, we can see how to create custom rewards like a TAG color and a max members upgrade.
We have set the reward options and the conditions to use them.
The RANK:MASTER is set to allow only the guild leader to be checked for the condition.
info
Check the Supported types section to check all the supported types.
Supported types
The conditions are available for all the rewards.
| Section | Type | Options | Description |
|---|---|---|---|
| tags | Guild TAG | color, display-name | The color and display name of the TAG. |
| max-members | Max members | amount | The maximum number of members for the guild. |
Condition types
Each condition type has its own format.
Usually, the format is TYPE:VALUE.
| Type | Description | Format | Values | Example |
|---|---|---|---|---|
| RANK | The rank of the player. | RANK:{type} | MASTER, DEFAULT, rank name | RANK:admin |
| RANK_PERM | The permission of the player's rank. | RANK_PERM:{permission} | Guild Rank Perm | RANK_PERM:modify-tag |
| MC_PERMISSION | The permission of the player. | MC_PERMISSION:{permission} | Any permission | MC_PERMISSION:guilds.mvp |