Skip to content

Getting Started

Dawson edited this page May 17, 2022 · 5 revisions

Installation

1. Download Kauri Anticheat. You may download from:

2. Download the latest version of Atlas on Spigot [Note: The Spigot download link will redirect you to Atlas's GitHub Page]

3. Drag both .Jar files into your server's "plugins" folder like this: image

4. Startup your server and watch Kauri go!

Compatibility

While Kauri is tested to be compatible with as much as possible, not everything is compatible with Kauri.

Minecraft Versions

Kauri is designed to be compatible with Minecraft Versions 1.7.10-1.18.2. Therefore, Kauri should run on server's based on these versions, and is tested to not have false positives with vanilla 1.7.10-1.18.2. Any other version is considered unsupported and therefore bug reports for other versions will not be considered.

BungeeCord

If you run BungeeCord, make sure to download AtlasBungee as well from the same Atlas page and put that on all BungeeCord proxies. If you want Forge mod support and/or run ViaVersion at the proxy level, you will need this for that integration or bugs may occur.

Known Incompatibilities

Lunar Client Integration

If you want to be able to integrate with Lunar Client, please download the Official Lunar Client API, download the "bukkitapi.jar", and drag that file into your "plugins" folder.

Stability

It is recommended you test Kauri on your server before allowing players to join. We also recommend you test all detections on your server before configuring them to punish players for cheating.

I update a production stable example configuration where I do the steps below for you. This config is tested on production servers, so it should be stable for you. However, if you have a lot of players, and can't risk any issues, then I recommend you do the following steps yourself.

Latest Config Here: https://pastebin.com/F3LLXpwL

How to test for Stability

  1. Replace "executable: true" with "executable: false" in the loaded config.yml. This disables any commands that would be run when a player cheats.
  2. Restart your server.
  3. Allow players to join your server and monitor /alerts. You may safely ignore any readouts in /alerts dev these will not run commands.
  4. Assess which detections are not flagging legitimate players for a minimum of 4 days, and set those to ban.
  5. We recommend that you set "cancellable: true" for detections that you don't want to execute commands, as some detections that may not be 100% stable are crucial to prevent bypasses or disablers.
  6. Any false positives you find, you can report to us via the Discussion Page or create a ticket in our Discord with Kauri logs, your server logs, your server setup (Spigot version, Atlas/Kauri version, plugin list), and a video or detailed steps to recreate the false positive.