# LyttleChunkLoader
[](https://papermc.io)
[](https://hangar.papermc.io/Lyttle-Development)
[](https://discord.gg/QfqFFPFFQZ)
> ✨ Minimal, real-time Minecraft navigation overlay with direction, time, and server day tracking ✨
[📚 Features](#--features) • [⌨️ Commands](#-%EF%B8%8F-commands) • [🔑 Permissions](#--permissions) • [📥 Installation](#--installation) • [⚙️ Configuration](#%EF%B8%8F-configuration) • [📱 Support](#--support)
## 🌟 Features
### 🎯 Core Plugin Features
- Real-time overlay with MiniMessage formatting
- Player direction (
), in-game 24h time (), and server days ()
- Supports PlaceHolderAPI for coordinates and more (`%player_x%`, `%player_y%`, `%player_z%`)
- ActionBar display updates on inventory, join, teleport, or world change
- Fully configurable, lightweight, open source
---
### 🤌 Lyttle Certified
- Basic plugin without fluff
- No unnecessary features
- Full flexibility and configurability
- Open source and free to use (MIT License)
---
## ⌨️ Commands
> 💡 `` `[optional]`
| Command | Permission | Description |
|:--------------------------|:------------------------------|:-----------------------------------|
| `/lyttlechunkloader reload` | `lyttlechunkloader.reload` | Reloads plugin configuration |
---
## 🔑 Permissions
| Permission Node | Description | Default |
|:--------------------------------|:-------------------------------------|:--------|
| `lyttlechunkloader.*` | Grants all plugin permissions | ❌ |
| `lyttlechunkloader.reload` | Allows reloading config/messages | ✔️ |
---
## 📥 Installation
### Quick Start
1. Download the latest version from [Hangar](https://hangar.papermc.io/Lyttle-Development)
2. Place the `.jar` file in your server's `plugins` folder
3. Download and add [PlaceHolderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) for coordinate placeholders (`%player_x%`, etc.)
4. Restart your server
5. Edit the configuration file to customize navigation overlays
6. Use `/lyttlechunkloader reload` to apply changes
---
### 📋 Requirements
- Java 21 or newer
- Paper 1.21.x+
- [PlaceHolderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) for player coordinates
- Minimum 10MB free disk space
---
### 💫 Dependencies
- [PlaceHolderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) - Required for player coordinate placeholders
---
### 📝 Configuration Files
#### 🔧 `config.yml`
Main configuration for navigation overlays and formatting.
```yaml
COMPASS: "X:%player_x% Y:%player_y% Z:%player_z% | "
CLOCK: " | days"
update_rate: 0.5 # in seconds
config_version: 0
```
- Use additional entries via any [Material name from available_materials.txt](available_materials.txt) (e.g., `MAP`, `PAPER`) to display custom overlays.
- Placeholders:
- ``: Player's direction (e.g., South-East)
- ``: In-game world time (24h)
- ``: Days since world creation
- `%player_x%`, `%player_y%`, `%player_z%`: Provided by PlaceHolderAPI
#### 💬 `messages.yml`
Customize all plugin messages. Supports MiniMessage formatting.
### 🔄 The #defaults Folder
The `#defaults` folder serves several important purposes:
1. **Backup Reference**: Contains original copies of all configuration files
2. **Reset Option**: Use these to restore default settings
3. **Update Safety**: Preserved during plugin updates
4. **Documentation**: Shows all available options with comments
> 💡 **Never modify files in the #defaults folder!** They are automatically overwritten during server restarts.
---
## 💬 Support
### 🤝 Need Help?
[](https://discord.gg/QfqFFPFFQZ)
🐛 Found a bug? [Open an Issue](https://github.com/Lyttle-Development/LyttleChunkLoader/issues)
💡 Have a suggestion? [Share your idea](https://github.com/Lyttle-Development/LyttleChunkLoader/issues)
---
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
### 🌟 Made with the lyttlest details in mind by [Lyttle Development](https://www.lyttledevelopment.com)
If you enjoy this plugin, please consider:
⭐ Giving it a star on GitHub
💬 Sharing it with other server owners
🎁 Supporting development through [Donations](https://github.com/LyttleDevelopment)
