Achievements

info

There are two types of achievements:

• CHALLENGE - Single tier
• TIERED - Multiple tiers

The type is automatically determined by the number of tiers.

v2.0

note

Achievements are located in the plugins/EpicAchievements/achievements/<category> folder.
You can have as many achievement files as you want in a category.

Below is an example of an achievement configuration:

achievements/survival/challenges.yml

# Unique identifier. Don't modify it or players will lose their progress!
lucky-catch:
  # The type of task
  # See https://wiki.pixelstudios.dev/epicachievements/configuration/tasks
  type: FISH
  # The achievement's name
  name: "Lucky Catch"
  # The achievement's description
  description:
    - "&fCatch an enchanted book"
    - "&fwhile fishing."
  # (Optional) The achievement's weight
  # This determines the default sorting order in the menu
  # The default weight is 1
  # weight: 10

  # (Optional) Permission required to access the achievement
  # permission: achievements.lucky-catch

  # (Optional) Required achievements to access this achievement
  # requirements:
  #   - "miner" # Requires all tiers to be completed
  #   - "farmer:1" # Requires the first tier to be completed

  # A list of conditions
  # See https://wiki.pixelstudios.dev/epicachievements/configuration/conditions
  conditions:
    - type: game_modes
      game-modes:
        - SURVIVAL
    - type: items
      items:
        - ENCHANTED_BOOK
  # A list of tiers (at least one tier is required)
  tiers:
    1:
      # Progress required to complete the tier
      required-amount: 1
      # A list of rewards. See https://wiki.pixelstudios.dev/epicachievements/configuration/rewards
      rewards:
        - type: points
          amount: 5
    # More tiers can be added below:
    # 2:
    #   required-amount: 3
    #   rewards:
    #     - type: points
    #       amount: 10

v1.0

Interactive setup

The easiest way to create and edit achievements is by using the in-game editor.

You can access it by typing /achievements editor.

Manually editing configurations

If you're a more advanced user, you can manually edit the achievements' configurations.

note

Achievements are located in the plugins/EpicAchievements/achievements/<category> folder.
You can have as many achievement files as you want in a category.
By default, the in-game editor will create new achievements in a file named achievements.yml if none exists.

Below is an example of an achievement configuration:

achievements/survival/achievements.yml

# Unique identifier. Don't modify it or players will lose their progress!
builder:
  # The type of task: See https://wiki.pixelstudios.dev/epicachievements/configuration/tasks
  type: PLACE
  # The name used in messages and menus
  name: "Builder"
  # The description of the achievement
  description:
    - "&fPlace blocks."
  # (Optional) Permission required to progress in the achievement
  permission: achievements.builder
  # Required achievements to progress in this achievement
  required-achievements:
    - miner
    - farmer
  # Conditions: See https://wiki.pixelstudios.dev/epicachievements/configuration/conditions
  blocks:
    - STONE_BRICKS
    - BRICKS
  worlds:
    - world
    - resource_world
  game-modes:
    - SURVIVAL
  # A list of tiers. There must be at least one tier
  tiers:
    1:
      # Progress required to complete the tier
      required-amount: 10
      # Points awarded when completing the tier
      points: 25
      # A list of rewards. See https://wiki.pixelstudios.dev/epicachievements/configuration/rewards
      # Format: REWARD_TYPE:VALUE
      rewards:
        - "VAULT:100"
        - "COMMAND:say {player} has completed the Builder achievement!"
      # Other tiers can be added below