Guide to configure rewards for your levels
There are 9 built-in reward types currently: command, money, item, permission (requires LuckPerms), auraskills_stat and auraskills_xp (require AuraSkills), mythic_stat (requires MythicMobs), mmo_stat (requires MythicLib) and ecoskills_stat (requires EcoSkills).
Rewards are defined under the rewards section of a level matcher or a custom level in the Main config.
This is probably the most basic reward, and it probably also has the highest flexibility. Only use this reward type if you can't do what you want with a more specialized one.
rewards:
# You can name it as you want
my_reward:
type: command
# Command to execute
command: "[console] say {player} has levelled up! Yay!"
# How should the reward look like in level-up messages and menus?
display: "&8+&aShiny server message"
You can use multiple commands here at once like this:
command:
- "[console] say {player} has levelled up! Yay!"
- "[console] say {player} Congrats!"
Command rewards also support the amount / formula options like the number based rewards below. The calculated number can be used in the command and in the display with the {value}, {value_int} and {value_formatted} placeholders.
rewards:
my_reward:
type: command
formula: "{money} * 2"
command: "[console] eco give {player} {value_int}"
display: "&8+&a{value_formatted}$"
Command rewards are not corrected automatically by default, since the plugin can't know if a command was already executed for a player. If you need it, you can add a correction-condition to the reward. When a player's data is loaded (on join) and after /level reload, the condition is checked for every level the player has already reached that has this reward. If the condition is true, the command is executed again for that level.
rewards:
my_reward:
type: command
command: "[console] lp user {player} parent add vip"
# Supports PlaceholderAPI placeholders and the {level} placeholder
correction-condition: "%some_numeric_placeholder% == 0"
display: "&8+&aVIP rank"
The condition is checked on every login. Make sure it becomes false once the command has been executed, otherwise the command will run again every time the player joins.
See Command dispatcher for more details.
You can give money to the player using your preferred Economy provider (if the base Aurora plugin supports it). See the supported Economy providers
rewards:
# You can name it as you want
my-money-reward:
type: money
# Either use the formula or amount option
# amount will win if both of them are present
formula: "{money} * 2"
amount: 10000
# Economy provider to use (optional)
# If omitted, the default economy provider from AuroraLib is used
economy: "Vault"
# If your economy provider supports multiple currencies,
# you can specify here which one you want to use (optional)
currency: "coins"
# How should the reward look like in level-up messages and menus?
display: "&8+&a{value_formatted}$"
You can use every formula placeholder you defined in the main configuration inside the formula option. For display, you can use the calculated number with the {value} placeholder. You can use {value_int} for a non-decimal number or {value_formatted} (this is preferred over the others since it will format the number defined in the base Aurora plugin config file).
This reward is only usable if LuckPerms plugin is installed. You can give permissions as rewards. If you change your config, later on, new permissions will be automatically given to players who already reached the required levels. Formula placeholders can be used in the permission field.
rewards:
# You can name it as you want
my_perm_reward:
type: permission
# Permission to give
permission: "your.permission.here"
# What should be the permission value? If omitted then the default is true
value: true
# Optionally you can define LuckPerms contexts as well
contexts:
server: smp
# How should the reward look like in level-up messages and menus?
display: "&8+&fSome permission"
You can use multiple permissions here at once like this:
permission:
- "your.permission.here.{level}"
- "your.other.permission.here"
You can give items as rewards. It will be added to the player's inventory or if it doesn't fit there it will be dropped to the ground. To see what is possible here, please read Item config
rewards:
# You can name it as you want
my_item_reward:
type: item
# Item to give
item:
material: diamond
amount: 5
# Can be force/overflow/none. The default is none if omitted.
# force: add item to the player stash (/stash)
# overflow: only add items to the stash if they can't fit in the inventory
# none: add items to player inventory and drop the remaining that don't fit
stash: overflow
# How should the reward look like in level-up messages and menus?
display: "&8+&f5 diamonds"
You can also use the amount or formula option on the reward itself (not inside item) to give a calculated number of items, for example formula: "{level} * 2". If neither is set, the amount of the item is used.
This reward is only usable if AuraSkills plugin is installed. You can give stats as rewards. These stats will be auto-corrected for every player if you change your config later on.
rewards:
# You can name it as you want
stat-reward:
type: auraskills_stat
# Namespaced ID of the stat. You can check these in you AuraSkills config
# If you just provide text without a namespace, then this will be like
# auraskills/strength
stat: strength
# Either use the formula or amount option
# amount will win if both of them are present
formula: "{some_stat_formula} * 2"
amount: 3
# How should the reward look like in level-up messages and menus?
# You can use the stat symbol and name as placeholders just like you defined
# in your AuraSkills config
display: "&8+&4{value_formatted} {symbol} {stat}"
You can use every formula placeholder you defined in the main configuration inside the formula option. For display, you can use the calculated number with the {value} placeholder. You can use {value_int} for a non-decimal number or {value_formatted} (this is preferred over the others since it will format the number defined in the base Aurora plugin config file).
This reward is only usable if the AuraSkills plugin is installed. You can give skill XP as a reward. You can use the skill level as a placeholder in the formula.
rewards:
skill_xp:
type: auraskills_xp
# The skill you want to give XP for
skill: foraging
# Either use the formula or amount option
# amount will win if both of them are present
formula: '{skill_level} * 50 + 50'
amount: 300
# How should the reward look like in level-up messages and menus?
# You can use the skill as a placeholder just like you defined
# in your AuraSkills config
display: '&8+&6{value_formatted} {skill} skill XP'
For display, you can use the calculated number with the {value} placeholder. You can use {value_int} for a non-decimal number or {value_formatted} (this is preferred over the others since it will format the number defined in the base Aurora plugin config file).
This reward is only usable if MythicMobs plugin is installed. You can give stats as rewards. If you change your config later, these stats will be auto-corrected for every player. These are global player stats, that are always active once received. As far as I know, no other plugin besides the early alpha MythicRPG can do this.
rewards:
# You can name it as you want
stat-reward:
type: mythic_stat
# Mythic stat key
# Check this in your MythicMobs/stats.yml
stat: ATTACK_DAMAGE
# Can be ADDITIVE, ADDITIVE_MULTIPLIER, COMPOUND_MULTIPLIER or SETTER
# Check MythicMobs wiki for what they do
# By default it will be ADDITIVE if you don't specify
modifier: ADDITIVE
# Either use the formula or amount option
# amount will win if both of them are present
formula: "{some_stat_formula} * 2"
amount: 3
# How should the reward look like in level-up messages and menus?
# You can use the stat name and formatted tooltip as placeholders
# just like you defined in your MythicMobs config
# Use {stat} for just the stat name and {stat_display} for the number and the name
# formatted by MythicMobs
display: "&8+&4{value_formatted} {stat}"
You can use every formula placeholder you defined in the main configuration inside the formula option. For display, you can use the calculated number with the {value} placeholder. You can use {value_int} for a non-decimal number or {value_formatted} (this is preferred over the others since it will format the number defined in the base Aurora plugin config file).
This reward is only usable if MythicLib (formerly MMOLib) plugin is installed. You can give stats as rewards. If you change your config later, these stats will be auto-corrected for every player. These are global player stats, that are always active once received.
rewards:
# You can name it as you want
stat-reward:
type: mmo_stat
# MythicLib/MMOItems/MMOCore etc stat key
stat: MAX_HEALTH
# optional: FLAT or RELATIVE
# By default it will be FLAT if you don't specify
modifier: FLAT
# Either use the formula or amount option
# amount will win if both of them are present
formula: "{some_stat_formula} * 2"
amount: 3
# How should the reward look like in level-up messages and menus?
display: "&8+&4{value_formatted} max health"
You can use every formula placeholder you defined in the main configuration inside the formula option. For display, you can use the calculated number with the {value} placeholder. You can use {value_int} for a non-decimal number or {value_formatted} (this is preferred over the others since it will format the number defined in the base Aurora plugin config file).
This reward is only usable if EcoSkills plugin is installed. You can give stats as rewards. These stats will be auto-corrected for every player if you change your config later on.
rewards:
# You can name it as you want
stat-reward:
type: ecoskills_stat
# stat id
stat: health
# Either use the formula or amount option
# amount will win if both of them are present
formula: "{some_stat_formula} * 2"
amount: 3
# By default it is "add" if omitted. Can be "add" or "multiply"
# libreforge "add_stat" effect uses a hardcoded "add" for reference
operation: "add"
# How should it look like? {stat} is the name of the stat
display: "&8+&4{value_formatted} {stat}"
You can use every formula placeholder you defined in the main configuration inside the formula option. For display, you can use the calculated number with the {value} placeholder. You can use {value_int} for a non-decimal number or {value_formatted} (this is preferred over the others since it will format the number defined in the base Aurora plugin config file).