Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

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.
Expand All @@ -29,6 +30,29 @@ The configuration file `config.yml` is created in the plugin's folder after the
- `/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.

## Adding New Materials in the code

### Easy Extension Process:
1. **Add Message Entry** (in Messages.java):
```java
Quartz("quartz", "§6Quartz: §a%s"),
```

2. **Add Configuration Entry** (in Checkers.java):
```java
put("quartz", new OreConfig("quartz", Messages.Quartz, 2.0f,
Arrays.asList("nether_quartz_ore"), true));
```

### Example Future Materials:
```java
// Future Minecraft materials
put("ruby", new OreConfig("ruby", Messages.Ruby, 12.0f,
Arrays.asList("ruby_ore", "deepslate_ruby_ore")));
put("amethyst", new OreConfig("amethyst", Messages.Amethyst, 5.0f,
Arrays.asList("amethyst_cluster", "budding_amethyst")));
```

## Support
If you encounter a bug, please open an issue with detailed information. I maintain this in my spare time, so fixes may take a while, but I'll address them when possible.

Expand Down
76 changes: 0 additions & 76 deletions REFACTORING_SUMMARY.md

This file was deleted.

Binary file added XRayMonitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.