Files
veinmining/README.md
T

109 lines
3.9 KiB
Markdown
Raw Permalink Normal View History

2025-11-02 02:43:02 +01:00
# ⛏️ Veinmining
![Minecraft](https://img.shields.io/badge/Minecraft-1.21.1-blue)
![Loader](https://img.shields.io/badge/NeoForge-21.1.208%2B-green)
![License](https://img.shields.io/badge/License-All%20Rights%20Reserved-red)
![Dependencies](https://img.shields.io/badge/Dependencies-None-lightgrey)
![Side](https://img.shields.io/badge/Side-Client%20%26%20Server-orange)
**Veinmining** is a simple yet powerful **NeoForge enchantment mod** that allows players to mine entire ore veins with a single break.
No complex keybinds, no GUI — just **enchant your pickaxe** and start mining smarter, not harder.
---
## ✨ Features
- ⛏️ **Veinmining enchantment** — mine entire ore veins at once
- 📊 **3 enchantment levels** — I, II, III for increased range
- 🔧 **Universal compatibility** — works with vanilla and modded pickaxes
- 🪨 **Auto-detection** — recognizes all vanilla and modded ores
- 📚 **Enchanting table support** — obtain it naturally through enchanting
- 🔄 **Smart algorithm** — prevents lag with optimized block searching
- 💎 **XP & durability** — uses tool durability and grants experience like normal mining
- 🎒 **Automatic drops** — all mined blocks drop items as expected
- 🌐 **Multi-language support** (`en_us`, `fr_fr`)
- 🚫 **No dependencies** — works out of the box
---
## 🎮 How It Works
1. **Enchant your pickaxe** with the Veinmining enchantment (found in enchanting tables, anvils, or villager trades)
2. **Break any ore block** — the enchantment will automatically detect and mine the entire vein
3. **Collect your loot** — all blocks drop normally and consume durability per block mined
### 📈 Enchantment Levels
| Level | Max Blocks | Description |
|-------|------------|-------------|
| **Veinmining I** | 16 blocks | Mines small to medium ore veins |
| **Veinmining II** | 32 blocks | Mines large ore veins |
| **Veinmining III** | 64 blocks | Mines massive ore veins |
---
## ⚙️ Technical Details
### 🔍 Compatible Items
- ✅ All vanilla pickaxes (Wood, Stone, Iron, Gold, Diamond, Netherite)
- ✅ All modded pickaxes (any item containing `pickaxe` in its name)
### 🪨 Compatible Blocks
- ✅ All vanilla ores (Coal, Iron, Gold, Diamond, Emerald, Copper, etc.)
- ✅ All Nether ores (Nether Gold, Nether Quartz, Ancient Debris)
- ✅ All modded ores (any block containing `ore` in its name)
---
## 🧩 Compatibility
| Requirement | Version |
|--------------|----------|
| **Minecraft** | 1.21.1 |
| **Loader** | NeoForge **21.1.208 or newer** |
| **Environment** | Client & Server |
| **Dependencies** | None |
---
## 🔧 Installation
### Client & Server
1. Download the latest **Veinmining** `.jar`
2. Place it in your `mods/` folder
3. Launch Minecraft/Server
4. Enchant your pickaxe and start mining!
---
## 🎯 Obtaining the Enchantment
| Method | Availability |
|--------|--------------|
| **Enchanting Table** | ✅ Available at all levels |
| **Anvil** | ✅ Combine enchanted books |
| **Villager Trading** | ✅ Librarian trades |
| **Loot Chests** | ✅ Found in dungeon/temple loot |
| **Command** | `/give @p diamond_pickaxe[enchantments={levels:{"veinmining:veinmining":3}}]` |
---
## 🧑‍💻 Author
**Veinmining** was created by **UltraLion**
🌐 [https://ultralion.xyz](https://ultralion.xyz)
---
## 📜 License
This mod is distributed under the **All Rights Reserved** license.
Redistribution or modification without explicit permission from the author is prohibited.
---
### 📸 Screenshots
![Replace this with a description](https://cdn.modrinth.com/data/cached_images/d7a0281ee8b904859a69d69795edf1428e0bbec4.png) ![Replace this with a description](https://cdn.modrinth.com/data/cached_images/6560376791eeedaa58914ce90892a8a2092f10d1.png) ![Replace this with a description](https://cdn.modrinth.com/data/cached_images/54c84b2cd94495e313c1797e683bec4cd50388ef.png)
---