Area Mine

# Area Mine - Overview Area Mine is an enchantment for pickaxes that lets you mine an entire area around the block you break. By default it mines a cube. The mod is server-side: only the server needs it; players can join without installing it. ## Getting started ### Get the enchantment Get an **Area Mine** enchanted book from a **Librarian** (level 5 trade). Use an **anvil** to put it on a pickaxe. The enchant has three levels (I, II, III); each level increases the mining area size. ### Use it **Crouch (sneak)** and break a block with the enchanted pickaxe. Only blocks that pickaxes are effective on (e.g. stone, ores) are mined. Bedrock and unbreakable blocks are never broken. ## Upgrades menu The mod has one in-game menu: **Upgrades**. **Open it:** `/areamine upgrades` ### Simple mode vs standard mode **Simple mode** (no token economy): - No tokens. Progress is only from mining specific ores. - No " X blocks" in chat. - Cube pattern only. - The Upgrades menu shows four upgrades with progress **Mined: X / Y**. Mine the required ores with Area Mine to fill the bar, then unlock in the menu. **Toggle simple mode:** - `/areamine simple status` - `/areamine simple enable` - `/areamine simple disable` - `/areamine simple toggle` **Standard mode** (full progression): - You earn **tokens** from blocks you area-mine (values per block are configurable). - Unlock extra patterns (e.g. sphere, tunnel) by spending tokens: `/areamine patterns` and `/areamine patterns buy <name>`. - The same Upgrades menu: spend tokens on radius boost, efficiency boost, durability boost, auto pickup, etc. - Chat can show "X blocks" and "+Y tokens" after each use (configurable). ## Commands | What you want | Command | |---------------|---------| | Open Upgrades menu (Simple Mode) | `/areamine upgrades` | | Buy upgrade (Standard Mode) | `/areamine upgrades buy <upgrade_name>` | | Simple mode status | `/areamine simple status` | | Turn simple mode on | `/areamine simple enable` | | Turn simple mode off | `/areamine simple disable` | | Toggle simple mode | `/areamine simple toggle` | | Your stats | `/areamine stats` | | Undo last area mine | `/areamine undo` | | Leaderboards | `/areamine leaderboard blocks` or `diamonds` or `tokens` | | See or buy patterns (standard) | `/areamine patterns`, `/areamine patterns buy <name>` | | Change pattern (admin) | `/areamine pattern <name>` | | Reload config (admin) | `/areamine reload` | In simple mode, token and pattern commands are hidden. ## Progress is per world Stats and upgrade progress (including "Mined: X / Y" in simple mode) are **per world**. Each world has its own progress; switching worlds does not carry it over. ## Configuration Config file: `config/area-mine/config.json`. You can change: - Whether crouch is required - Max area size and blocks per tick - Which blocks can be area-mined - Token values per block (standard mode) - Simple-mode upgrade ores and counts - Sounds, particles, chat and action bar feedback After editing, run `/areamine reload` (with permission) to apply. ## Optional client If players install the mod on the **client**, they get a **particle preview** of which blocks will be mined when looking at a block with an Area Mine pickaxe. The mod works with server-only installation; the client part is optional.