🛠️ OneKeyMiner (Forge / NeoForge) – Chain Mining & Planting Mod

Loaders: Forge & NeoForge Compatible Minecraft Versions: 1.20.x & 1.21.x (including 1.21.5)

🌟 If you could make a YouTube video for this Mod—introducing the Mod and its features, while showcasing the uses and effects of commands in the video—I'd be thrilled to add a link to your YouTube video on all platforms where this Mod is released! 🎥✨

Then please contact me at my email: [email protected].

📋 Overview

OneKeyMiner offers a seamless chain-mining and farming experience on both Forge and NeoForge. Hold down your chosen key (default: ~) to auto-break adjacent identical blocks or plant seeds in bulk. Both versions deliver identical core functionality—mining, planting, tool durability protection—while NeoForge further expands interaction capabilities.

✨ Features

• Chain Mining: Break one block, and all connected matching blocks are automatically mined.
• Chain Planting: Plant seeds over multiple tilled blocks in one go.
• Tool Protection & Durability Check: Mod prevents tool breakage mid-use, ensuring smooth operation.
• Advanced Configuration: Customize limits, tools, block types, and modes for tailored play.
• NeoForge Exclusive – Chain Interactions: Beyond ore and crops, use the feature on sheep (shears), farmland, and other block-entity actions.

⚙️ Commands & Config Differences

Both versions share the /excavation command prefix, but differ slightly in subcommands:

• To ignore tool compatibility in NeoForge, use:

  /excavation common common ignoreToolCompatibility true

(This command format may not apply identically in Forge.)

• Forge users: If chain mining fails, try deleting its config and restarting; commands are simpler and may vary.

🆕 Version History & Sync Status

• Forge v3.0.0 – Released May 27, 2025; this version achieves full feature parity with NeoForge 1.5.3, differing only in command parameters（Forge 3.0.1 ==NeoForge 1.5.4）.

✅ Summary

• Forge & NeoForge both deliver complete chain-mining/planting, tool protection, and auto-durability.
• NeoForge(Forge 3.0.0++) adds extra versatility through chain interactions (e.g., sheep shearing) and more robust configuration options.
• Choosing between them depends on loader preference and your need for command precision.

❓Q&A:

Q: Why can't I vein mine stone?
A: Maybe you should check the common config file or enter the command /excavation common options nonblockmined list.

Q: How do I change the chain quantity?
A: You can check the common config file or use /excavation common options maxChainBlocks .

Q: Why does my chain mode require pressing to toggle each time instead of starting when held down?
A: You can check the client config file or…

Q: Why are some blocks missed when chain mining instead of being vine mined together?
A: Check the common config or enter /excavation common options enableDiagonalChaining true.

Q: How to make items dropped from vine mined blocks teleport to myself?
A: Check the common config file or use /excavation common options teleportDropsToPlayer <true|false>.

Q: Why do the enchantments on my tool not work when vine mining? Or why can I still vine mine when my tool is incompatible?
A: You should enter /excavation common options ignoreToolCompatibility false or set ignoreTool compatibility to false.

Q: Why does my chain mode automatically turn off after a while when set to toggle?
A: Many players reported forgetting to turn off chain mode, leading to vine mining unintended blocks, so I added a frozen feature. You can change the cooldown time in the client config or use commands.

OneKeyMiner Mod Commands Guide

Overview

OneKeyMiner mod provides a comprehensive command system that allows players and administrators to view status and modify configurations through in-game commands. All commands start with /excavation as the root command.

Permission Levels

• Level 0: Regular players
• Level 2: Game administrators (players who can use /gamemode, /give, etc.)
• Level 4: Server operators (players with highest privileges)

Basic Commands

1. Help Command

/excavation help

Permission Required: None
Function: Display help information for all available commands

2. Status Check

/excavation status

Permission Required: None
Function: View current player's chain mode status and main configuration information

• Display whether chain mode is active
• Show maximum chain blocks
• Show maximum chain depth
• Show diagonal chaining status
• Show sneaking requirement status

Common Configuration Commands (Requires Level 2 Permission)

Common configurations affect game mechanics and balance, requiring administrator privileges to modify.

Basic Syntax

/excavation common options <config_item> [value]

Numeric Configurations

Maximum Chain Blocks

# View current value
/excavation common options maxChainBlocks

# Set new value (range: 1-4096)
/excavation common options maxChainBlocks 128

Function: Set the maximum number of blocks for chain operations

Maximum Chain Depth

# View current value
/excavation common options maxChainDepth

# Set new value (range: 1-64)
/excavation common options maxChainDepth 32

Function: Set the maximum depth for chain searches to prevent performance issues from excessive chaining

Survival Mode Maximum Chain Blocks

# View current value
/excavation common options maxBlocksInChain

# Set new value (range: 1-4096)
/excavation common options maxBlocksInChain 64

Function: Set the maximum number of blocks for chain mining in survival mode

Creative Mode Maximum Chain Blocks

# View current value
/excavation common options maxBlocksInChainCreative

# Set new value (range: 1-16384)
/excavation common options maxBlocksInChainCreative 256

Function: Set the maximum number of blocks for chain mining in creative mode

Boolean Configurations

Enable Diagonal Chaining

# View current value
/excavation common options enableDiagonalChaining

# Enable diagonal chaining
/excavation common options enableDiagonalChaining true

# Disable diagonal chaining
/excavation common options enableDiagonalChaining false

Function: Whether to allow diagonally connected blocks to participate in chaining

Teleport Drops to Player

# View current value
/excavation common options teleportDropsToPlayer

# Enable drop teleportation
/excavation common options teleportDropsToPlayer true

# Disable drop teleportation
/excavation common options teleportDropsToPlayer false

Function: Whether to teleport chain mining drops directly to player location

Ignore Tool Compatibility

# View current value
/excavation common options ignoreToolCompatibility

# Ignore tool compatibility checks
/excavation common options ignoreToolCompatibility true

# Enable tool compatibility checks
/excavation common options ignoreToolCompatibility false

Function: Whether to ignore tool-block compatibility checks

Match Complete Block State

# View current value
/excavation common options matchBlockState

# Enable complete state matching
/excavation common options matchBlockState true

# Disable complete state matching
/excavation common options matchBlockState false

Function: Whether to match complete block state rather than just block type

Match Complete Seed Block State

# View current value
/excavation common options matchSeedBlockState

# Enable seed state matching
/excavation common options matchSeedBlockState true

# Disable seed state matching
/excavation common options matchSeedBlockState false

Function: Whether to match complete seed block state

Enable Chain Mining in Creative Mode

# View current value
/excavation common options enableInCreative

# Enable chaining in creative mode
/excavation common options enableInCreative true

# Disable chaining in creative mode
/excavation common options enableInCreative false

Function: Whether to enable chain mining in creative mode

Require Sneaking to Trigger Chaining

# View current value
/excavation common options requireSneaking

# Require sneaking to trigger
/excavation common options requireSneaking true

# Don't require sneaking
/excavation common options requireSneaking false

Function: Whether players need to sneak to trigger chain mining

Block Blacklist Management

View Non-Chainable Blocks List

/excavation common options nonChainableBlocks list

Function: Display all blocks that are not allowed to be chain mined

Add Block to Blacklist

# Add vanilla block (automatically adds minecraft: prefix)
/excavation common options nonChainableBlocks add stone

# Add modded block (requires full ID)
/excavation common options nonChainableBlocks add modid:block_name

Function: Add specified block to the non-chainable mining list

Remove Block from Blacklist

# Remove vanilla block
/excavation common options nonChainableBlocks remove stone

# Remove modded block
/excavation common options nonChainableBlocks remove modid:block_name

Function: Remove specified block from the non-chainable mining list

Seed Blacklist Management

View Non-Chainable Seeds List

/excavation common options seedBlacklist list

Function: Display all seeds that are not allowed to be chain planted

Add Seed to Blacklist

# Add vanilla seed
/excavation common options seedBlacklist add wheat_seeds

# Add modded seed
/excavation common options seedBlacklist add modid:seed_name

Function: Add specified seed to the non-chainable planting list

Remove Seed from Blacklist

# Remove vanilla seed
/excavation common options seedBlacklist remove wheat_seeds

# Remove modded seed
/excavation common options seedBlacklist remove modid:seed_name

Function: Remove specified seed from the non-chainable planting list

Client Configuration Commands (No Permission Required)

Client configurations only affect individual player's display and operation experience.

Basic Syntax

/excavation client options <config_item> [value]

Show Block Count

# View current value
/excavation client options showBlockCount

# Enable count display
/excavation client options showBlockCount true

# Disable count display
/excavation client options showBlockCount false

Function: Whether to display block count during chain operations

Message Display Style

# View current value
/excavation client options messageStyle

# Set to chat display
/excavation client options messageStyle chat

# Set to action bar display
/excavation client options messageStyle actionbar

# Set to both displays
/excavation client options messageStyle both

# Set to no display
/excavation client options messageStyle none

Function: Set the display method for chain operation messages

Key Mode

# View current value
/excavation client options keyMode

# Set to toggle mode (press once to enable, press again to disable)
/excavation client options keyMode toggle

# Set to hold mode (need to continuously hold key)
/excavation client options keyMode hold

Function: Set the activation method for chain functionality

Debug Mode

# View current value
/excavation client options Debug

# Enable debug mode
/excavation client options Debug true

# Disable debug mode
/excavation client options Debug false

Function: Whether to enable client debug mode with detailed information

Chain Reset Timer

# View current value
/excavation client options "frozen timer"

# Set reset time to 30 seconds
/excavation client options "frozen timer" 30

Function: Auto-reset time for chain state when key mode is toggle (seconds)

Server Configuration Commands (Requires Level 4 Permission)

Server configurations affect server performance and game balance, requiring highest privileges to modify.

Basic Syntax

/excavation server options <config_item> [value]

Tool Durability Threshold

# View current value
/excavation server options toolDurabilityThreshold

# Set to 10% durability threshold
/excavation server options toolDurabilityThreshold 0.1

# Set to fixed 5 points durability threshold
/excavation server options toolDurabilityThreshold 5.0

Function: Tool protection threshold, values ≤1.0 represent percentage, >1.0 represent fixed values

Hunger Threshold

# View current value
/excavation server options hungerThreshold

# Set hunger threshold to 3
/excavation server options hungerThreshold 3.0

# Set hunger threshold to 6
/excavation server options hungerThreshold 6.0

Function: Players cannot perform chain operations when hunger is below this value (range: 0-20)

Usage Examples

Scenario 1: Administrator Setting Basic Chain Parameters

# Set survival mode max chain blocks to 32
/excavation common options maxBlocksInChain 32

# Set creative mode max chain blocks to 128
/excavation common options maxBlocksInChainCreative 128

# Enable diagonal chaining
/excavation common options enableDiagonalChaining true

# Disable tool compatibility checks
/excavation common options ignoreToolCompatibility true

Scenario 2: Administrator Managing Block Blacklist

# View current blacklist
/excavation common options nonChainableBlocks list

# Add bedrock to blacklist (prevent accidental destruction)
/excavation common options nonChainableBlocks add bedrock

# Add diamond block to blacklist (prevent abuse)
/excavation common options nonChainableBlocks add diamond_block

# Remove if needed
/excavation common options nonChainableBlocks remove diamond_block

Scenario 3: Player Adjusting Personal Settings

# Set message display to action bar
/excavation client options messageStyle actionbar

# Enable block count display
/excavation client options showBlockCount true

# Set to hold mode
/excavation client options keyMode hold

Scenario 4: Server Operator Adjusting Protection Settings

# Set tool protection to 20% durability
/excavation server options toolDurabilityThreshold 0.2

# Set hunger protection to 5 hunger points
/excavation server options hungerThreshold 5.0

Important Notes

1. Permission Checks: Ensure the player executing commands has appropriate permissions
2. Value Ranges: All numeric parameters have valid ranges, exceeding them will cause errors
3. Configuration Saving: All configuration changes are immediately saved to config files
4. Immediate Effect: Most configuration changes take effect immediately without restart
5. Block ID Format: Supports abbreviations (auto-adds minecraft: prefix) and full ID format
6. Command Completion: In-game Tab completion is supported for quick command input

Troubleshooting

Common Errors

1. Insufficient Permissions:

   You do not have permission to use this command

Solution: Contact administrator for appropriate permissions

1. Parameter Errors:

   Invalid argument

Solution: Check parameter format and value ranges

1. Block Not Found:

   Block not found

Solution: Check if block ID is correct and mod is loaded

Getting Help

• Use /excavation help to view command overview
• Use /excavation status to view current status
• Execute configuration commands alone (without parameters) to view current values

Configuration File Mapping

Configurations modified through commands will directly update corresponding config files and remain effective after game restart.