Skip to main content

Achievements

Version 1.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

info

There are two types of achievements:

  • CHALLENGE: Single tier
  • TIERED: Multiple tiers

The type is automatically determined by the number of tiers.

note

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

Required Fields​

type​

You can find all available task types here.

type: FISH

name​

The achievements's name, displayed in messages and menus.

name: "Lucky Catch"

description​

The achievement's description, displayed in messages and menus.

description:
  - "&fCatch an enchanted book"
  - "&fwhile fishing."

tiers​

A list of tiers, where each tier is identified by a unique number.
At least one tier is required.

  • required-amount: The amount of progress required to complete the tier.
  • rewards: A list of rewards for completing the tier. Click here for more information.
tiers:
  1:
    required-amount: 1
    rewards:
      - type: points
        amount: 5
  2:
    required-amount: 5
    rewards:
      - type: points
        amount: 10

Optional Fields​

weight​

The achievement's weight. Used to determine the default sorting order in menus.
Default: 1

weight: 5

permission​

A permission required to access the achievement.
Default: None

permission: "achievements.lucky-catch"

hidden​

If set to true, the achievement will be hidden from menus and kept secret.
Default: false

hidden: true

requirements​

Players must complete these achievements before they can access this achievement.
Default: None

Valid formats:

  • <id> - Requires all tiers of the achievement to be completed.
  • <id>:<tier> - Requires the specified tier of the achievement to be completed.
requirements:
  - "miner"
  - "farmer:3"

conditions​

A list of conditions that must be met in order to complete the achievement.
Click here for more information.

conditions:
  - type: game_modes
    game-modes:
      - SURVIVAL
  - type: items
    items:
      - ENCHANTED_BOOK

settings​

Additional settings for the achievement.

toast-message: Overrides the default toast message set in config.yml

  • icon: The icon displayed in the toast.
  • message: The message displayed in the toast.
  • type: You can choose between CHALLENGE, TASK or GOAL.
settings:
  toast-message:
    icon: ENCHANTED_BOOK
    message: "Custom toast message!"
    type: CHALLENGE

Example Configuration​

achievements/survival/challenges.yml
# Unique identifier. Don't modify it or players will lose their progress!
lucky-catch:
  type: FISH
  name: "Lucky Catch"
  description:
    - "&fCatch an enchanted book"
    - "&fwhile fishing."
  settings:
    toast-message:
      icon: ENCHANTED_BOOK
      message: "Custom toast message!"
      type: CHALLENGE
  conditions:
    - type: game_modes
      game-modes:
        - SURVIVAL
    - type: items
      items:
        - ENCHANTED_BOOK
  tiers:
    1:
      required-amount: 1
      rewards:
        - type: points
          amount: 5