Documentation

Updated a year ago

Overview

AzuAntiCheat is a minor anti-cheating mod for server administrators that wish to limit the use of specific plugins and maintain the quality of life on the server. It performs various checks to detect common cheats and to ensure that specific configurations are adhered to. The mod also provides configurable options for different types of users (Administrators and Moderators) and the ability to sync configurations and changes between the server and the client(s). While the mod cannot prevent all potential cheats, especially from tech-savvy individuals, it is designed to mitigate common cheats and provide tools for server administrators to keep track of suspicious activity (discord webhooks).

Features

  • Configuration version checks
  • Server-client mod synchronization using ServerSync
  • File watcher to automatically synchronize configuration changes when the configuration file is changed
  • Logging to your discord using the Azumatt.AzuAntiCheat_Webhook.yml file. Uses default discord webhook integration link
  • Checking for common in-game cheats
  • Ability to check for external cheat software like WeMod, CheatEngines, etc.
  • A whitelist folder on the server to dictate which mods a client connecting must use
  • A greylist folder on the server to dictate which mods a client can optionally use
  • Individual configurations for Moderators found in the Azumatt.AzuAntiCheat_ModeratorList.yml file.

User Types

Admin

Admin users have the ability to bypass DLL/Plugin Checks and can freely use cheats. However, if a mod does its own version checking with the client, they might still be required to have the mod installed.

Moderator

Moderators, by default, can only bypass DLL/Plugin checks. They can't activate common cheats or use cheat engines unless allowed by the server configs. Though, this doesn't give them access to any admin related cheats. Also, they must use mods to enable "cheating."

Installation

AzuAntiCheat must be installed on all clients and the server. The server files dictate what is allowed, while Admins/Moderators bypass these checks.

The mod uses ServerSync and a file watcher to ensure all clients and the server maintain the same configuration. Any changes to the configuration file made directly on the server will be synced to all clients upon saving the file.

Setup

Configurations

All configurations are stored in a series of .yml files.

  • Azumatt.AzuAnticheat.cfg - Used for additional configurations outside of the yaml files
  • Azumatt.AzuAntiCheat_Webhook.yml - Used for configuring the webhook to log to your Discord server. This is highly recommended!
  • Azumatt.AzuAntiCheat_ModeratorList.yml - Contains configurations for each individual Moderator. Uses SteamID to distinguish them.

Older versions of AzuAntiCheat used a prefix for configuration files. For instance, Azumatt.AzuAntiCheat_Webhook.yml was previously Webhook.yml. So if you are coming from another version of the mod, keep this in mind.

Whitelisting and Greylisting

AzuAntiCheat allows for the creation of a whitelist and a greylist for mods. The folders are automatically generated in the BepInEx/config folder on the server. Populate these folders with the DLLs you wish to allow.

  • Whitelist: This contains mods that the server requires all clients to have installed.
  • Greylist: This contains mods that the server allows clients to use, but doesn't require them to have.

FAQ Regarding this: Nothing in these folders actually "load" via BepInEx. Putting them here is not an indication of your server's loaded mods. This is for the Anticheat to hash and read the mods correctly even if they aren't meant to load on the server. To clarify, not all mods go on the server...so checking the plugins won't catch all of the mods, should they be client-only.

Localization

AzuAntiCheat supports localization. This means that you can create language files for different languages. For example, to add a Korean translation to this mod, a user could create a AzuAnticheat.Korean.yml file inside of the config folder and add Korean translations there.

Contact and Support

For any questions or comments, users can contact me through the Odin Plus Team Discord or my Discord server.

https://i.imgur.com/XXP6HCU.png

Disclaimer

While this mod attempts to block and help maintain the quality of life on a server that prefers to check for as much cheating as possible, it cannot guarantee the prevention of all cheats. More tech-savvy users may find ways to bypass the measures in place. Any attempts to bypass the mod should be reported to help fix the issue or otherwise should not be claimed as a bug or an issue. That being said, not all issues are fixable as some things just can't be checked without being extremely invasive to the client's machine.