UltraMiner

About

This is a configurable vein-mining mod to address perfomance, statistics and selection issues that I encountered with other vein-mining mods. It uses normal block-breaking logic so mined blocks count towards Minecraft statistics, tool durability, exhaustion, and drops.

Originally made for personal use, but anyone is welcome to use it.

Mining Modes

Vein

• Finds connected blocks of the same type across faces, edges and corners
• Prioritizes blocks nearest to the starting block
• Supports configurable block groups

Tunnel/Plane

• Adjustable square from 1x1 to 17x17 in odd-numbered steps
• Adjustable length from 1 to 16 blocks
• A length of 1 becomes an NxN Plane while anything greater becomes a NxN Tunnel
• Each tunnel column stops at its first gap to prevent blocks behind empty spaces from being selected

Leveler

• Spreads out like Vein mode
• Can adjust how many levels to break at once from 1 to 16 blocks down from the selected block
• Attempts to distribute the block limit across available layers to produce an even excavation

Shaft

• Digs vertically downward to bedrock
• Adjustable width from 1x1 to 17x17
• Can be configured to skip water, stop at water, or stop at lava
• Can continue through air and permitted liquids without jumping trough solid barriers

Staircase

• Creates a 3 block high staircase shaped passage
• Adjustable width from 1 to 17 blocks
• Adjustable length up to 32 steps
• The ability to make the staircase go up or down depending on where you look on the block

Controls

Hold the UltraMiner activation key while breaking the block to begin mining. The default key is the grave key, `, just above the tab button and when you release the key while you are mining it stops the mining. You can cycle shapes by pressing V and you can adjust the length of shapes with the activation key and scroll wheel, and to adjust the width you sneak while scrolling and holding the activation key

Selection Preview

This is the outline that is shown when holding down the activation key. It shows you what will be broken, it caches and merges outline geometry to reduce rendering overhead and can optionally display outline through other blocks in the Mod Menu config screen. Above the hotbar it show the selected shape, the dimensions of the shape, the block count, block limit and the mining speed.

Block groups

Block groups allow different blocks to be treated as the same type by Vein and Leveler mods

• Includes default groups for common stone, dirt, and ore variants
• Create, rename and delete custom groups
• Add blocks through a searchable block picker
• Group matching can be disable in the config

Block Rules

Controls which blocks are permitted to be selected through a whitelist and blacklist. Can also use block tags to filter out breakable blocks.

Configuration

Mod Menu screen is divided into 4 sections

1. Mining
2. Safety
3. Blocks
4. Shapes and Preview
   Available options include:

• Maximum blocks per mining operation
• Blocks broken per second
• Vanilla-based food exhaustion scaling
• Tool-breaking protection
• Correct-tool requirement
• Drop location
• Shaft liquid behavior
• Outlines through blocks
• Block-group matching
• Whitelist and blacklist rules

Commands

• /ultraminer - Displayes the current block limit and mining speed
• /ultraminer blocks <1-8192>
• /ultraminer speed <1-1024>