Pickaxe Settings

Pickaxe Settings

The Pickaxe Settings menu lets each player fine-tune how their own pickaxe behaves while mining. It is opened from a button in the enchant menu, and every setting is stored on the pickaxe itself (its NBT) — so the choices travel with the tool, each player controls their own experience, and nothing is written to a database.

A brand-new pickaxe starts from the defaults you choose in enchants.yml (pickaxe_settings.default-states). Once a player toggles a setting, their choice is remembered on that pickaxe.

---

Overview

Setting	What it does	Default
Last Minute Summary	Toggles the periodic "currencies earned from mining" summary (from the Mining Stats module) for this player	On
All Enchants Proc Message	When on, a short message is shown every time any enchant on the pickaxe procs	Off
Virtual Block Breaking	When on, area-enchant procs pay out without visually breaking blocks (reward-only)	Off
Enchant Animations	When on, enchant animations play when an enchant is activated	On
Hide Maxed Enchants	When on, enchants the player has finished are hidden from the pickaxe menu and the rest close up the gaps	Off
Enchant Notifications	A sub-menu that silences the proc message of individual enchants that send one	On (per enchant)

---

The settings

Last Minute Summary

Controls whether the periodic mining summary (see the Mining Stats module) is shown to this player. Turning it off hides the summary for that pickaxe only; other players are unaffected.

All Enchants Proc Message

A firehose message: when enabled, the player gets a short chat message (messages.all_proc_message, with %enchant%) on every proc of any enchant on their pickaxe. It is off by default because it is deliberately noisy — it is most useful for players who want to see exactly what is firing.

Virtual Block Breaking

When on, area / AoE enchant procs (Explosive, Layer, Nuke, Laser Beam, and every add-on AoE enchant such as the Animated Enchants packs, Drill and Cluster Bomb) pay the player their full reward without clearing the blocks in the world.

• The player still receives all currency / drops for the affected blocks.
• The blocks are left standing, and the break does not advance the mine's reset.

This is the smoothest, lowest-overhead way to mine on packet / virtual mines. It is off by default, so area enchants clear blocks in the world as normal until a player opts in. The setting applies uniformly to every area enchant, bundled or add-on.

Enchant Animations

When on, the visual animations that play when an enchant procs are shown; when off, they are suppressed while the enchant still fires and pays out normally. Turning it off is useful for players who want less on-screen clutter or a smoother client on heavy AoE mining.

It covers every area enchant — the bundled Explosive/Layer/Laser Beam effects and every add-on AoE enchant (the Animated Enchants packs, Cluster Bomb, Drill) — handled centrally, so any current or future AoE add-on obeys it automatically. Lucky Block's celebration particles/sound also obey it. Proc messages are a separate setting (see Enchant Notifications) and are not affected. On by default.

Hide Maxed Enchants

A late-game pickaxe menu is mostly MAX badges, which buries the handful of enchants the player is actually still buying. When this is on, finished enchants are dropped from the pickaxe menu and the survivors close up the gaps — a menu with four enchants left shows four icons in a row, not four icons scattered across two pages of empty slots.

An enchant only counts as finished when there is genuinely nothing left to do with it:

• it is at its maxLevel, and
• if it has prestige enabled, its prestige is also maxed.

So a maxed enchant that is ready to prestige stays visible — hiding it would take the prestige button with it. Enchants with no level ceiling are never hidden.

Because the grid compacts, each enchant's configured gui.slot / gui.page is ignored while the setting is on; enchants are laid out in enchant-id order across enchant_menu.enchant_slots. Turning it back off restores the exact layout you configured.

The refund (disenchant) menu and the admin /createpickaxe menu always show every enchant, regardless of this setting. Off by default.

Enchant Notifications

Some enchants send the player a message when they proc — for example Blessing and Charity (when their messagesEnabled is on), Double Blocks (Block Booster), and any area enchant configured with a message. The Enchant Notifications sub-menu lists exactly those enchants and lets the player silence each one individually.

Silencing an enchant here only turns off its message — the enchant still procs and still pays out. Enchants that never send a proc message do not appear in this menu.

---

Permissions

Permission	Description
xprison.enchants.settings	Open the Pickaxe Settings menu

The node is default-allow: players may open the menu unless it is explicitly set to false.

---

Configuration

Everything lives in enchants.yml:

• enchant_menu.settings_item — the button that opens the menu from the pickaxe menu (slot 5 by default; set enabled: false to remove it).
• pickaxe_settings — the menu itself: title, size, decorations, the five toggle items (summary_toggle, all_proc_toggle, virtual_break_toggle, animations_toggle, hide_maxed_toggle) and the notifications button. Each toggle has an enabled_state and a disabled_state (material / name / lore / custom_model_data).
• enchant_notifications — the per-enchant notification sub-menu: title, size, the slots the enchants are placed in, and the enabled_state / disabled_state templates (use %enchant% in their name/lore). If there are more notifying enchants than slots, the menu pages automatically — configure the navigation buttons with previous_page and next_page (both support %page% and %total_pages%). They only show up when there is more than one page.
• pickaxe_settings.default-states — the starting state for a pickaxe the player has never touched:

pickaxe_settings:
  default-states:
    summary: true
    all-proc-message: false
    virtual-break: false
    enchant-notifications: true
    enchant-animations: true
    hide-maxed: false

See the full enchants.yml reference for every field.

---

Notes

• Because the settings live on the pickaxe, a player who gets a new pickaxe starts again from the configured defaults. Pair with the Soulbind enchant if players should keep their tool (and its settings).
• Last Minute Summary requires the Mining Stats module to be enabled to have any effect.
• Virtual Block Breaking is a per-pickaxe form of the per-enchant removeBlocks option: where removeBlocks: false makes a single enchant reward-only for everyone, this setting lets an individual player make all of their area enchants reward-only.