# OreFinder - Ore Tracking Compass

OreFinder is a feature-rich Minecraft plugin that adds a custom **Ore Compass** to help players locate nearby ores. The plugin features a unique progression system where players must discover ores through mining before they can track them.

## ✨ Key Features

### Ore Compass
- Custom craftable compass item for tracking ores
- Right-click to open an intuitive GUI for ore selection
- Real-time distance tracking displayed in action bar
- Works in both main hand and offhand

### Progression System
- **Discover to Unlock**: Mine ores to unlock them in your compass
- **Level Up System**: Gain XP by mining ores to level them up
- **Increased Range**: Higher levels = greater tracking range
- **Visual Progress**: See your XP progress and level in the GUI

### Supported Ores
- Coal, Iron, Copper, Gold
- Redstone, Lapis Lazuli
- Diamond, Emerald
- Nether Quartz, Nether Gold
- Ancient Debris
- Both overworld and deepslate variants

### ⚙️ Highly Configurable
- Customizable leveling curves and XP rates
- Adjustable tracking ranges and update intervals
- Configurable crafting recipe (or disable crafting entirely)
- Customizable messages with color code support

### User-Friendly GUI
- Clean interface showing all ore types
- Visual indicators for locked/unlocked ores
- Level and range information at a glance
- XP progress bars for each ore

## Commands

- `/or give [player]` - Give an ore compass to yourself or another player
- `/or reload` - Reload the plugin configuration
- `/or config` - View and modify plugin settings

**Aliases:** `/orecompass`, `/orefinder`

## Permissions

- `orefinder.use` - Use OreFinder commands (default: true)
- `orefinder.give` - Give ore compass to players (default: op)
- `orefinder.reload` - Reload plugin configuration (default: op)
- `orefinder.config` - View and modify configuration (default: op)

## ️ Installation

1. Download the `OreFinder-1.5.jar` file
2. Place it in your server's `plugins` folder
3. Restart your server or use a plugin manager to load it
4. Configure the plugin in `plugins/OreFinder/config.yml` (optional)
5. Enjoy!

## How to Use

1. Obtain an ore compass via crafting or the `/or give` command
2. Mine ores naturally to unlock them in your compass
3. Right-click the compass to open the ore selection GUI
4. Click on an unlocked ore to start tracking it
5. Hold the compass to see distance updates in your action bar
6. Keep mining to level up ores and increase tracking range!

## Default Crafting Recipe

Top Row: Diamond - Ender Pearl - Diamond
Middle Row: Ender Pearl - Compass - Ender Pearl
Bottom Row: Diamond - Ender Pearl - Diamond

The recipe is fully customizable in the config file and can be disabled if you prefer to distribute compasses via commands only.

## Data Persistence

Player data (discovered ores, levels, XP) is automatically saved and persists across server restarts.

## Perfect For

- Survival servers looking to add quality-of-life features
- Servers with custom mining mechanics
- RPG servers with progression systems
- Any server wanting to enhance the mining experience

## Performance

OreFinder is designed with performance in mind:
- Efficient ore searching algorithm
- Only tracks when players hold the compass
- Configurable update intervals
- Minimal server impact

## Support

If you encounter any issues or have suggestions, please leave a comment or contact me!

Note: This plugin was not created by AI, the only thing created by AI was the description.