poopyhed444 / MatrixChecks

The optimized checks for Matrix Anticheat, a powerful anticheat for Minecraft.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MatrixChecks

The highly customizable, organized, and optimized checks configuration for Matrix Anticheat, a powerful, modern, and lightweight anticheat for Minecraft 1.8 and higher.


Make sure to use files compatible with your Matrix version!
Sometimes Matrix Premium updates faster than Free; there will be a directory if so.
Legacy releases compatible with older versions of Matrix have their own branches.

Matrix Anticheat Commits since release
Checks Support Matrix Support

Features

  • Works on free & premium Matrix.
  • Tons of customization.
  • Improved violation & kick messages.
  • Lower amount of false positives.
  • Stricter checks. (Faster detection)
  • Multiple file types to suit your needs.

REQUIRED INSTALLATION NOTE:
You must install language.yml to use this configuration!
Otherwise, all messages will be unreadable and commands will not work!
Every message contains placeholders that require the language file.

📷 Previews

Improved messages

Every single message has been modified to be easily read and understood.
Messages have also been greatly reduced in length to reduce notification spam.
Notifications, kick messages, comments, everywhere with text has been modified!

Hover messages and click commands

You can hover over notification messages to see more details!
This includes client version, ping, server TPS, and the root check/component.
When you click on notifications, you'll instantly spectate the suspected hacker!
And of course, the commands and visuals are customizable in language.yml.

Customization

Every aspect of the configuration is easily customizable via language.yml!
Commands, notification format, kick message, anything you'd ever need to change.
Changes you make will take effect everywhere the variable is used.

🔧 Setup

Server Usage

  1. Download checks.yml and language.yml.
    For specific Matrix versions, head to the releases page.
  2. Rename Matrix's original checks.yml and language.yml to something else.
  3. Upload/move the new files to your Matrix plugin folder. (/plugins/Matrix/)
  4. If you downloaded any optional files, rename them to checks.yml/language.yml.
  5. Run /matrix reload or restart the server!

Alternatively, you can just run /matrix dlcfg OBCHXARALB in-game
to download the latest stable build of MatrixChecks. (This ID changes!)
The downside is that all comments are removed and the file size is reduced.

Cloud Usage

NOTE: The cloud configuration files are currently unavailable due to an issue with scripting. This message will be removed once this method is available.

  1. Download config.yml and language.yml.
  2. Rename Matrix's original config.yml and language.yml to something else.
  3. Change cloud_config.enable: false to true in config.yml.
  4. Run /matrix reload or restart the server! The checks will now update on every reboot/reload.
    For specific Matrix versions, replace main in the link with the compatible checks branch.

❔ FAQ

These checks may not work perfectly with your server.
Plugins, software, and performance can all affect how well these checks and the anticheat, in general, will work.
This is not a drag-and-drop solution! Some values may need to be changed to work best with your setup.

Matrix Anticheat, like most, isn't a perfect anticheat. It itself has bugs that we cannot fix.
These checks aim to mitigate those issues and improve what works well, but there's only so much we can do.
Tested and configured for survival and minigame servers. Tweak the checks for your own server!

What each configuration files does

checks.yml

The main checks configuration file. Includes all the advertised features.
Conditional commands, optimized checks, increased detection speed, etc.
⚠ Use this file alongside language.yml!

language.yml

The main language file. This file must be installed on every Matrix instance.
It contains every global placeholder used extensively in checks.yml.
You'll be able to configure many aspects of the checks in this file!

config.yml

Optional file that changes a few values and organizes the original config.
Includes comment and key organization, minor tweaks, and a ready-to-use cloud config.
⚠ This file does not include any major changes!

Variations

The files listed below are variations of the default configuration.
These variations are pre-made customizations for different uses.
To use these, download the files in the variation directory in place of the main files!

/variations/fake-error

All kick messages are replaced with existing and made-up error messages.
This confuses hackers since kick messages are replaced with generic errors.

/variations/kickless

Replaces all kick commands with a simple notification.
Helpful for debugging or modifying checks without getting kicked.

/variations/unknown-reason

All kick messages are replaced with a generic message and a number for staff.
This allows staff to know why a player was kicked without letting the player knowing which hacks to disable.

Miscellaneous

These are files that don't fit a category.

/cloud

A directory that contains all of the files above, but minified. These are much smaller in file size but are impossible to read.
Because of the small file sizes, these can be automatically downloaded and updated very quickly on server startup.
These are optimized for Matrix cloud usage with config.yml. For instructions, read Cloud Usage.

/.github, license.md, readme.md

These are files that are only utilized by GitHub and meant for repository information.
Contains various scripts used for repository automation that make everything easier.
You can completely ignore these files as they have nothing of importance for the end-user.

Suggested (optional) changes These are just suggestions, don't change them if you don't need to. Only use these if you're having issues with the listed checks!
Root Check Path Default Suggestion Reason
click max_cps 18 16 - 24 The highest possible CPS achieved by humans is 24. Lag may affect the accuracy of this value.
hitbox max_reach 3.18 3.2 - 3.3 Increase if there are many false-positives with this check. This value should never be less than 3.1!
block fastplace.max_place_per_second 13 10 - 18 Increase if there are many false-positives when placing blocks, decrease if there are many bypasses.
scaffold ...delay.min_delay 8 5 - 9 Decrease if there are many false-positives when pillaring, increase if there are many bypasses.
delay check_inventory_action 4 -1 Disable this check if players receive many false-positives when shift-clicking in inventories.
  ... = relative path   X - X = range  
How do I report a bypass or false positive?

First:
Make sure this isn't an issue with Matrix itself. Test with the default Matrix config files. If the issue persists, it's most likely an issue with Matrix. You can report the issue to us, but not everything can be fixed with a checks file tweak. Head over to Matrix's support Discord and ask about the issue, or report the issue at their issue tracker.

Then:
Report the issue in the MatrixChecks support Discord or make a report at the issue page with the right template. If you describe what you want to be changed/fixed thoroughly, the chances are that it'll be taken care of quickly. If you already know what the issue is or how to fix it, feel free to make a pull request containing the change and why you made it.

There are weird symbols in every message!

Do the "weird things" look like something along the lines of "%gp_o_pr%"? If so, you have not installed language.yml.
This file is required to replace those placeholders with what they're meant to be. Installation

Can I modify the files in MatrixChecks?

Yes! I encourage you to do so. Since all servers are different, you most likely will have to modify the files anyway.
You can also distribute it all you want or use it on a large network; just don't remove copyright notices as that's against the license.

How can I contribute?

Contributions are very welcome! If you created a new optional file or made tweaks for different minigames, feel free to contact me or make a pull request.
I don't want to start any competition with this project! Having everything in one central repository makes it much easier for the end-user to find what they want.

About

The optimized checks for Matrix Anticheat, a powerful anticheat for Minecraft.

License:GNU Lesser General Public License v3.0