Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/8aty/orelogger
Plugin designed to track ore mining activity on server
https://github.com/8aty/orelogger
anticheat antixray discord-webhook free minecraft minecraft-plugin spigot
Last synced: about 6 hours ago
JSON representation
Plugin designed to track ore mining activity on server
- Host: GitHub
- URL: https://github.com/8aty/orelogger
- Owner: 8aty
- License: agpl-3.0
- Created: 2025-02-07T13:31:17.000Z (1 day ago)
- Default Branch: 8aty
- Last Pushed: 2025-02-07T15:16:57.000Z (1 day ago)
- Last Synced: 2025-02-07T15:37:47.229Z (1 day ago)
- Topics: anticheat, antixray, discord-webhook, free, minecraft, minecraft-plugin, spigot
- Language: Java
- Homepage: https://tomy.cc
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# OreLogger
[](LICENSE)
[](https://github.com/8aty/OreLogger/releases)
[](https://github.com/8aty/OreLogger/releases)
[](https://maven.apache.org/)
[](https://github.com/8aty/OreLogger)
OreLogger is a lightweight Minecraft plugin that meticulously tracks ore mining on your server. It logs every ore mined by players and sends real-time alerts to both Discord and in-game chat for admins. With customizable settings, OreLogger helps prevent cheating like x-raying. It also supports cross-world teleportation, making it ideal for monitoring resource gathering and ensuring fair play across your server.
---
## Features
- **Discord Integration**: Sends detailed embeds to a Discord webhook when ores are mined.
- **Admin Alerts**: Sends clickable teleport messages to admins in-game for quick investigation.
- **Configurable Ores**: Customize which ores are tracked via the `config.yml` file.
- **Session Delay**: Group ore mining events into sessions with a configurable delay (default: 15 seconds).
- **Cross-World Teleportation**: Admins can teleport directly to the world and coordinates where ores were mined.
- **Alert Toggle**: Admins can enable/disable alerts using `/orelogger togglealerts`.
- **Reload Command**: Reload the configuration dynamically with `/orelogger reload`.
---
## Changelog
See the full changelog [here](changelog.md).
---
## Requirements
- Java 21 or higher
- Discord Webhook
- Minecraft Server 1.21.x
- Permission plugin ([LuckyPerms](https://luckperms.net/) recommended)
---
## Installation
1. **Download the Plugin**:
- Download the latest JAR file from the [Releases](https://github.com/8aty/OreLogger/releases) section.
2. **Install the Plugin**:
- Place the JAR file in your server's `plugins/` folder.
3. **Restart the Server**:
- Restart your server to generate the default `config.yml` file.
4. **Configure the Plugin**:
- Edit the `config.yml` file to set up your Discord webhook URL, tracked ores, and session delay.
---
## Configuration
The `config.yml` file contains all configurable options for OreLogger. Here’s an example:
```yaml
# Discord webhook URL for sending alerts
webhook-url: "https://discord.com/api/webhooks/..."
# List of ores to be tracked by the OreLogger
tracked-ores:
- IRON_ORE
- DEEPSLATE_IRON_ORE
- GOLD_ORE
- DEEPSLATE_GOLD_ORE
- DIAMOND_ORE
- DEEPSLATE_DIAMOND_ORE
- EMERALD_ORE
- DEEPSLATE_EMERALD_ORE
- LAPIS_ORE
- DEEPSLATE_LAPIS_ORE
- REDSTONE_ORE
- DEEPSLATE_REDSTONE_ORE
- NETHER_GOLD_ORE
- ANCIENT_DEBRIS
# Delay in seconds before a mining session is processed
# Note: Setting this value too low may cause performance issues due to frequent processing.
# It is recommended to use a reasonable delay to ensure optimal server performance.
session-delay: 15 #Default is 15 seconds
```
---
## Commands
| Command | Permission | Description |
|--------------------------|---------------------|-----------------------------------------------|
| `/orelogger reload` | `orelogger.reload` | Reload the configuration without restarting. |
| `/orelogger togglealerts`| `orelogger.alerts` | Toggle admin alerts on/off. |
| `/orelogger tp` | `orelogger.tp` | Teleport to ore mining locations. |
---
## Permissions
| Permission | Description | Default Value |
|-----------------------|-------------------------------------------------------------------|---------------|
| `orelogger.reload` | Allows reloading the configuration. | op |
| `orelogger.alerts` | Allows receiving admin alerts in-game. | op |
| `orelogger.tp` | Allows teleporting to ore mining locations. | op |
| `orelogger.ignores` | Prevents logging of ores mined by players with this permission. | false |
---
## Usage
### Discord Webhook Alert
When a player mines ores, the following embed will be sent to Discord:
---
### In-Game Alert
Admins will see the following message in-game:
Clicking the message will teleport the admin directly to the specified coordinates in the correct world.
---
## Support
For support or questions, contact the author or open an issue on GitHub.
---
## License
This project is licensed under the AGPL 3.0 License. See the [LICENSE](LICENSE) file for details.
---
### Developed by 8aty, personal website: [VISIT](https://tomy.cc/)