Skip to main content

Create Exclusive Achievements - How-To

This page explains how to create one exclusive achievement line by line. Exclusive achievements are used for limited-time goals and render only the exclusive variant section.

Variant rule

For an Exclusive achievement, include exclusiveAchievements: and do not render seasonalAchievements: or tierAchievements:.

1. File Location

plugins/FioAchievements/achievementsCategory/nether/exclusives/exclusive_anchor_charge.yml
PartExplanation
netherCategory id.
exclusivesFolder used to organize exclusive achievement files.
exclusive_anchor_charge.ymlFile name. Default loaded id: nether:exclusive_anchor_charge.

2. Enabled And Settings

enabled: true

settings:
priority: 100
repeatable: false
max-completions: 1
hidden: false
secret: false
preserve-progress-when-disabled: true
require-player-online: true
allow-progress-overflow: false
progress-cooldown: 0
ignore-cancelled-events: true
stop-progress-after-completion: true
save-completion-date: true
auto-claim-reward: true
LineExplanation
enabled: trueLoads the exclusive achievement file.
settings:Starts per-achievement runtime options.
priority: 100Places this after lower-priority normal achievements.
repeatable: falsePrevents repeat completions.
max-completions: 1Allows one completion per player.
hidden: falseShows the achievement while locked.
secret: falseShows the objective text.
preserve-progress-when-disabled: trueKeeps progress when disabled later.
require-player-online: trueOnly online players can receive progress.
allow-progress-overflow: falseCaps progress at the target amount.
progress-cooldown: 0No delay between progress gains.
ignore-cancelled-events: trueIgnores cancelled events where supported.
stop-progress-after-completion: trueStops progress after completion.
save-completion-date: trueStores completion date for {date_completion}.
auto-claim-reward: trueRuns rewards automatically on completion.

3. Exclusive Selection

exclusiveAchievements:
enabled: true
stopProgress: true
hideIfLocked: true
exclusiveOnly:
date: "31/DEC/2026"
time: "11:59 PM"
LineExplanation
exclusiveAchievements:Starts the exclusive-only selection section.
enabled: trueMarks this achievement as exclusive.
stopProgress: trueStops progress after the exclusive date and time.
hideIfLocked: trueHides expired locked achievements from players who did not complete them.
exclusiveOnly:Starts expiry settings.
date: "31/DEC/2026"Expiry date using DD/MON/YYYY.
time: "11:59 PM"Expiry time using H:MM AM/PM.

4. Exclusive Items

items:
locked:
material: COAL
amount: 1
behavior:
model-data: 0
glow: false
name: "<red>Exclusive Anchor Charge</red>"
lore:
- "<dark_gray>{category} Exclusive</dark_gray>"
- ""
- "<gray>Charge a respawn anchor 4 times</gray>"
- "<gray>during the exclusive event.</gray>"
- ""
- "<gray>Rewards:</gray>"
- "%rewards%"
- ""
- "<#919191>Unlocked by {percent}% players"
- "<#919191>on this server."
- ""
- "<#a83434>This achievement is exclusive."
- ""
- "<red>Locked</red>"
LineExplanation
items:Starts GUI item states.
locked:Item shown before completion.
material: COALLocked icon material.
amount: 1Stack amount.
behavior:Visual behavior options.
model-data: 0No CustomModelData.
glow: falseNo locked glow.
name:Locked display name.
{category}Replaced by the category alias where supported.
%rewards%Injects reward display lines.
{percent}Server unlock percentage.
This achievement is exclusive.Player-facing limited availability note.
completed:
material: RESPAWN_ANCHOR
amount: 1
behavior:
model-data: 0
glow: false
flags:
- HIDE_ATTRIBUTES
name: "<green>Exclusive Anchor Charge</green>"
lore:
- "<dark_gray>{category} Exclusive</dark_gray>"
- ""
- "<gray>Charge a respawn anchor 4 times</gray>"
- "<gray>during the exclusive event.</gray>"
- ""
- "<#7a7676>You achieved this at: {date_completion}"
- ""
- "<green>Unlocked</green>"

claim:
material: RESPAWN_ANCHOR
amount: 1
behavior:
model-data: 0
glow: true
flags:
- HIDE_ATTRIBUTES
name: "<green>Exclusive Anchor Charge</green>"
lore:
- "<dark_gray>{category} Exclusive</dark_gray>"
- ""
- "<green>Claim your Rewards</green>"
LineExplanation
completed:Item shown after completion.
material: RESPAWN_ANCHORCompleted icon matching the objective.
flags:Starts Bukkit item flags.
HIDE_ATTRIBUTESHides default item attributes in the GUI.
claim:Item shown when rewards can be claimed.
glow: trueHighlights the claim state.

5. Rewards And Task

Use Actions Reference when choosing values for required and while.

rewards:
"1":
name:
- "<dark_gray>+</dark_gray><yellow>27</yellow> <gray>Achievement Points</gray>"
achievementTasks:
required:
- "USE;RESPAWN_ANCHOR;CHARGE;4"
while: []
placeholderRules: []
afterCompletion:
- "[CONSOLE] exp give %player_name% 27"
- "[SOUND] ITEM_GOAT_HORN_SOUND_0 1 2 master"
- "[MESSAGE] <gray>Congratulations, you completed <gradient:#00FF00:#FF00FF:#7289da>Exclusive Anchor Charge</gradient>.</gray>"
- "[FIOACHIEVEMENTS] Points+27"
LineExplanation
rewards:Starts reward groups.
"1":Main reward group.
name:Reward display lines.
achievementTasks:Starts progress rules.
required:Required action list.
USE;RESPAWN_ANCHOR;CHARGE;4Tracks charging a respawn anchor 4 times. Format: USE;<MATERIAL>;<ACTION>;<AMOUNT>.
while: []No extra live condition required.
placeholderRules: []No PlaceholderAPI condition checks.
afterCompletion:Completion actions.
[FIOACHIEVEMENTS] Points+27Adds 27 achievement points.

6. Broadcast

broadcast:
enabled: true
mode: GLOBAL
message:
- "<green>%player_name% completed exclusive achievement <yellow>Exclusive Anchor Charge</yellow>"
radius: 100
permission: "achievements.broadcast.receive"
hover:
enabled: true
text:
- "<green>Exclusive Anchor Charge</green>"
- "<gray>Charge a respawn anchor 4 times during the exclusive event.</gray>"
click:
enabled: true
action: RUN_COMMAND
value: "/fioachievements view %player_name%"
LineExplanation
broadcast:Starts completion broadcast settings.
enabled: trueEnables the broadcast.
mode: GLOBALSends to all online players.
message:Exclusive completion text.
hover:Adds hover details.
click:Adds click behavior.
value:Opens the completing player's achievement view.

7. Required Global Option

achievements:
otherUniqueAchievements:
enable-exclusive-achievements: true
LineExplanation
enable-exclusive-achievements: trueMakes Exclusive Achievements buttons and views visible.

8. Reload

/fioachievements admin reload
/fioachievements open

Complete File

enabled: true

settings:
priority: 100
repeatable: false
max-completions: 1
hidden: false
secret: false
preserve-progress-when-disabled: true
require-player-online: true
allow-progress-overflow: false
progress-cooldown: 0
ignore-cancelled-events: true
stop-progress-after-completion: true
save-completion-date: true
auto-claim-reward: true

exclusiveAchievements:
enabled: true
stopProgress: true
hideIfLocked: true
exclusiveOnly:
date: "31/DEC/2026"
time: "11:59 PM"

items:
locked:
material: COAL
amount: 1
behavior:
model-data: 0
glow: false
name: "<red>Exclusive Anchor Charge</red>"
lore:
- "<dark_gray>{category} Exclusive</dark_gray>"
- ""
- "<gray>Charge a respawn anchor 4 times</gray>"
- "<gray>during the exclusive event.</gray>"
- ""
- "<gray>Rewards:</gray>"
- "%rewards%"
- ""
- "<#919191>Unlocked by {percent}% players"
- "<#919191>on this server."
- ""
- "<#a83434>This achievement is exclusive."
- ""
- "<red>Locked</red>"
completed:
material: RESPAWN_ANCHOR
amount: 1
behavior:
model-data: 0
glow: false
flags:
- HIDE_ATTRIBUTES
name: "<green>Exclusive Anchor Charge</green>"
lore:
- "<dark_gray>{category} Exclusive</dark_gray>"
- ""
- "<gray>Charge a respawn anchor 4 times</gray>"
- "<gray>during the exclusive event.</gray>"
- ""
- "<#7a7676>You achieved this at: {date_completion}"
- ""
- "<green>Unlocked</green>"
claim:
material: RESPAWN_ANCHOR
amount: 1
behavior:
model-data: 0
glow: true
flags:
- HIDE_ATTRIBUTES
name: "<green>Exclusive Anchor Charge</green>"
lore:
- "<dark_gray>{category} Exclusive</dark_gray>"
- ""
- "<green>Claim your Rewards</green>"
rewards:
"1":
name:
- "<dark_gray>+</dark_gray><yellow>27</yellow> <gray>Achievement Points</gray>"
achievementTasks:
required:
- "USE;RESPAWN_ANCHOR;CHARGE;4"
while: []
placeholderRules: []
afterCompletion:
- "[CONSOLE] exp give %player_name% 27"
- "[SOUND] ITEM_GOAT_HORN_SOUND_0 1 2 master"
- "[MESSAGE] <gray>Congratulations, you completed <gradient:#00FF00:#FF00FF:#7289da>Exclusive Anchor Charge</gradient>.</gray>"
- "[FIOACHIEVEMENTS] Points+27"

broadcast:
enabled: true
mode: GLOBAL
message:
- "<green>%player_name% completed exclusive achievement <yellow>Exclusive Anchor Charge</yellow>"
radius: 100
permission: "achievements.broadcast.receive"
hover:
enabled: true
text:
- "<green>Exclusive Anchor Charge</green>"
- "<gray>Charge a respawn anchor 4 times during the exclusive event.</gray>"
click:
enabled: true
action: RUN_COMMAND
value: "/fioachievements view %player_name%"