Rewards

Version 1.0

EpicAchievements offers a bunch of built-in rewards.
Below is a list of them:

tip

You can use the {player} placeholder in all rewards.

Reward	Description
BROADCAST	Broadcast a message to the server
COMMAND	Execute a console command
EXPERIENCE_LEVELS	Give experience levels to a player
EXPERIENCE	Give experience points to a player
MESSAGE	Send a message to a player
VAULT	Give money to a player
PLAYER_POINTS	Give money to a player

Reward leveling system

Using the points earned by completing achievements, players can unlock rewards.
Below is an example configuration:

tip

You can use the {level} placeholder to get the current level.
Math expressions and functions are supported!

rewards.yml

rewards:
  # Range of levels
  1-100:
    # Points required to unlock the reward. Math expressions are supported!
    required-points: "{level} * 100"
    # A list of rewards
    rewards:
      - "VAULT:{level} * 10"
    # Item displayed when the reward is locked
    locked-item:
      material: "COAL"
      name: "&cAchievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Reward:"
        - "{rewards}"
        - ""
        - "{status}"
    # Item displayed when the reward has been claimed
    claimed-item:
      material: "GOLD_NUGGET"
      name: "&aAchievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&aYou have already claimed this reward!"
    # Item displayed when the reward has not been claimed
    not-claimed-item:
      material: "GOLD_NUGGET"
      name: "&eAchievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&eClick to claim this reward!"
      glow: true
  # Other levels can be added below

EpicAchievements offers a bunch of built-in reward types:

tip

You can use the {player} and {uuid} placeholders in all rewards.

Reward	Description	Required arguments
points	Give achievement points to a player Points are used to unlock rewards!	amount
action_bar	Send an action bar message	message
broadcast	Broadcast a message to the server	message
command	Execute a console command	command
experience_levels	Give experience levels to a player	amount
experience	Give experience points to a player	amount
item	Give an item to a player	item
message	Send a message to a player	message
title	Send a title to a player	title subtitle

Plugin Hooks

Plugin	Reward	Description	Required arguments
Vault	vault	Give money to a player	amount
PlayerPoints	player_points	Give points to a player	amount

Customizing reward descriptions

Reward descriptions displayed in menus can be customized to override the default description defined in rewards.yml:

rewards:
  - type: points
    amount: 10
    # Override the default description
    # The {amount} placeholder is available
    description: "&8+ &7A nice gift!"

The reward leveling system

Using the points earned by completing achievements, players can unlock rewards.
Multiple reward types can be defined: the example below includes normal and special rewards.

tip

You can use the {level} placeholder to get the current level.
Math expressions and functions are supported!

rewards.yml

# Define below the rewards for each level.
rewards:
  normal:
    levels:
      from: 1
      to: 48
      # (Optional) Define the increment between levels. Default is 1.
      # step: 1
    # Number of points required to claim the reward.
    required-points: "{level} * 100"
    # (Optional) If a level has multiple rewards defined, the one with the highest weight will be used.
    # weight: 1
    # The list of rewards.
    rewards:
      - type: vault
        amount: "{level} * 10"
    locked:
      material: "COAL"
      name: "&cNormal Achievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&cYou can't claim this yet!"
    claimed:
      material: "GOLD_NUGGET"
      name: "&aNormal Achievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&aYou have already claimed this reward!"
    unclaimed:
      material: "GOLD_NUGGET"
      name: "&eNormal Achievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&eClick to claim this reward!"
      glow: true

  special:
    levels:
      from: 5
      to: 48
      step: 5
    required-points: "{level} * 100"
    weight: 2
    rewards:
      - type: vault
        amount: "{level} * 20"
    locked:
      material: "COAL_BLOCK"
      name: "&cSpecial Achievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&cYou can't claim this yet!"
    claimed:
      material: "GOLD_BLOCK"
      name: "&aSpecial Achievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&aYou have already claimed this reward!"
    unclaimed:
      material: "GOLD_BLOCK"
      name: "&eSpecial Achievement Reward"
      lore:
        - "&8Level {level}"
        - "&7Required Points: &e{points}"
        - ""
        - "&7Rewards:"
        - "{rewards}"
        - ""
        - "&eClick to claim this reward!"
      glow: true