Pickaxe Quality

Pickaxe Quality

The Pickaxe Quality module adds a permanent, buyable tier to every pickaxe. Each tier multiplies everything that pickaxe earns while mining — currency, pickaxe experience and Battle Pass XP. Quality is stored on the pickaxe itself, so it is a real upgrade to a tool rather than a player stat.

---

Overview

Feature	Details
Storage	The pickaxe's own NBT (no database tables)
Tiers	Fully configurable — formula-generated or defined by hand
Cost	Any currency from currencies.yml, set per tier
Boosts	Mining currency, pickaxe experience, Battle Pass XP (each toggleable)
GUI	Config-driven menu, reachable from the pickaxe menu and a command
Default tier	Tier 0 — every existing pickaxe, with no bonus at all

Because the tier lives on the pickaxe, a player who loses their pickaxe loses its quality. Pair the module with the Soulbind enchant if you would rather they keep it.

---

Commands

/pickaxequality                        Open the Pickaxe Quality menu
/pickaxequality set <player> <tier>    Set a player's pickaxe quality tier (admin)

Aliases: /pquality, /pq

---

Permissions

Permission	Description
xprison.pickaxequality	Open the quality menu
xprison.pickaxequality.admin	Use /pickaxequality set

Individual tiers can additionally require their own permission — see permission below.

---

Placeholders

Placeholder	Description
%xprison_pickaxe_quality%	The pickaxe's current tier number
%xprison_pickaxe_quality_name%	The current tier's display name
%xprison_pickaxe_quality_max%	The highest configured tier
%xprison_pickaxe_quality_multiplier_<currency>%	The tier's multiplier for that currency

The pickaxe lore also understands %PickaxeQuality% and %PickaxeQualityName% — add either to pickaxe-lore in enchants.yml to show the tier on the tool itself.

---

Configuration Tips

Formula-generated tiers — the default setup generates ten tiers from a single curve. The variable in every formula is tier:

tier-formula:
  max-tier: 10
  cost-currency: tokens
  cost: '1000000 * pow(3, tier - 1)'
  display-name: '<gradient:#00E5FF:#00838F><bold>Tier %tier%</bold></gradient>'
  multipliers:
    tokens: '1 + 0.1 * tier'
    gems: '1 + 0.1 * tier'
    money: '1 + 0.1 * tier'
  pickaxe-exp-multiplier: '1 + 0.05 * tier'
  battlepass-xp-multiplier: '1 + 0.05 * tier'

With those values Tier 1 gives 1.1× and Tier 10 gives 2×. The cost curve must never get cheaper as tiers rise — if it does, the module falls back to the hand-written tiers section and logs a warning.

Per-tier overrides — anything set under tiers wins over the formula; anything left out keeps the generated value:

tiers:
  '5':
    cost-currency: gems
    cost: '250000'
    required-pickaxe-level: 150
    permission: 'xprison.pickaxequality.tier5'
  '10':
    rewards:
      - 'broadcast &b%player% &7has maxed out their pickaxe quality!'

Costs are read as text, so exponent notation ('2.5E30') is safe on OP-scale servers.

Defining every tier by hand — set tier-formula.cost to '' and the tiers section becomes the full definition. Each entry then needs at least a cost and a cost-currency.

Choosing what is boosted — the apply-to block turns each hook on or off independently:

apply-to:
  currencies: true      # mining currency (block rewards, sell enchants, AutoSell, Auto Miner)
  pickaxe-exp: true     # Pickaxe Levels experience
  battlepass-xp: true   # Battle Pass XP earned from mining

Quest progress is deliberately never multiplied — quest objectives count discrete actions ("mine 5,000 blocks"), so scaling them would change what the objective means.

Multiplier stacking — quality stacks multiplicatively with Pickaxe Skins and the Multipliers module. A Tier 10 pickaxe (2× tokens) with a 2.2× skin and a 1.5× global multiplier earns 2 × 2.2 × 1.5 = 6.6× tokens.

The menu — the whole quality_menu section is yours: title, size, filler, decorations, the info item, the upgrade buttons, the "maxed" item and the back button. An upgrade button's amount is either a number of tiers or max, which buys as many tiers as the player can currently afford.

The pickaxe-menu button — enchants.yml gains a quality_item block that opens this menu from the pickaxe menu. It sits in slot 3 by default; set enabled: false to remove it and use the command only.

---

Disabling the module

Set pickaxe_quality: false under modules in config.yml. The button disappears from the pickaxe menu, no multipliers are applied, and every pickaxe earns exactly what it earned before — tiers already bought stay on the tools and take effect again if the module is turned back on.