⛏️ ExcaMate

ExcaMate is an efficient mining companion that enhances how you mine in Minecraft. With a single key, you can vein mine, create clean branch tunnels, or excavate 3×3 areas, with optional auto-pickup for drops and direct XP collection - now with full control over what gets mined and picked up.

---

✨ Features

• Hold-to-activate mining - no toggle state
  Tool-aware behaviour:
  • Pickaxes: stone & ores
  • Axes: logs & wood
  • Shovels: dirt, sand, gravel, clay, etc.
  • Hoes: hay bales, sponges, leaves, crops, etc.
• Smart durability handling (won’t break your tool)
• Supports Unbreaking & respects Silk Touch & Fortune
• Direct XP collection (optional)
• Auto-pickup drops (optional)
• Auto torch placement when torches are in off-hand (Branch mode only - optional)
• Configurable block limits per mode
• Customisable allow & block lists for mining and auto-pickup

---

🧾 Custom Allow & Block Lists

ExcaMate now gives you full control over what it can mine and what it picks up.

By default, ExcaMate supports:

• ores
• logs and wood
• stone-type blocks
• shovel blocks (dirt, sand, gravel, etc.)

You can extend or restrict this behaviour using the config:

• extraVeinMineAllowList
  Adds extra blocks to ExcaMate’s supported mining list.
  Example: minecraft:obsidian, minecraft:hay_block

• veinMineBlockList
  Prevents specific blocks from being mass-mined.
  Example: minecraft:glass, minecraft:glass_pane

• extraAutoPickupAllowList
  Adds extra blocks whose drops will be auto-picked up.

• autoPickupBlockList
  Prevents drops from specific blocks from being auto-picked up.
  Example: minecraft:gravel to avoid inventory clutter

Behaviour Rules

• Default ExcaMate-supported blocks always work
• Extra allowlists add to default behaviour (they do not replace it)
• Blocklists always override allowlists
• Tool rules still apply - no bypassing vanilla mechanics
• Safety rules still apply - protected blocks remain blocked

This lets you customise ExcaMate without breaking balance or risking accidental destruction.

---

🧲 Auto Pickup Blocks & XP

ExcaMate can automatically collect drops and XP while mining, keeping your inventory tidy and reducing clutter.

Item Auto Pickup:
Mined drops go directly into your inventory. If your inventory is full, excess items will drop normally.

Direct XP Collection:
XP is awarded instantly without spawning orbs, making mining smoother and eliminating the need to wait for XP to reach you.

Both features are fully configurable and now support fine-tuned control using the allowlists and blocklists.

---

🔄 Mining Modes

ExcaMate includes three mining modes, each designed for a different use case. Cycle between them using the in-game keybind.

Vein
Mines connected blocks of the same type. Ideal for ores, logs, and loose materials.

Branch
Creates a clean 1-wide, 2-tall, 16-depth tunnel in front of you. Perfect for strip mining.

Excavate
Mines a 3-wide, 3-tall, 3-depth area based on where you're looking. Great for clearing large spaces quickly.

---

⚙️ Configuration

ExcaMate includes a config file where you can tweak:

• Max block limit per mode
• Auto-pickup behaviour
• XP handling
• Auto torch placement
• Extra blocks that can be mass-mined
• Blocks that should never be mass-mined
• Extra blocks whose drops can be auto-picked up
• Blocks whose drops should not be auto-picked up

All new configuration options are designed to extend ExcaMate’s default behaviour without disrupting it.

---

⚖️ Balanced Gameplay

ExcaMate is designed to feel like vanilla Minecraft:

• No boosted drops
• No bonus XP
• Uses normal durability
• Applies exhaustion/hunger
• Respects all vanilla mechanics

You gain efficiency and control without sacrificing balance.

---

🔒 Safety

ExcaMate will never mass-break protected or sensitive blocks such as:

• Containers (chests, barrels, shulker boxes, etc.)
• Spawners
• Bedrock
• Command blocks and structure blocks

These protections remain in place regardless of configuration.

---

💬 Suggestions & Feedback

I’m open to suggestions for future ExcaMate features, balance changes, and quality-of-life improvements.

If you have an idea or find an issue, please add it on the GitHub issue page:
https://github.com/SkellyX/ExcaMate/issues