diff --git a/README.md b/README.md index 671b502..048c1e4 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,16 @@ Let's fight X-Ray cheat with simple Math! ![XRayMonitor Logo](XRayMonitor.png?raw=true "XRayMonitor Logo") + This simple plugin monitors players' mining activity and detects potential X-Ray cheating through statistical analysis. When a player mines significantly more valuable ores (like diamonds, gold, emeralds) compared to common blocks (like stone, coal), the plugin flags them for potential cheating. The detection is based on configurable thresholds, allowing server admins to customize sensitivity according to their needs, and uses [LogBlock](https://www.spigotmc.org/resources/logblock.67333/) data to analyze mining patterns over time. This plugin requires Java 21 or higher and is compatible with Minecraft server versions 1.20.x and above. Also, it supports both Paper and Spigot server implementations. ## Download -XRayMonitor available on GitHub: https://github.com/DmitryRendov/XRayMonitor/releases +XRayMonitor available on +- GitHub: https://github.com/DmitryRendov/XRayMonitor/releases +- SpigotMC: https://www.spigotmc.org/resources/xraymonitor.131488/ ## Installation 1. Download the plugin. @@ -24,12 +27,16 @@ XRayMonitor available on GitHub: https://github.com/DmitryRendov/XRayMonitor/rel The configuration file `config.yml` is created in the plugin's folder after the first run. ## Commands -- `/xrm all` - Check the mining activity of all players on the server. -- `/xrm ` - Check the mining activity of a specific player. +- `/xrm all` - Check the mining activity of all online players on the server. +- `/xrm ` - Check the mining activity of a specific player, even offline. - `/xrm reload` - Reload the plugin configuration. - `/xrm Player world:survival` - Check a specific player's mining activity in a specific world. - `/xrm all ore:diamond_ore rate:3` - Check all players' mining activity for diamond ore with a rate of 3. +![XRayMonitor Player check](XRayMonitor-player-check.png?raw=true "XRayMonitor Player check") + +![XRayMonitor Admin notification](XRayMonitor-admin-notification.png?raw=true "XRayMonitor Admin notification") + ## Adding New Materials in the code ### Easy Extension Process: diff --git a/XRayMonitor-admin-notification.png b/XRayMonitor-admin-notification.png new file mode 100644 index 0000000..154c0a0 Binary files /dev/null and b/XRayMonitor-admin-notification.png differ diff --git a/XRayMonitor-player-check.png b/XRayMonitor-player-check.png new file mode 100644 index 0000000..ca681ae Binary files /dev/null and b/XRayMonitor-player-check.png differ