⚙️ Configuration Guide

This page will guide you through configuring ShadowGuard to work with your server’s framework and security requirements. 🛡️

👤 1. Functional requirements for players

This setting determines when ShadowGuard starts operating for a player.
You need to trigger it when the player has fully joined the server (e.g., after character selection).

Example:

Lua
Config.PlayerLoaded = "esx:playerLoaded" 
-- For ESX Framework

-- OR
Config.PlayerLoaded = "qb-core:client:OnPlayerLoaded" 
-- For QBCore Framework

-- OR
Config.PlayerLoaded = "YOUR_FRAMEWORK_OR_SELECT_CHARACTER_EVENT" 

💡 Tip:

If you use a custom character selection script, trigger the Config.PlayerLoaded event right after your player spawns in the game world.

🔑 2. Request with Image Token

This is required for image storage and processing during ShadowGuard operations.
The token is provided by FiveManage.

📥 Get your token here: https://fivemanage.com/

Example:

Lua
Config.Token = "your_fivemanage_token_here"

⚠ Important:

Keep this token private — never share it publicly.
If your token is invalid or missing, image-based protections will not work.

🛡️ 3. Other Protection Settings

All additional protection features can be configured inside: config.lua

Here you can enable/disable specific anti-cheat modules such as:

🚫 Anti-Godmode
👀 Anti-Freecam
🏃 Anti-Speed Hack
🔫 Weapon Restrictions
🎯 Aimbot Detection
...

💡 Recommendation:

Always review and adjust these settings according to your server’s needs. Disabling key protections may reduce security.

📌 Final Notes

Ensure Config.PlayerLoaded is correctly set to your framework’s event, otherwise ShadowGuardAC will not activate for players.
Config.Token from FiveManage is mandatory for full functionality.
Review config.lua regularly after updates to take advantage of new protections.

🎯 With these configurations set, your server will be ready to run ShadowGuard at its best performance.