XeroShield Documentation

Complete documentation for installing, configuring, and using XeroShield anticheat for your FiveM server.

Installation

Follow these steps to install XeroShield on your FiveM server:

Step 1: Purchase & License

After purchasing XeroShield, you will receive a license key via email. Enter this license key in our panel to activate your copy.

Step 2: Download

Download the latest version of XeroShield from our panel.

Step 3: Add to server.cfg

Add the following line to your server.cfg file to ensure XeroShield starts with your server:

ensure xeroshield

Step 4: Run Installation Commands

After starting your server, run the following commands in the server console to complete the installation:

xero install
xero safeinstall

Commands

XeroShield provides various commands to manage and configure the anticheat system.

Available Commands

Type xero commands to see a list of all available commands. Here are some of the most commonly used commands:

xero install - Installs our resource and entity protection
xero safeinstall - Installs our safeevent system
xero unban [banID] - Unban a player
xero ban [id] [reason] - Ban a player

Permissions

XeroShield uses a permission system to determine who can bypass certain checks or use administrative commands.

Tx Admin Whitelist

Tx Admin whitelist only gives you bypass to the detections. This means players in the Tx Admin whitelist will not trigger anticheat detections.

Ace Permissions

Detection Bypass:

XeroShield.Bypass

Command Bypass:

XeroShield_Command.Bypass

Menu Bypass:

XeroShield_Menu.Bypass

Alternative Whitelist

You can add any identifier in the config panel for bypass. This allows you to whitelist specific players without using Ace permissions or txadmin.

Supported identifier types:

steam
license
discord
ip
live
xbl

Server Side API

XeroShield provides server-side exports that you can use in your own resources.

Ban Player

Ban a player from your server:

exports['resourcename']:BanPlayer(source, Reason, Desc)

Parameters:

source - Player server ID
Reason - Ban reason
Desc - Description

Unban Player

Unban a player:

exports['resourcename']:UnbanPlayer(BanID)

Parameters:

BanID - The ID of the ban to remove

Client Side API

XeroShield provides client-side exports that you can use in your own resources.

Take Screenshot

Take a screenshot of a player's game:

local screenshotURL, errorMsg = exports['resourcename']:TakeScreenshot()
if screenshotURL then 
 print("Screenshot url: " .. screenshotURL)
else
 print("Screenshot error: " .. tostring(errorMsg))
end

Record Video

Record a short video of a player's game:

local VideoUrl, errorMsg = exports['resourcename']:RecordVideo()
if VideoUrl then
 print("Video url: " .. VideoUrl)
else
 print("Video error: " .. tostring(errorMsg))
end

Troubleshooting

Common issues and their solutions:

Installation Issues

If you encounter issues during installation, try the following:

Make sure your license key is correctly entered in the panel
Check your server console for any error messages
Ensure you have the latest version of XeroShield

False Positives

If legitimate players are being flagged by the anticheat:

Check if any of your server's resources might be triggering the anticheat
Contact support with details about the false positive

Support

If you need additional help, please contact our support team through:

Discord