---
title: "Configuration"
description: "Every anti-cheat setting, how the categories are organised, and how to save changes."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.asphyxia.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

The Configuration page is where you decide how Asphyxia behaves — which
detections run, how strict each one is, and what gets blocked outright.

Settings are stored with Asphyxia and downloaded by your game server when the
resource starts. That means you never edit a file to change how the anti-cheat
works.

> **Caution**
>
> Asphyxia will not start until you've saved a configuration at least once. On a
> fresh server, open this page and press **Save** even if you change nothing.

## Saving

1. **Change what you want**

   Settings are grouped into categories down the left. Changed rows are marked so
   you can see what you've touched before committing.

2. **Press Save**

   Nothing takes effect until you do. You can move between categories freely —
   changes are held until you save.

3. **Restart the resource**

   Your game server reads its configuration **once, at startup**. Restart Asphyxia
   for changes to apply:

```bash
restart asphyxia
```

> **Note**
>
> `asphyxia reload` refreshes admins and the global banlist, but **not** your
> detection settings. Those need a restart.

## Categories

### General

Server-wide behaviour.

| Setting | What it does |
| :--- | :--- |
| Test Mode | Detections log but don't punish. Useful for tuning. |
| Anti VPN | Rejects connections from known VPNs and proxies. |
| Log Retention | How many days of audit log to keep. `0` keeps them forever. |

> **Note**
>
> Anti VPN rejects players outright. If your community has members in countries
> where a VPN is a practical necessity, consider leaving it off.

### Trust Filter

The trust filter scores a player's *account* before they finish connecting, and
turns away accounts that look disposable. It's aimed at the cheater who's on
their fifth throwaway account this week.

| Setting | What it does |
| :--- | :--- |
| Enable Trust Filter | Turns the whole system on or off |
| Minimum Trust Score | The score a player must reach to connect |
| Penalize Missing Identifiers | Lowers the score for each identifier they don't have |
| Require Steam / Discord / CFX.re / Xbox | Rejects anyone without that account linked |
| Analyze Discord Account | Factors their Discord account age into the score |
| Minimum Discord Account Age | How old, in days, their Discord account must be |
| Analyze Steam Account | Factors their Steam profile into the score |
| Minimum FiveM Playtime | Hours of FiveM playtime required |

> **Caution**
>
> Start permissive. A high minimum score, or requiring an account type most of
> your players don't link, turns away legitimate newcomers as effectively as
> cheaters. Raise it gradually while watching your connection logs.

### Client Detections

Individual on/off switches for each client-side detection. Every one is listed
with what it watches for on [Detections](/anticheat/detections).

Also here:

- **OCR Keywords** — words that, if visible on a player's screen, indicate a
  cheat menu is open.
- **Blacklisted Events** — client events players should never trigger.
- **Blacklisted Weapons** and **Blacklisted Weapons List** — weapons nobody
  should be holding. Names come from [Weapons](/gta-data/weapons).

### Server Detections

Everything your server checks on its own, in three groups.

**Explosions** — invisible and inaudible explosions, damage and camera-shake
boosting, explosive ammo, a per-type blacklist (IDs on
[Explosions](/gta-data/explosions)), a rate limit, and a switch to disable all
explosions outright.

**Entity spawning** — separately for vehicles, peds and objects: a blacklist, a
whitelist, a spawn limit, and the time window that limit applies over.
Vehicles additionally have anti-throw settings for launching a spawned vehicle
as a projectile.

**Server events** — events players should never trigger, plus rate-limited
events with a count and window.

> **Note**
>
> Blacklists take **model names**, like `adder` or `a_m_y_beach_01`. The fastest
> way to get one for something already in your world is the
> [entity inspector](/anticheat/admin-menu#entity-inspector) — look at it, press
> the inspect key, and copy the model name.

### Blacklist vs whitelist

Each entity type supports both, and they behave differently:

- **Blacklist** — everything is allowed except what you list. Good for banning
  a handful of known-abused models.
- **Whitelist** — nothing is allowed except what you list. Much stricter, and
  much more work: every vehicle your server legitimately uses has to be on it.

Most servers want a blacklist. Reach for a whitelist only if you have a fixed,
known vehicle set and you're prepared to maintain the list.

### Discord Bot

Settings for Asphyxia's Discord integration — including the invite link shown
on ban cards, so a banned player knows where to appeal.

### Server Options

The webhook URL and other per-server integration settings.

## Tuning without breaking things

The most common mistake is turning a detection off because it fired once. A
better order:

1. **Read the detail.** [Strikes](/website/strikes) and [Logs](/website/logs)
   record what was actually observed.
2. **Whitelist the person**, if it's one player —
   [Whitelisting](/anticheat/whitelisting).
3. **Loosen the threshold**, if it's many players.
4. **Disable it** only as a last resort, and tell us on
   [Discord](https://discord.gg/asphyxia) so it can be fixed.

Test Mode, or `asphyxia_debug` in `server.cfg`, lets you do all of this on a
live server without punishing anyone.

Source: https://docs.asphyxia.dev/website/configuration/index.mdx
