> For the complete documentation index, see [llms.txt](https://ykaadocs.gitbook.io/ykaa-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ykaadocs.gitbook.io/ykaa-scripts/paid-scripts/ykaa-anticheat/configuration.md).

# Configuration

## Config Preview

```lua
Config = {}

-- PLEASE READ READMEPLEASE.MD FIRST THAN YOU CAN EDIT EVERYTHING!!!
-- READ THIS BEFORE YOU START CONFIGURATION ANTICHEAT!!!
-- FOR HELP WITH SETTING ANTICHEAT, OPEN THE DOCUMENTATION https://ykaadocs.gitbook.io/ykaa-scripts/ykaa-anticheat/introduction
-- ANTICHEAT WILL BE UPDATED IF SOMETHING DOESN'T WORK!!!

-- [PANEL]  -- For open the Admin Panel use command /yk
Config.AdminPanelIdentifiers = {  -- Steam/Discord IDs allowed to open/use Admin Panel (e.g., "discord:123456789" or "steam:110000100000000")
    "discord:1474147829810200759",
    -- "steam:10101010101010",
}

-- [HEARTBEAT]
Config.Heartbeat = true  -- If enabled AntiCheat send player 3 times message do you want stay ingame? (if player after 3 messages doesn't answer he getting kicked)
Config.HeartbeatInterval = 10000  -- Heartbeat interval in milliseconds
Config.HeartbeatPunish = "kick"  -- If player stop anticheat he getting kick - Dont change punish!

-- [JOINING]
Config.ConnectMessage = true  -- If enable player see connect message
Config.AntiVPN = true  -- If enable player cannot join with VPN
Config.RequiredSteam = false  -- If enable you can join with open Steam
Config.RequiredDiscord = true  -- If enable you can join with open Discord
Config.AntiSpoof = {
    enable = true,  -- If enable player cannot join with spoofed identifier
    AllowedIdentifiers = {  -- If player have identifier with prefix that set to true he not getting banned by spoof detection, if prefix is false he getting banned
        ['steam'] = true,
        ['discord'] = true,
        ['license'] = true,
        ['license2'] = true,
        ['fivem'] = true,
        ['ip'] = true,
    }
}

-- [ANTICHEAT LOGS]
Config.Logs = {
    Connect = true,  -- Log player connections
    Disconnect = true,  -- Log player disconnections
    Ban = true,  -- Log player bans
    Kick = true,  -- Log player kicks
    Warn = true,  -- Log player warnings
    VPN = true  -- Log VPN detections
}

-- [ANTICHEAT SETTINGS]
Config.BanPrefix = "[YKAA AntiCheat]"  -- AntiCheat Ban Prefix
Config.Locale = "cs"  -- AntiCheat locale Czech (cs) English (en)
Config.AdminAce = 'ykaaAC.bypass'  -- Admins with this ace cannot be punished
Config.DefaultPunishment = "ban"  -- Default punishment if detection is set to true (ban, kick, warn)
Config.AdminPanelAccess = "identifier"  -- Configure "ace" or "identifier" to access admin panel with identifiers or ace permissions
Config.ApperalDiscord = 'https://discord.gg/svetskypvp' -- Your discord link must be url not inv
Config.Screenshots = true  -- Enable sending screeshots
Config.TxAdminAuth = true  -- If this is enabled anticheat banned you if you admin
Config.HideIP = true  -- If this is enabled ip in logs will be hidden
Config.AntiAFK = true  -- If player afking more than 20min he kicked out server
Config.OCRCheckInterval = 20000  -- OCR check interval in milliseconds
Config.AntiAFKTime = 10  -- AFK time in minutes
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ykaadocs.gitbook.io/ykaa-scripts/paid-scripts/ykaa-anticheat/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
