Quickstart

Create the key

Open the dashboard, pick the server you want to protect, and use Settings → API keys → Create. Give it a memorable label (e.g. prod-eu-west) and store the value somewhere safe — it's shown once.

Place the folder

Copy the hoaxeye resource folder you received with your key into resources/[standalone]/hoaxeye. Don't rename the folder — the resource name is referenced inside.

Wire it up

Add a single line to your server.cfg, typically near the top of the resource list so it boots before scripted gameplay loads.

# server.cfg
ensure hoaxeye

Edit config.lua

Open resources/[standalone]/hoaxeye/config.lua and set the API key. Other defaults are safe — leave them alone for the first run.

-- config.lua
Config = Config or {}
Config.ApiKey      = "hx_live_…"  -- from the dashboard
Config.Enforcement = "observe"     -- start in observe mode for the first 24h

Starting in observe mode means hoaxeye only logs verdicts; nothing kicks players. After a day of clean logs you can flip individual detections to score or enforce.

Verify the connect path

Restart the server (or refresh; ensure hoaxeye). Connect once with your own client. Within ~5 seconds the dashboard's Recent detectionsfeed should show the join with a verdict (most likely cleared).

If you don't see anything, check the server console for a one-line warning from hoaxeye — it usually indicates an unreachable API or an invalid key.