⛏️ Area Mine - The Ultimate Mining Enchantment

Transform your pickaxe into a mining powerhouse with Area Mine - a comprehensive enchantment system featuring unlockable patterns, token economy, and endless progression!

---

🎮 What is Area Mine?

Area Mine is a server-side Fabric mod that adds a game-changing enchantment to pickaxes. Instead of mining one block at a time, mine entire areas with a single break! Choose from 6 unique patterns, earn tokens, unlock upgrades, and become the ultimate mining master.

🌟 Key Highlights:

• 🎯 6 Unlockable Mining Patterns - Cube, Sphere, Tunnel, Cross, Layer, Vertical
• 🏆 3 Enchantment Tiers - Each tier increases your mining area
• 💎 Token Economy - Earn tokens from mining, spend on patterns & upgrades
• 📊 Full Progression System - Achievements, leaderboards, statistics
• ⚡ Server-Side Only - Players can join without installing the mod!
• 🎨 Client-Side Preview - Optional visual particle outlines (if installed on client)

---

✨ Feature Showcase

🎯 Tiered Enchantment System

Each pattern has unique dimensions for Tier I, II, and III:

🟦 Cube Pattern (FREE - Default)

• Tier I: 1×2×1 area
• Tier II: 2×2×2 area
• Tier III: 3×3×3 area
• Perfect for general mining and beginners

🔵 Sphere Pattern (1,000,000 tokens)

• Tier I: 1 block radius
• Tier II: 2 block radius
• Tier III: 3 block radius (7×7×7 sphere)
• Create massive caverns and chambers

🟡 Tunnel Pattern (2,500,000 tokens)

• Tier I: 1×2×5 corridor
• Tier II: 2×2×8 corridor
• Tier III: 3×3×12 corridor
• Perfect for branch mining and exploration

🟢 Cross Pattern (5,000,000 tokens)

• Tier I: 3×1×3 arms
• Tier II: 5×2×5 arms
• Tier III: 7×3×7 arms
• Reveals ores in all directions - best for ore finding!

🟣 Layer Pattern (10,000,000 tokens)

• Tier I: 3×1×3 flat layer
• Tier II: 5×1×5 flat layer
• Tier III: 7×1×7 flat layer (49 blocks!)
• Clear entire levels at once

🟪 Vertical Pattern (25,000,000 tokens)

• Tier I: 1×5×1 shaft
• Tier II: 1×8×1 shaft
• Tier III: 1×12×1 shaft
• Create shafts to bedrock or surface

---

💰 Token Economy & Block Values

Earn tokens from every block you mine:

Block Type	Token Value
💎 Ancient Debris	1,000 tokens
💎 Diamond Ore	100 tokens
🥇 Gold Ore	25 tokens
⚙️ Iron Ore	10 tokens
🪨 Stone/Deepslate	1 token

💡 Boost your earnings:

• ⚡ Efficiency V: +100% tokens (doubles earnings!)
• 📈 Efficiency Boost Upgrade: +50% tokens
• 🎯 Combined: 2.5× token multiplier!

Example: Mine 10 diamond ore with Efficiency V + Efficiency Boost:

• Base: 10 blocks × 100 = 1,000 tokens
• With bonuses: 1,000 × 2.5 = 2,500 tokens! 💰

---

🏆 Permanent Upgrades

Spend tokens on powerful permanent upgrades:

Upgrade	Cost	Effect
📏 Radius Boost	100,000	Mine +1 block in all directions
⚡ Efficiency Boost	150,000	Earn +50% tokens from all mining
🛡️ Durability Boost	200,000	Reduce durability cost by 15%
🎁 Auto Pickup	250,000	Mined blocks go directly to inventory

Purchase with: /areamine upgrades buy <upgrade_name>

---

🏅 Achievement System

Unlock achievements as you progress:

• ⭐ First Use - Use Area Mine for the first time
• 💪 Efficiency Expert - Mine 10,000 blocks
• 💎 Diamond Digger - Mine 1,000 diamond ore
• 🔥 Unstoppable - Mine 100,000 total blocks
• ⛏️ Excavator - Mine 1,000 blocks in one session
• 💰 Token Millionaire - Earn 1,000,000 tokens
• 🎓 Master Miner - Unlock all 4 upgrades

All achievements save automatically!

---

🎮 Smart Gameplay Mechanics

✋ Crouch to Activate

• Area Mine only activates while sneaking/crouching
• Prevents accidental activations while mining normally
• Toggle in config: requireCrouch

⚒️ Pickaxe-Effective Blocks Only

• Only mines blocks that pickaxes are designed for
• ✅ Mines: Stone, ores, deepslate, netherrack, concrete, etc.
• ❌ Ignores: Dirt, sand, gravel, wood, leaves, etc.

⚖️ Balanced Durability System

• Tier I (Area Mine I): 10% durability per block
• Tier II (Area Mine II): 20% durability per block
• Tier III (Area Mine III): 30% durability per block
• Combine with Unbreaking III and Durability Boost for maximum efficiency!

Example: With Tier III + Unbreaking III + Durability Boost:

• Base cost: 30% per block
• After reductions: ~5% per block
• Mine 20 blocks per durability point!

---

🎨 Visual & Audio Feedback

🎨 Pattern-Specific Particles (Client-Side) Each pattern has unique color-coded particles:

• 🟦 Cube: White end rod particles (stable)
• 🔵 Sphere: Orange sparkle particles
• 🟡 Tunnel: Yellow flame particles
• 🟢 Cross: Green happy villager particles
• 🟣 Layer: Cyan glow particles (subtle)
• 🟪 Vertical: Purple portal particles

🔊 Sound Effects

• Activation: Anvil sound (when you start mining)
• Completion: XP orb pickup sound (when finished)

📊 Chat Feedback

[Area Mine] 26 blocks | +2,600 tokens

Clean, informative messages show your progress!

---

✨ Enchantment Compatibility

✅ Works Great With:

• 💎 Fortune I-III - Multiplies ore drops (works perfectly!)
• ⚡ Efficiency I-V - Faster breaking + token bonus
• 🛡️ Unbreaking I-III - Massive durability savings
• ✨ Mending - Repairs from XP orbs (ores, mobs, etc.)

❌ Incompatible With:

• 🧊 Silk Touch - Cannot be applied together (conflicting mechanics)

---

📊 Statistics & Leaderboards

Track Everything:

/areamine stats

[Area Mine] Your Stats:
  Blocks mined: 125,483
  Session blocks: 1,024
  Mining tokens: 3,482,190
  Times used: 8,432

Top Mined Blocks:
  deepslate: 42,103
  stone: 38,492
  diamond_ore: 1,284
  iron_ore: 8,921

Dimension Stats:
  Overworld: 98,423 blocks
  Nether: 22,158 blocks
  End: 4,902 blocks

Unlocked Patterns:
  ✔ cube, sphere, tunnel
  ✘ cross, layer, vertical

Compete on Leaderboards:

• /areamine leaderboard blocks - Top miners
• /areamine leaderboard diamonds - Diamond kings
• /areamine leaderboard tokens - Richest players

---

↩️ Undo System

Made a mistake? Undo your last mining operation!

/areamine undo

• Restores all broken blocks
• Removes mined items from your inventory
• 5-minute time limit
• Perfect for accidents!

---

📥 Installation

Server Installation (Required)

1. Install Fabric Loader (v0.17.3+)
2. Install Fabric API (Required dependency)
3. Download Area Mine and place in mods/ folder
4. Restart server

✅ Players can join without the mod installed!

Client Installation (Optional - For Preview)

Want to see particle outlines? Install on your client too!

1. Install Fabric Loader on your client
2. Install Fabric API
3. Install Area Mine
4. Enjoy visual previews with color-coded particles!

---

🎮 How to Get Started

Step 1: Obtain the Enchantment

🎓 Enchanting Table (Rare - Weight 2)

• Requires level 30+ enchantment
• Appears as "Area Mine I/II/III"

👨‍🏫 Librarian Villagers

• Master-level (Level 5) Librarians
• Trade: 5 Emeralds + 1 Book

Step 2: Apply to Pickaxe

Use an anvil to combine:

• Enchanted book (Area Mine I/II/III)
• Your pickaxe (any material)

💡 Pro Tip: Best on Netherite Pickaxe with Efficiency V, Unbreaking III, and Mending!

Step 3: Start Mining!

1. Crouch/Sneak (default activation method)
2. Break a block with your enchanted pickaxe
3. Watch the magic happen!
4. Earn tokens from every block mined

---

🔧 Commands

Player Commands

Command	Description
/areamine stats	View your statistics
/areamine upgrades	View upgrades & token balance
/areamine upgrades buy <name>	Purchase an upgrade
/areamine patterns	View all patterns & unlock status
/areamine patterns buy <name>	Unlock a mining pattern
/areamine undo	Undo last mining (5min limit)
/areamine leaderboard <type>	View leaderboards

Admin Commands (OP Level 2+)

Command	Description
/areamine reload	Reload configuration
/areamine toggle <player>	Enable/disable for player
/areamine pattern <name>	Change server-wide pattern
/areamine stats <player>	View player's stats
/areamine stats all	View server-wide stats

---

⚙️ Configuration

Config location: config/area-mine/config.json

Essential Settings

{
  "requireCrouch": true,
  "pickaxeEffectiveOnly": true,
  "miningPattern": "cube",
  
  "durabilityScaling": true,
  "enableUpgradeSystem": true,
  "enableBlockValues": true,
  
  "particleEffects": true,
  "soundEffects": true,
  "previewDensity": "medium",
  
  "batchedBreaking": true,
  "blocksPerTick": 10,
  
  "actionBarFeedback": false,
  "sendTokensInChat": true
}

Customization Options

Pattern Sizes - Customize dimensions for each tier:

"patternLevels": {
  "cube": {
    "1": {"horizontal": 1, "vertical": 2, "depth": 1},
    "2": {"horizontal": 2, "vertical": 2, "depth": 2},
    "3": {"horizontal": 3, "vertical": 3, "depth": 3}
  }
}

Pattern Costs - Adjust unlock prices:

"patternCosts": {
  "sphere": 1000000,
  "tunnel": 2500000,
  "cross": 5000000,
  "layer": 10000000,
  "vertical": 25000000
}

Block Values - Set token rewards:

"blockValues": {
  "minecraft:diamond_ore": 100,
  "minecraft:ancient_debris": 1000,
  "minecraft:gold_ore": 25,
  "minecraft:iron_ore": 10
}

Upgrade Costs - Adjust progression:

"upgradeCosts": {
  "radius_boost": 100000,
  "efficiency_boost": 150000,
  "durability_boost": 200000,
  "auto_pickup": 250000
}

---

⚡ Performance & Compatibility

Performance Features

• ✅ Batched Breaking: Breaks blocks over multiple ticks (configurable)
• ✅ Async Processing: Won't lag server even with large areas
• ✅ Smart Caching: Player data cached in memory
• ✅ Auto-Save: Saves every 5 minutes + on shutdown

Server Compatibility

• ✅ Vanilla Clients: Players don't need the mod
• ✅ World Protection: Respects protection plugins
• ✅ Multiplayer Safe: No desyncs or conflicts
• ✅ Data Persistence: All progress saved to disk

---

📋 Requirements

• Minecraft: 1.21.10
• Mod Loader: Fabric Loader 0.17.3+
• Dependencies: Fabric API (Required)
• Java: 21+

---