xPickaxes

⛏️ xPickaxes

xPickaxes is a professional Spigot/Paper plugin that adds fully customizable pickaxes with area mining, an intuitive GUI, permission-based access, and special effects — all configurable without touching a single line of Java.

> Compatible with Minecraft 1.19 – 1.21+ (Paper & Spigot)

---

✨ Features

- Fully Config-Driven — Mine 3×3, 5×5, 7×7, or 9×9 areas with a single block break - Fully Config-Driven — Right-click any custom pickaxe to open a clean configuration menu - Fully Config-Driven - 🔥 Fully Config-Driven — Ores are smelted directly into ingots - ✨ Fully Config-Driven — Increased drops on all mined blocks - ⛏ Fully Config-Driven — Mines entire connected ore veins at once (up to 64 blocks) - 🔍 Fully Config-Driven — Visual glow effect on nearby ores *(framework ready)* - Fully Config-Driven — Each player can toggle area mining and effects individually - Fully Config-Driven — Fine-grained control over which players access which pickaxes and effects - Fully Config-Driven — Players can choose their preferred area size from the GUI - Fully Config-Driven — Prevent area mining on specific blocks (bedrock, command blocks, etc.) - Fully Config-Driven — Respects protected regions - Fully Config-Driven — Satisfying feedback on area mines (toggleable) - Fully Config-Driven — Add or edit pickaxe types entirely from `config.yml`

---

📦 Pickaxe Tiers

| Tier | Area | Material | Effects | Permission | |------|------|----------|---------|------------| | Titan | 3×3 | Iron Pickaxe | — | `xpickaxes.pickaxe.novice` | | Titan | 5×5 | Golden Pickaxe | Fortune Boost | `xpickaxes.pickaxe.adept` | | Titan | 7×7 | Diamond Pickaxe | Fortune + Auto-Smelting | `xpickaxes.pickaxe.master` | | Titan | 9×9 | Netherite Pickaxe | Fortune + Auto-Smelting + Vein Miner | `xpickaxes.pickaxe.titan` |

All tiers are fully editable or removable in `config.yml`. You can also add your own!

---

🎮 Commands

| Command | Description | Permission | |---------|-------------|------------| | `/xpickaxe give <type> [player]` | Give a custom pickaxe | `xpickaxes.give` | | `/xpickaxe list` | List all available pickaxe types | `xpickaxes.use` | | `/xpickaxe menu` | Open the GUI for your held pickaxe | `xpickaxes.use` | | `/xpickaxe reload` | Reload the plugin config | `xpickaxes.reload` | | `/xpickaxe help` | Show help | — |

Aliases: `/xpick`, `/xp`

---

🔑 Permissions

| Permission | Default | Description | |------------|---------|-------------| | `xpickaxes.use` | Everyone | Use custom pickaxes | | `xpickaxes.give` | OP | Give custom pickaxes | | `xpickaxes.reload` | OP | Reload the plugin | | `xpickaxes.admin` | OP | Full admin access (includes give + reload) | | `xpickaxes.pickaxe.novice` | Everyone | Access to Novice pickaxe | | `xpickaxes.pickaxe.adept` | OP | Access to Adept pickaxe | | `xpickaxes.pickaxe.master` | OP | Access to Master pickaxe | | `xpickaxes.pickaxe.titan` | OP | Access to Titan pickaxe | | `xpickaxes.effect.autosmelting` | OP | Use Auto-Smelting effect | | `xpickaxes.effect.veinminer` | OP | Use Vein Miner effect | | `xpickaxes.effect.fortune` | OP | Use Fortune Boost effect | | `xpickaxes.effect.xray` | OP | Use Ore Highlight effect |

---

🖥️ GUI Overview

Right-click any xPickaxes custom pickaxe (or run `/xpickaxe menu`) to open the configuration panel:

``` ┌─────────────────────────────────────────────────────┐ │ [Pickaxe] [Pickaxe Configuration] │ │ │ │ [Toggle Area] [Compass] [3x3][5x5][7x7][9x9][✗]│ │ │ │ [★] [Effect1] [Effect2] [Effect3] [Effect4] │ │ │ │ [ℹ Info] │ │ [✖ Close] │ └─────────────────────────────────────────────────────┘ ```

- Effects — Enable/disable area mining for this session - Effects — Select 3×3, 5×5, 7×7, or 9×9 (or reset to pickaxe default) - Effects — Toggle each special effect independently (respects permissions)

---

⚙️ Configuration

All pickaxe types, effects, messages, and behavior is defined in `config.yml`. Here's an example of adding a custom pickaxe:

```yaml pickaxes: my_custom_pick: enabled: true display-name: "&5✦ Void Pickaxe" lore: - "&7Area Mining: &e11x11" - "" - "&8▸ Right-click to configure" material: NETHERITE_PICKAXE area-size: 11 durability-multiplier: 4.0 enchantments: EFFICIENCY: 5 UNBREAKING: 3 FORTUNE: 3 effects: - FORTUNE - AUTOSMELTING - VEINMINER permission: myplugin.voidpickaxe give-command-enabled: true custom-model-data: 0 ```

Auto-Smelt Mappings

Add custom smelting recipes in `config.yml`:

```yaml smelt-map: IRON_ORE: IRON_INGOT GOLD_ORE: GOLD_INGOT SAND: GLASS

Add your own!

```

---

🔧 Installation

1. Download `xPickaxes-1.0.0.jar` 2. Drop it into your `plugins/` folder 3. Restart or reload your server 4. Edit `plugins/xPickaxes/config.yml` to customize 5. Run `/xpickaxe reload` to apply changes live

Requirements: - Java 17+ - Paper or Spigot 1.19+