Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tjrgg/mc-xrayalerts
https://github.com/tjrgg/mc-xrayalerts
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tjrgg/mc-xrayalerts
- Owner: tjrgg
- License: mit
- Created: 2024-08-18T02:15:13.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-18T20:23:02.000Z (5 months ago)
- Last Synced: 2024-08-18T21:23:31.452Z (5 months ago)
- Language: Java
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XRayAlerts
**XRayAlerts** is a plugin for Paper/Spigot servers that can alert staff members (or any player with the appropriate permission) whenever a player finds specific ores or items. It supports customizable alerts, configurable monitoring modes, and permission-based access control. The plugin is compatible with both Paper and Spigot servers running Minecraft 1.21+.
---
## Features
- **Configurable Alerts**: Customize the messages sent to staff when a player finds a monitored item or ore. Messages support color and formatting codes.
- **Vein Detection Mode**: Choose between two modes:
- **Block Mode**: Sends an alert for each block mined, indicating the number of items dropped.
- **Vein Mode**: Sends one alert for the entire vein when the first block in the vein is mined.
- **Permission Control**: Permissions to toggle alerts, receive alerts, and ignore alerts.
## Commands
### `/xrayalerts toggle`
Toggles the x-ray alerts on or off for the player who runs the command.\
**Permission**: `xrayalerts.toggle`\
**Usage**: `/xrayalerts toggle`
## Permissions
- **`xrayalerts.ignore`**: Prevents x-ray alerts from being triggered by the player.
- **`xrayalerts.receive`**: Allows the player to receive x-ray alerts.
- **`xrayalerts.toggle`**: Allows the player to toggle x-ray alerts on or off.
## Configuration
### `config.yml`
```yaml
alert-message: "&c&lX-Ray&r &7%player% found &6x%count% %item%."
mode: "block" # Options: "block", "vein"
monitored-blocks:
- ANCIENT_DEBRIS
- DEEPSLATE_DIAMOND_ORE
- DEEPSLATE_EMERALD_ORE
- DEEPSLATE_GOLD_ORE
- DIAMOND_ORE
- EMERALD_ORE
- GOLD_ORE
```
---
## License
Copyright © 2024 [Tyler Richards](https://github.com/tjrgg). [MIT License](LICENSE).