⛏ Veinminer

Veinminer is a configurable mining mod that lets players break connected ore and log veins with one normal block break. It keeps the grind down while giving server owners clear controls, limits, and permissions.

No /veinminer setup command is required. Install the mod, hold Shift while mining a supported block, and Veinminer works immediately.

---

⚙️ Key Features

• 🧱 Vein Mining — mines connected supported blocks with safe block caps.
• 🛠️ Activation Choices — Shift/sneak by default, optional client hotkey, hold or toggle mode per player.
• 🙌 Empty-Hand Support — server owners can allow hand as a tool entry.
• 🧰 Flexible Block Lists — global block and tool lists for server control.
• 🪓 Per-Tool Rules — optional advanced per-tool block lists.
• ⚡ Durability Safety — optional guard to avoid breaking tools.
• 🔁 Cooldown & Limits — optional cooldown, exhaustion, and max-block controls.
• ✴️ Particles/Outline — per-player outline particles with color and duration controls.
• 🔐 LuckPerms Toggle — optional integration for permission-managed servers.
• 🧪 Advanced Test Command — /vmadvanced test when advanced mode is enabled.
• 🔄 Live Reloads — /veinminer reload or /vmadmin reload reloads configs from disk.

Works server-side out of the box. Optional client mod adds the hotkey, default V.

---

🔧 Configuration & Commands

Command quick reference

Player Commands

Command	Description
/veinminer	Show quick help.
/veinminer help [topic]	Help for toggle, reload, activation, togglemessages, or particles.
/veinminer toggle	Toggle Veinminer for yourself.
/veinminer activation keybind	Switch between Shift and the optional client keybind.
/veinminer activation mode hold|toggle	Set your activation mode.
/veinminer togglemessages permission|disabled|cooldown|durability	Toggle your own feedback messages.
/veinminer particles toggle	Toggle your own outline particles.
/veinminer particles setcolor <red> <green> <blue>	Set your own outline particle color.
/veinminer particles setduration <ticks>	Set your own outline particle duration.
/veinminer reload	Reload configs from disk. Requires admin/manage permission.

Admin Commands

Command	Description
/vmadmin blocks add|remove|list|clear <id|#tag>	Manage global block lists.
/vmadmin tools add|remove|list|clear <id|#tag|hand>	Manage allowed tools.
/vmadmin settings blocklistmode whitelist|blacklist	Set global block list mode.
/vmadmin settings maxblocks <value>	Set max blocks per activation.
/vmadmin settings cooldown enable|disable|set <seconds>	Configure cooldown.
/vmadmin settings exhaustion enable|disable|scale <value>	Configure exhaustion cost.
/vmadmin settings luckperms enable|disable	Toggle LuckPerms integration.
/vmadmin reload	Reload configs from disk.
/vmadmin confirm / /vmadmin cancel	Confirm or cancel pending destructive admin actions.

Advanced Commands

Advanced commands are only registered when advanced.enabled = true in GeneralConfig.toml.

Command	Description
/vmadvanced blockpertool ...	Manage per-tool block lists.
/vmadvanced settings blockpertool	Toggle per-tool block list mode.
/vmadvanced test	Run the advanced feature test harness.
/vmadvanced confirm / /vmadvanced cancel	Confirm or cancel pending destructive advanced actions.

---

📁 Config Files

Written to config/Veinminer/ (TOML) on first run.

Config file overview

GeneralConfig.toml

• basic.enabled true
• basic.activation_key SHIFT
• basic.require_correct_tool true
• basic.check_tool_durability true, basic.durability_cap 1, basic.durability_mode ABSOLUTE
• visual.show_particles true, visual.show_chat_feedback true
• advanced.enabled false, advanced.debug_logging false
• advanced.block_limits.max_blocks 64
• advanced.cooldown.enabled false
• advanced.exhaustion.enabled false

ToolsList.toml

• Allowed tools, including optional hand support.

BlocksList.toml

• Global block list for supported ores, logs, tags, or custom entries.

BlockPerToolList.toml

• Per-tool block lists when advanced per-tool mode is enabled.

---

🛡️ Permissions

Permission nodes

General

• veinminer.use
• veinminer.reload
• veinminer.settings.manage
• veinminer.*

Blocks

• veinminer.blocks.manage
• veinminer.blocks.add
• veinminer.blocks.remove
• veinminer.blocks.list
• veinminer.blocks.*

Tools

• veinminer.tools.manage
• veinminer.tools.add
• veinminer.tools.remove
• veinminer.tools.list
• veinminer.tools.*

Per-Tool

• veinminer.blockpertool.manage
• veinminer.blockpertool.blocks.add|remove|list
• veinminer.blockpertool.tools.add|remove|list
• veinminer.blockpertool.blocks.*
• veinminer.blockpertool.tools.*

Particles

• veinminer.particles.manage
• veinminer.particles.enable
• veinminer.particles.disable
• veinminer.particles.setcolor
• veinminer.particles.setduration

---

🧱 Compatibility

• ✅ Fabric: Minecraft 1.20 through 26.2.
• ✅ NeoForge: Minecraft 1.21 through 26.2.
• ✅ Works on dedicated servers and single-player integrated servers.
• ❌ No Forge builds are currently planned.

---

🖥️ Client Optional

Installing the client build enables the hotkey and sends key state to the server. Default key: V. Without the client, Shift/sneak activation remains available for a vanilla-only server-side experience.

---

📥 Installation

1. Download the latest build for your loader and Minecraft version.
2. Drop the jar in /mods.
3. Restart the server or client.
4. Play normally. Edit configs or enable advanced mode only if you need admin controls.

---

💬 Support

Discord: https://discord.gg/43nu6wSWRC

---

🧰 Other Projects

• 🔨 Hammer Mining — 3x3 breaking via enchant.