# Divining Rod Mod
A Minecraft mod that adds four different divining rods to help you locate valuable ores underground!
## Features
### Four Types of Divining Rods:
1. **Iron Divining Rod** - Detects iron ore within 200 blocks
2. **Gold Divining Rod** - Detects gold ore within 200 blocks
3. **Diamond Divining Rod** - Detects diamond ore within 200 blocks
4. **Ancient Debris Divining Rod** - Detects ancient debris within 200 blocks
### All Rods Include:
- **Directional Guidance**: Shows distance and direction to the nearest ore
- **Durability**: 256 uses before breaking
- **Cooldown**: 2-second cooldown between uses to prevent spam
- **Works with both regular and deepslate variants** of ores
## Crafting Recipes
### Simple Recipes (Using Ore):
**Iron Divining Rod:**
```
I
S
S
```
Where: I = Iron Ore, S = Stick
**Gold Divining Rod:**
```
G
S
S
```
Where: G = Gold Ore, S = Stick
**Diamond Divining Rod:**
```
D
S
S
```
Where: D = Diamond, S = Stick
**Ancient Debris Divining Rod:**
```
A
S
S
```
Where: A = Ancient Debris, S = Stick
### Advanced Recipes (Tier Progression):
These recipes use 8 of the previous tier surrounding a stick:
**Iron Divining Rod (Advanced):**
```
CCC
CSC
CCC
```
Where: C = Coal Ore, S = Stick
**Gold Divining Rod (Advanced):**
```
III
ISI
III
```
Where: I = Iron Ore, S = Stick
**Diamond Divining Rod (Advanced):**
```
GGG
GSG
GGG
```
Where: G = Gold Ore, S = Stick
**Ancient Debris Divining Rod (Advanced):**
```
DDD
DSD
DDD
```
Where: D = Diamond Ore, S = Stick
## How to Use
1. Craft the divining rod for the ore you want to find
2. Right-click while holding the rod
3. If the target ore is within 200 blocks, you'll see:
- Distance to the nearest ore
- Direction (North, South, East, West, Above, Below, or combinations)
- A pleasant sound effect
4. If no ore is found, you'll get a message saying so
## What Each Rod Detects
- **Iron Rod**: `minecraft:iron_ore`, `minecraft:deepslate_iron_ore`
- **Gold Rod**: `minecraft:gold_ore`, `minecraft:deepslate_gold_ore`, `minecraft:nether_gold_ore`
- **Diamond Rod**: `minecraft:diamond_ore`, `minecraft:deepslate_diamond_ore`
- **Ancient Debris Rod**: `minecraft:ancient_debris`
## Building the Mod
### Prerequisites
- Java 17 or higher (Java Development Kit)
- Minecraft 1.20.1
- Forge 47.2.0+
## Installation
### For Players (Using CurseForge)
2. In CurseForge, go to Minecraft section
3. Create or select a Minecraft 1.20.1 profile with Forge installed
4. Copy the built JAR file into the mods folder:
- Windows: `%APPDATA%\.minecraft\mods\`
- Mac: `~/Library/Application Support/minecraft/mods/`
- Linux: `~/.minecraft/mods/`
5. Launch Minecraft with the Forge 1.20.1 profile
6. The mod should appear in the Mods list in the main menu
### Manual Installation
1. Install Minecraft Forge 1.20.1 (version 47.2.0 or higher)
2. Locate your Minecraft directory:
- Windows: `%APPDATA%\.minecraft`
- Mac: `~/Library/Application Support/minecraft`
- Linux: `~/.minecraft`
3. Place the mod JAR file in the `mods` folder
4. Launch Minecraft with the Forge profile
## Finding the Items In-Game
Once installed, you can find all four divining rods in:
- **Creative Mode**: Tools & Utilities tab
- **Survival Mode**: Craft them using the recipes above
## Progression System
The mod follows a natural progression:
1. **Early Game**: Iron Divining Rod (easiest to craft)
2. **Mid Game**: Gold Divining Rod
3. **Late Game**: Diamond Divining Rod
4. **End Game**: Ancient Debris Divining Rod (for finding Netherite)
## Troubleshooting
### Missing Texture
If you see a purple/black checkered texture:
- Textures should be at: `src/main/resources/assets/diviningrod/textures/item/`
- Files needed:
- `iron_divining_rod.png`
- `gold_divining_rod.png`
- `diamond_divining_rod.png`
- `ancient_debris_divining_rod.png`
- Rebuild the mod after adding textures
### Build Errors
- Make sure you have Java 17 installed: `java -version`
- Try running `gradlew clean build` to do a clean build
- Check that you're in the correct directory (where build.gradle is located)
### Mod Not Loading
- Verify you're using Minecraft 1.20.1 with Forge 47.2.0+
- Check the logs in `.minecraft/logs/latest.log` for errors
- Make sure the JAR file is in the correct mods folder
### Rod Not Finding Ore
- The search radius is 200 blocks (spherical)
- Make sure you're at the right Y-level for the ore you're looking for:
- Iron: Y -64 to Y 320 (peaks at Y 16)
- Gold: Y -64 to Y 32 (peaks at Y -16)
- Diamond: Y -64 to Y 16 (peaks at Y -59)
- Ancient Debris: Y 8 to Y 119 (peaks at Y 15)
## Technical Details
- **Mod ID**: diviningrod
- **Version**: 1.0.0
- **Minecraft Version**: 1.20.1
- **Forge Version**: 47.2.0+
- **Java Version**: 17
- **Search Radius**: 200 blocks (spherical)
- **Item Durability**: 256 uses per rod
- **Cooldown**: 40 ticks (2 seconds)
## Tips for Players
- **Use the right tool for the job**: Don't waste your Diamond Rod looking for iron!
- **Check your Y-level**: Different ores spawn at different heights
- **Explore caves first**: Divining rods work through walls and can save you tons of mining
- **Bring spares**: Each rod only has 256 uses
- **Listen for the sound**: Success has a pleasant chime, failure has a fizzle
## License
MIT License
## Credits
Mod created for Minecraft 1.20.1 Forge
## Support
For issues or questions about the mod, check the troubleshooting section above or review the code in the `src` directory.
