SpigotVIP Anti Xray Heuristics [1.13, 1.14, 1.15] 1.3.3

Anti Xray Heuristics is an heuristically based plugin designed to catch and (if wanted) punish xrayers.
AXH has proven efficiency in detecting and punishing cheating for mining situations.
This plugin focuses on Xray detection ONLY. Thus no checks for stopping other hacks are, or will be provided. This specialization facilitates the plugin's aim to become the ultimate lightweight/drag and drop antixray solution.

I've seen all of the alternatives Spigot and mcmarket have to offer (including those offered in classic antihacks with more checks), and I feel bold enough to say that this is the current best solution. If you find anything better let me know. - @Mithrandir - AXH author.


The mining session in the showcase example lasted around 12 minutes (sped up in video) until AXH detected me.

I got caught after mining 17 diamonds, and I wasn't even mining excessively straight towards them, or too fast (I was lazy, xrayers get lazy too).

In my case, I decided I only wanted the plugin to confiscate my inventory for xraying. However, you can add whatever consequences you like.

On my main server I confiscate, send to spawn (through commands), and then ban for 5 minutes with an "uninstall xrays" message as reason.

Important disclaimers

• For this plugin to work propperly and efficiently, it is expected that the ore and terrain generation for the monitored world/s is very close to, or 100% vanilla. Else, the plugin's configuration will do it's best to provide you with options in order to calibrate itself according to your own ore scarcity. However, there is no guarantee this plugin will work as intended if your generation is not Vanilla.

• The plugin is meant to detect xrayers in mining situations, and punish them accordingly, while also balancing the gap between a legal xrayer and a hacker. Hackers can still use xrays, however they will get the ores at the same rate and time cost as a legal user, + if they are detected they risk customizable consequences.

• This plugin DOES NOT and WILL NOT block xray usage through methods such as terrain obfuscation / ore hiding. It is far more lighweight & bug free, since it's designed to be as good as possible against xray usage, without affecting the server's performance.

• This plugin currently DOES NOT detect xrayers outside of the context of cheating in order to find ores easyer.

• This plugin may present very specific caveats where xrayers may go undetected, even in mining situations. For such reason, the plugin will evolve in order to improve it's efficiency over time with further updates.


• Detect, block and/or punish players who are cheating in order to find ores easyer.
• The configurable command executions make it easyer for you to determine exactly what should happen to xrayers and when, however it's up to you to depend on other plugins for such actions.
• Choose which worlds you want the plugin to track in.
• Automatically punish xrayers if desired through configurable options (such as inventory confiscation) and automatic custom commands.
• Optionally warn staff about an xrayer when detected.
• Xrayer Vault GUI - View caught xrayers by head, name, date, and number of times detected. You can also view their confiscated inventory if you choose to activate the auto-confiscations.
• Extremely few false positives. However, in the unlikely situation where a false positive where to occur, a confiscated inventory rollback can be dispatched thanks to the Xrayer Vault GUI & commands.
• Two available persistent memory storage methods: MySQL & JSON.
• Translatable to your own language through locale.yml


• More features, but still lightweight: The core routines and checks this AntiXray executes will always be really efficient and represent very low resource usage for your server, while providing extra control over xrayer missbehaviour through many features other antixrays lack. This antixray is definetly more full circle than any other while being just as lightweight or more.
• You and your staff won't have to be chasing after xrayers manually, or consulting the limited stats and warnings provided by other antixray resource solutions. This plugin will hunt the xrayers for you, by finding them, automatically punishing them, notifying you and your staff exactly when it happens, and finally letting you decide any corrections or further actions whenever you want thanks to the GUI.
And all this is happening even while you are sleeping.
• No stupid false positives other antixrays present in situations such as mining with silk touch, and farming xp from ore nodes.
• No dependencies: This plugin doesn't, and will never depend on any other plugins.
• Drag and drop: The configurations you need to apply are minimal, however you have a fair (and above average) amount of control and customization through the configuration available.
Technically the bare minimum you need to do is not forget to choose which worlds you want AXH to monitor, in config.yml.


This plugin currently has no Bungeecord functionality. The need for it is up for debate, thus it must currently be installed per-server.
1. Stop your server.
2. Download the plugin and place it inside your server's /plugins file
3. Start the server.
4. Open /plugins/AntiXrayHeuristics/ , here you should see: config.yml, xrayers.json & locale.yml
5. Configure the plugin as you wish, however, the bare minimum you must do in order to get it to work should be to edit TrackWorlds in config.yml by adding the worlds you wish AXH to monitor, onto the list.
6. Once you have finished configuring, reload the plugin's configurations with /axh reload, or restart the server (recommended)

If you wish to change the persistent memory storage method, stop the server again, and change the StorageType in config.yml. If you are not using JSON, you can delete the xrayers.json file which is generated by default the first time you install the plugin. (Other json files may be created in future versions of this plugin for cross-load data persistence, which you should not delete)


You can see all of these commands ingame with /help AntiXrayHeuristics
/AntiXrayHeuristics - Is the base command prefix, does nothing on it's own. (Abreviation: /axh)
/AntiXrayHeuristics reload
Will reload plugin configuration and reset all tracked heuristics.
Restarting the whole server is always more recommended than using
the reload command.
/AntiXrayHeuristics ResetSuspicion [player]
Will reset a player's internal suspicion level value back to 0
Suspicion is an internal heuristically influenced value used by AXH. This
command may come in handy in some situation where you think
someone is going to trigger the plugin's xray check, but you don't want
that to happen. (I personally think this command will rarely be used,
since the real suspicion value currently cannot be displayed by any
means by the plugin, but it's still available.)
/AntiXrayHeuristics Vault
Will show a gui with all the players detected for xrays.
You can hover over the heads to get information.
You can click on the player heads to view their confiscated items (full
inventory).
/AntiXrayHeuristics Absolve <player>
Removes xrayer from xrayer vault and restores inventory.
/AntiXrayHeuristics Purge <player>
Removes xrayer from xrayer vault.
/AntiXrayHeuristics Xrayer <player>
Declares a player as xrayer, consequently applying same
consequences as though he'd been automatically handled.


AXH.Ignore
Will ignore a player from being tracked
AXH.XrayerWarning
Warns players with this permission about a detected xrayer
AXH.Commands.ResetSuspicion
Allows for reset suspicion command usage.
AXH.Commands.Vault
Allows for xray vault inspection. This consequently allows to refresh the vault by pressing the refresh button.
AXH.Vault.Purge
Allows for purging the entire vault. Basically purging all xrayer data.
AXH.Commands.PurgePlayer
Allows for usage of the player purging command, and purging players
through XrayerVault GUI
AXH.Commands.AbsolvePlayer
Allows for usage of the player absolving command, and absolving
players through XrayerVault GUI
AXH.Commands.Xrayer
Allows for usage of the xrayer declaring command

FAQ
• What happens with vault and inventory confiscation if xrayer is detected more than once?: Only one inventory is stored, following inventories after the first will not be stored.
• Does the fact that this plugin uses persistent memory make it less efficient?: No. The core monitoring functionalities of this plugin which are always running are extremely lightweight by design, relying mainly on block breaking events. Accessing memory is a rare, and optimized action which shouldn't affect your server's performance.
• What do you mean by "heuristically based"?: I simply mean that the plugin takes into account diferent variables the values of which change depending on player behaviour. These variables later determine if a player is xraying.
• Why is the plugin .jar larger than other antixray solutions?: The jar size for any plugin shouldn't really worry you. What should worry you is how it's internally built, and how intensive running that code is going to be. In AXH's case, 90% of the file size is due to code related to the GUI, and persistent memory handling, which is executed much less frequently than the main algorithms and routines.

TO DO - Will probably get to doing eventually
- More configurable command executions when: Player is absolved, Player is found xraying after a previous detection.
- Improve core heuristically based algorithms. These custom algorithms currently cost efficiently catch xrayers in mining situations, but could catch them faster, better, and with minimal false positives.
- Cross loading data preserving using JSON. Currently track data is lost during server restarts.
- Guaranteed plugin compatibility for versions 1.7.10, 1.8.9, 1.9.4, 1.10.2, 1.11.2 & 1.12.2
- Optional SSL configurations for SQL.
- More tracked data such as: Coordinates of detection (the location the player was detected xraying would be stored and displayed through gui, and maybe even teleportable to by pressing the player's head. Also last seen time could be displayed too on the head.
- Damage rollback: Optionally rollback any damage caused by the xrayer to the world, including the regeneration of mined ores.

Will consider if requested and +200 purchases occur
- Ore mining notifications and maybe even logging.
- Support for SQLite, and/or some other persistent memory storage method. Cuz why not.
- API.

Report an issue / request a feature / ask a question
• Issues will only be taken care of here: https://github.com/Mangonels/AntiXrayHeuristicsIssues/issues
• Requests on the same link, or discussion section.
• Questions may be asked both through PM and in the discussion section.

Special thanks
To @sgdc3 from AuthmeReloaded, for supervising this project.

TERMS OF SERVICE
1. You will not decompile this resource (plugin).
2. You will not sell, give, or -Redacted- this resource.
3. You will not claim this resource as anyone else's, including your own.
4. The developer is not responsible for any damage this resource might cause. Whoever uses this plugin will also first test it on a safe environment in order to verify it's propper functionality, and report any issues to the developer.
5. No guarantee - this software is provided AS IS, without any guarantee on its functionality.
6. Support for the product's usage or malfunctions is not guaranteed, however the developer will do his best to ensure indefinetly continued support.
7. The continued maintainance of this resource is not guaranteed, however the developer will do his best to ensure the maintainance's indefinete continuation.
8. The addition, subtraction, and/or modification of features present in this resource, are entirely up to the plugin's developer to ultiamtely decide.
9. By purchasing this resource, you will have access and right to download and use all resource builds which are uploaded to this platform (Spigot).
10. Refunds may only be accepted in cases where the purchased product does not meet the description on this page, and up to one week after purchase. However, it is up to the developer to determine if the conditions for refunding are met, and ultimately his decision to confirm a refund. The buyer also accepts that it's his responsability to fully read and understand the resource's description available on this same page.
11. I reserve the right to change these Terms at any time, and you agree to abide by the most recent version of these terms.