⛏️ VeinBreaker

Mine entire ore veins, geode formations, and cave structures, fell whole trees, harvest crops, and place blocks with outward ripple animations.

A lightweight, highly configurable quality-of-life plugin built for survival servers.

🌐 Website · 🐛 Report a Bug · 💡 Request a Feature

🎬 Live Demo

✨ Features

📦 Installation

1. Download the latest VeinBreaker-2.0.0.jar from the Releases page.
2. Place the JAR into your server's plugins/ directory.
3. Restart or reload your server.
4. Customize plugins/VeinBreaker/config.yml to your liking.
5. Execute /vb reload to apply configuration changes instantly without a server restart.

Requirements:

• Minecraft 1.21.x - 26.2
• Spigot or Paper (Paper highly recommended for optimal scheduler performance)
• Java 21+

🎮 Commands

All commands support both /veinbreaker and the shorthand /vb.

🔑 Permissions

[!TIP] You can add custom permission nodes from third-party plugins directly in config.yml under permissions.use or via /vb permission add <node>.

🔍 In-Depth Features

⛏️ Ore, Geode & Cave Mining

VeinBreaker groups connected blocks by mineral family:

• Ores: Coal, Iron, Copper, Gold, Redstone, Lapis, Diamond, Emerald, Nether Gold, Nether Quartz, Ancient Debris, and Deepslate variants.
• Raw Ore Blocks: Mega cave veins containing RAW_IRON_BLOCK, RAW_COPPER_BLOCK, and RAW_GOLD_BLOCK.
• Geodes: Amethyst blocks, budding amethyst, amethyst clusters, small/medium/large buds, calcite, and smooth basalt.
• Cave Features: Pointed dripstone, dripstone blocks, glow lichen, tuff variants, and deep dark sculk formations (SCULK, SCULK_CATALYST, SCULK_SENSOR, SCULK_SHRIEKER, SCULK_VEIN).
• Budding Protection: Enable features.protect-budding-amethyst: true to prevent players from accidentally mining crystal spawning blocks.
• Proximity Detection: 3x3x3 26-neighbor scanning bridges diagonal corners so naturally generated veins aren't cut short.

🌊 Progressive Ripple Animation & Particle Juice

Instead of instantaneous, jarring mass block breaks, VeinBreaker can radiate outwards:

• Configurable Wave Timing: Adjust delay-ticks (default: 1 tick = 0.05s) and blocks-per-step (default: 2 blocks).
• Sort Origin: Ripple outward from the player's position (PLAYER) or the clicked block (ORIGIN).
• Acoustic Pitch Cascade: Sound effects incrementally shift in pitch throughout the wave to create a satisfying ripple chime.
• Multi-Layer Particles:
  • Native Block Destruction: Calls Minecraft's level break event (Effect.STEP_SOUND) visible on all clients.
  • Dynamic Fracture Burst: 25 directional Particle.BLOCK particles with velocity.
  • Mineral Sparkle Accents: End Rod stars for Amethyst, Soul wisps for Sculk, Crit sparkles for Diamonds/Emeralds, and Enchanted glints for Gold/Copper/Redstone.

🛡️ Tool Durability & Inventory Protection

• Prevent Tool Break: Halts vein mining when your tool reaches 1 durability (tool-durability.prevent-tool-break: true), guaranteeing your enchanted Netherite tools are never lost.
• Unbreaking Integration: Durability damage strictly calculates unbreaking / (unbreaking + 1) skip chances per block.
• Direct to Inventory: Mined drops route straight into the player's inventory (behaviour.direct-to-inventory: true), preventing losses into lava lakes, ravines, or the void. Excess drops fall naturally at the block location.
• XP Auto-Collect: Ore experience automatically fills the player's experience bar (behaviour.xp-auto-collect: true), preventing XP orb lag. Silk Touch correctly suppresses XP drops matching vanilla rules.

🎮 Activation Modes & Controls

VeinBreaker provides multiple intuitive ways for players to activate features:

• Always-On: Run /vb once; every matching block broken automatically vein-mines (sneak-to-activate: false).
• Hold-to-Activate (Shift / Ctrl): When sneak-to-activate: true or sprint-to-activate: true is enabled, holding Shift (Sneak) or Ctrl (Sprint) triggers vein-breaking.
• Creative Mode: Operators and creative world builders can vein-break without item clutter for instant terraforming (behaviour.allow-creative: true).

🧱 Outward Block Placement

• Sneak-place matching blocks to construct floors, ceilings, or walls in outward ripples.
• Planar Alignment: Restricts block expansion strictly to the 2D plane perpendicular to the clicked face.
• Support Checking: Ensures neighbor blocks share the same backing support material, preventing runaway floating blocks.
• Disabled by Default: features.block-placement: false ensures standard sneak-building never triggers accidental mass placement. Enable it in config.yml or via /vb place.

🛠️ Building from Source

git clone https://github.com/Usama-Balhasal/VeinBreaker.git
cd VeinBreaker
mvn clean package

The compiled shaded JAR will be available in target/VeinBreaker-2.0.0.jar.

Requirements: Java 21, Maven 3.8+

📄 License & Attribution

VeinBreaker is licensed under the MIT License.
Developed by Usama Balhasal | Website · GitHub