GitLab

Custom achievements are created using simple .yml files, and anyone familiar with Mythic syntax should be able to pick up on how it works pretty quickly!

File Locations

MythicAchievements will load achievements from 2 places:

• The Achievements folder in the MythicAchievements plugin directory
• Any Achievements folder in a Mythic pack (located in the MythicMobs plugin directory)

Inside these folders you can have as many .yml files as you want, including inside other folders, allowing you to organize it however you want. The plugin will read all the files to load everything.

Syntax

First, here's an overview of all the options:

KEY:
  Display: 'the display name'
  Description: 'the description'
  Category: [CATEGORY_KEY]
  Parent: [PARENT_ACHIEVEMENT_KEY]
  Frame: [CHALLENGE/GOAL/TASK]
  Icon:
    Material: [MATERIAL]
  Criteria:
    SOME_KEY_NAME_YOU_CHOOSE:
      Type: [CRITERIA_TYPE]
      #
      # other criteria-related options
      #
  Reward:
    Message: 'A message displayed when they complete it!'
    Drops:
    - [ a Mythic drop table]
    Skills:
    - [ some skills ran when the achievement is completed ]1

Examples

Killing 5 Skeletons at Night

In this example achievement, the player can earn it by killing 5 skeletons at night, but it's only available if they have completed the achievement SOME_OTHER_ACHIEVEMENT!

Upon completing, they will receive 50 cobblestone as a reward.

SKELETON_HUNTER:
  Display: 'Skeleton Hunter'
  Description: 'Kill 5 Skeletons at Night'
  Category: SPECIAL
  Parent: SOME_OTHER_ACHIEVEMENT
  Frame: CHALLENGE
  Icon:
    Material: SKELETON_SKULL
  Criteria:
    KILL:
      Type: KILL_MOB_TYPE
      EntityType: SKELETON
      Amount: 5
      Conditions:
      - night
  Reward:
    Message: 'You did it! You killed 5 skeletons at night!'
    Drops:
    - 50 cobblestone
    Skills: []

Breaking 10 Stone and 10 Dirt

A simple example demonstrating an achievement that has multiple criteria. The player must break 10 stone and 10 dirt to complete it!

BREAK_STONE_AND_DIRT:
  Display: 'Breaking Stone and Dirt'
  Description: 'Break 10 Stone Blocks and 10 Dirt'
  Category: SPECIAL
  Parent: BREAK_TEN_STONE
  Frame: GOAL
  Icon:
    Material: COBBLESTONE  
  Criteria:
    STONE:
      Type: BREAK_BLOCK
      Block: STONE
      Amount: 10
    DIRT:
      Type: BREAK_BLOCK
      Block: DIRT
      Amount: 10
  Reward:
    Message: 'You broke a bunch of stuff!'
    Drops: []
    Skills: []