Rewards

Guide to configure rewards for your collection levels

There are 4 built-in reward types currently. Money, Permission (requires LuckPerms), Command, and AuraSkills stat.

Command reward

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.

Syntax:

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 prefixes

See Command dispatcher for more details.

Money reward

You can give money to the player using your preferred Economy provider (if the base Aurora plugin supports it). See the supported Economy providers

Syntax:

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: "{level} * 2"
    amount: 10000
    # Economy provider to use (optional)
    ecomoy: "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}$"

Placeholders

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

Permission reward

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. Collection placeholders can be used in the permission field.

Syntax:

rewards:
  # You can name it as you want        
  my_perm_reward:
    type: permission
    # Permission to give
    permission: "your.permission.here.{level}"
    # 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"
  - "your.permission.here.other"

Item reward

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+&fSome permission)"

AuroraLevels XP reward

You can give XP for AuroraLevels.

rewards:
  my-xp-reward:
    type: levels_xp
    # Amount or formula. Amount will win if both are present
    amount: 5
    formula: "ceil(5 + 5 * ({level_raw} - 1) * (log(1 + {level_raw}) / log(2)))"
    display: "&8+&f{value_formatted} Global XP"

Placeholders

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

AuraSkills Stat reward

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.

Syntax:

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: "{level} * 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 you AuraSkills config 
    display: "&8+&4{value_formatted} {symbol} {stat}"

Placeholders

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

AuraSkills skill XP reward

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.

Syntax:

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'

Placeholders

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

MMOLib/MMOItems Stat reward (MythicLib)

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.

Syntax:

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"

Formula placeholders

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

MythicMobs Stat reward

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.

Syntax:

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
    # Check MythicMobs wiki for the available values
    # 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}"

Formula placeholders

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