Installation

How to correctly install WX AntiCheat

WX AntiCheat is an advanced, modern and affordable AntiCheat built to be performant and most importantly - functional. The AntiCheat is receiving constant updates and is actively fighting the latest methods malicious users use today.

Prerequisites

Before you can install WX AntiCheat on your server, please check the following prerequisites:

Installation

1
Step 1: Download the .zip file

Head over to your CFX.re Portal -> Assets -> Search for WX AntiCheat and Download it

2
Step 2: Drag-n-drop it on your server

Head over to your resources/ folder and unzip the file somewhere in there. For example, you can create a folder named [anticheat] and move all AntiCheat related resources there

3
Step 3: Insert the SQL file in your database

WX AntiCheat saves all player bans inside your server's MySQL database, don't forget to import the included SQL file in there!

4
Step 4: Configure the AntiCheat

Head over to the config/ folder in WX AntiCheat and modify it to your liking. Also don't forget to setup your logging webhooks correctly!

5
BONUS STEP: Rename the AntiCheat

You can also rename the AntiCheat resource to something less suspicious, so potentional cheaters won't find the resource as easily. Names like carpack, esx_logs etc. are perfect!

Webhook setup

WX AntiCheat uses Discord's webhooks as the main notification system. Logs for player detections, as well other optional logs like explosions, connecting / leaving will be sent there.

1
Step 1: Select a logging channel

Select a logging channel you want to use for receiving logs. Right click the channel and select "Edit Channel" step-1

2
Step 2: Create a Webhook

Head over to "Integrations" and create a new webhook step-2

3
Step 3: Obtain the webhook URL

After creating a webhook, click the "Copy URL" button to get it's URL. Use the URL to use it in WX AntiCheat configuration - your webhooks are safe there and players cannot access them. step-3

Warning:

Keep this webhook URL safe! Don't expose it to people that shouldn't have access to it. Anyone can send messages to a webhook with it's URL or even delete it.

Folder Structure

├───config
├───data
├───locale
├───src
│   ├───detections
│   │   ├───client
│   │   └───server
│   ├───functions
│   │   ├───client
│   │   ├───server
│   │   └───shared
│   ├───heartbeat
│   │   ├───client
│   │   └───server
│   └───nui
│       ├───client
│       │   └───modules
│       └───server
└───ui
    └───dist
        └───assets

Configuration

WX AntiCheat's configuration has been completely overhauled in the 1.0.0 (Rewrite) update to be as simple and as descriptive as possible. Every option has very descriptive comments to it that explains what the option does - this makes it easy for everyone to configure the AntiCheat exactly how they want.

The folder where all the configuration files are is config/, here you will find 3 configuration files:

  • anticheat.lua - Main AntiCheat configuration, shared between both client and the server
  • punishments.lua - Configuration for the punishments, you can set a different punishment to each detection
  • webhooks.lua - Configuration for the Webhooks and it's settings. This file is protected from the client and is only accessible on the server side.

Basic information about the main configuration:

  • You can't rename the global variable wx
  • You can't rename the option name
  • Every time configuration is in miliseconds (ms)
  • Every model needs to be wrapped in `backticks`
  • You can't add more options than there is, except for table entries (for example you can't add a line like wx.newDetection = true (obviously...))