config.yml

Global settings. After editing, run /milestonesadmin reload.

This file is deliberately small. There is no global milestone-icon block: every category defines its own in its own file, and the menu’s temporary icons live in the menu file.

A key you remove falls back to the default shown below.

Settings

Settings:
  Save-Interval: 60
  Notify-Interval: 3

Key	Default	Description
Save-Interval	60	Seconds between saves of changed player data to the database. 0 or less turns the timer off; data is then saved only on quit, on shutdown and on claims. Claims are always saved immediately regardless of this.
Notify-Interval	3	Seconds between unlock checks. Every online player’s progress is compared against every enabled category, and any milestone that just became claimable sends MILESTONE-UNLOCKED. Minimum 1.

Notify-Interval and PLACEHOLDER categories

Each check resolves every PLACEHOLDER category’s placeholder once per online player. With many players or a slow expansion, raising this to 5-10 cuts that work proportionally. Unlock messages just arrive a little later.

Progress-Bar

The bar rendered into {progress-bar} in milestone icons, selector icons and menu items.

Progress-Bar:
  Length: 30
  Symbol: "|"
  Complete-Color: "&a"
  Remaining-Color: "&c"

Key	Default	Description
Length	30	Number of symbols in the bar. At least 1.
Symbol	|	The character repeated. Any string works.
Complete-Color	&a	Color of the filled part.
Remaining-Color	&c	Color of the empty part.

The fill is capped at 100%, and a Required of 0 renders as a full bar. {percent} is the same ratio as a two-decimal number (42.50), without a % sign - add your own.

What the bar measures depends on where it is used:

Used in	Measures
A milestone icon	The player’s progress against that milestone’s Required.
A category selector icon, a menu item	Milestones claimed out of the category’s total.

Inventories-Sounds

Named sounds in "NAME;volume;pitch" form. The name is a Bukkit sound name like ENTITY_PLAYER_LEVELUP or a sound key like entity.player.levelup. Volume and pitch are optional and default to 1. Set a key to "" to silence it. A key you delete plays its default again.

Inventories-Sounds:
  "MENU-OPEN": "ENTITY_BAT_TAKEOFF;1;0.5"
  "CLAIM": "ENTITY_PLAYER_LEVELUP;1;1.5"
  "MILESTONE-UNLOCKED": "UI_TOAST_CHALLENGE_COMPLETE;1;1"
  "CATEGORY-CHANGED": "ENTITY_CHICKEN_EGG;1;1"
  "PAGE-CHANGED": "ENTITY_CHICKEN_EGG;1;1"
  "NO-PAGE-FOUND": "BLOCK_NOTE_BLOCK_PLING;1;0.5"
  "DENY": "ENTITY_VILLAGER_NO;1;0.5"

Key	Played when
MENU-OPEN	/milestones opens the menu.
CLAIM	A milestone is claimed.
MILESTONE-UNLOCKED	Progress reaches a milestone (alongside the MILESTONE-UNLOCKED message).
CATEGORY-CHANGED	The player switches to another category in the menu.
PAGE-CHANGED	A page turn succeeds.
NO-PAGE-FOUND	A page turn is refused on the first or last page.
DENY	A claim is refused, or the category already being viewed is clicked.

An unknown sound name or a non-numeric volume or pitch fails the load.