⚙️ Configuration Reference – config.yml

This documentation explains each setting and its effect within the config.yml of ProgressiveUnlock.

🧭 General Settings

mode: xp

Defines whether the plugin is in xp mode (XP-based progression) or farming mode (item-collection based progression).

🪛 Debug & Updates

debug.enabled: false

Enables or disables debug logging. Useful for development or troubleshooting.

update.check_interval_minutes: 180

Interval (in minutes) at which the plugin checks for updates.

⚙️ Core Settings

settings.enchantUnlockedItems: true

If true, unlocked recipes are visually enchanted (shimmer effect) in /unlockmenu.

settings.showLockedRecipeMessage: true

If true, locked recipes are visible in the crafting menu with a lock indication.

settings.sendLockedRecipeMessage: true

If true, a chat message is sent when the player tries to craft a locked item.

🧪 Unlock Checks

These settings control when and how the plugin checks if the player has access to tools, blocks, projectiles, etc.

checkUnlocked.onInteract

• check: true – Check if the tool used during interaction is unlocked.
• sendMessage: true – Notify the player if it’s not unlocked.
• survivalModeOnly: true – Only enforce this in Survival mode.

checkUnlocked.onPlace

• check: false – Block placement is not checked by default.
• sendMessage: false – No message is sent if blocked.
• survivalModeOnly: true – Only applies in Survival mode.

checkUnlocked.onBreak

• check: true – Check if broken block is unlocked.
• sendMessage: false – No message by default.
• survivalModeOnly: true – Applies only in Survival.

checkUnlocked.onArmorEquip

• check: true – Check if player is allowed to equip a piece of armor.
• sendMessage: true – Notify if armor is locked.
• survivalModeOnly: true – Only in Survival.

checkUnlocked.onProjectile

Each type of projectile can be checked individually:

• arrows, trident, snowball, xpbottle, egg, ender_pearl
  • check: true – Enforces unlock requirement.
  • sendMessage: true – Sends a denial message.
  • survivalModeOnly: true – Applies only in Survival.

checkUnlocked.onPortal

• end, nether portals:
  • check: true – Player must unlock portal access.
  • sendMessage: true – Message shown when blocked.
  • survivalModeOnly: false – Applies in all modes.

checkUnlocked.onPotion

• check: true – Checks if potion effect is unlocked.
• sendMessage: true – Sends a warning if not.

checkUnlocked.onEntityActions

• check: true – Verifies if entity interaction (e.g., shearing, trading) is allowed.
• sendMessage: true
• survivalModeOnly: false

checkUnlocked.onPickup

• check: true – Prevents pickup of items that aren’t unlocked.
• sendMessage: true
• survivalModeOnly: false

🧑‍🤝‍🧑 XP Groups

If you want to add player/group into multiplier group, just set permission progressiveunlock.group.vip

Groups.VIP

• name: VIP group – Display name of the group.
• multiplier: 1.1 – Players in this group earn 10% more XP.

🧾 Command Aliases

aliases.playerxp

Alternative commands for /playerxp:

- xplevel
- exp
- xperience
- playerXP
- farming

aliases.unlockmenu

Alternative commands for /unlockmenu:

- crafting
- unlock

💬 Messages

These are shown to players during various events and situations:

playerXP: "&aYou are level {level}..."
levelUp: "&2 Congratulations!..."
noItemsCollected: "&c No items collected yet."
unlockPackHeader: "&b Needed items for unlock pack {pack}"
...

• Placeholders like {level}, {xp}, {nextXP}, {item}, {current}, {required} dynamically insert values.
• Each message corresponds to plugin actions such as unlocking items, crafting denied, tool restrictions, level-up messages, portal access, potion locks, etc.

🧭 GUI Menu Labels

These are texts shown inside the /unlockmenu GUI:

unlockedRecipes: "&eUnlocked Recipes - Page {page}"
searchItems: "&2Search"
nextPage: "&2Next page"
previousPage: "&2Previouss page"
...

• Includes labels for search input, locked/unlocked indicators, and level/pack info.

✅ Summary

This config file controls:

• Plugin mode (XP or Farming)
• Behavior of unlock checks
• Messaging and GUI
• Command aliases
• XP multipliers for permission groups

Make sure to reload the plugin after any config changes using /pu reload or restarting the server.