Getting started

Getting Started

Requirements

• Minecraft: 1.20 — 1.21.11
• Server: Spigot or Paper
• Java: 17+

Installation

1. Download Vexora-VeinMiner-1.0.0.jar from [Releases](https://github.com/VexoraStudios/Vexora-VeinMiner/releases)
2. Drop it into your server's plugins/ folder
3. Restart the server
4. Done — the plugin generates config.yml and messages.yml automatically

Verifying Installation

After restart, check the console for the startup banner:

  ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
  ┃   ✦ Vexora VeinMiner v1.0.0  ┃
  ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
  ┃  Blocks:    20                ┃
  ┃  Tools:     6                 ┃
  ┃  Max:       64                ┃
  ┃  Animation: ON                ┃
  ┃  Cooldown:  3s                ┃
  ┃  WorldGuard: NO               ┃
  ┃  Loaded in 45ms               ┃
  ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

You can also run /vm info in-game to check the plugin status.

How to Use

1. Hold a pickaxe
2. Crouch (Shift)
3. Break an ore block
4. Watch the entire vein get mined with animation!

Default Behavior

Out of the box, Vexora VeinMiner:

• Requires sneaking to activate
• Supports all vanilla ores + Ancient Debris + Amethyst
• Limits veins to 64 blocks (configurable per block type)
• Shows BossBar and ActionBar progress
• Applies tool durability (respects Unbreaking)
• Drains hunger (0.5 food per block)
• Has a 3 second cooldown between uses
• Drops XP correctly for all ores

Next Steps

• [Configure the plugin](Configuration) to fit your server
• [Set up permissions](Permissions) for different ranks
• [Translate messages](Messages-&-Languages) to your language