Documentation

Overview

hoaxeye is an anti-cheat SaaS for FiveM. We produce verdicts. The operator decides what to do with them. These pages cover live detection families, the architecture concepts behind them, and what's coming on the protection side.

Numbers we'll stand behind

Three measured values that summarize what the documentation backs up. Each links to the page where the methodology is documented.

< 0.2 ms
On-server tick cost
Average resmon snapshot on a representative test server — see Server setup for the bar chart and bench notes.
0 / 59
Backdoor-scanner false positives
On the same representative test server. With a planted backdoor it cleanly fired at high severity — see Backdoor scanner.
< 50 ms
Anti-VPN connect-path lookup
Typical in-process cache hit; cold lookups pay a one-time cost per endpoint per cache window — see Anti-VPN.

Start here

New install? Walk through the Quickstart for a working setup in under ten minutes, then read Server setup for deeper config (resource whitelist, performance, Discord verify hookup).

Concepts

Two architecture concepts run through every detection family. Read these once and the rest of the documentation reads faster.

Detection & protection

Each family page describes the modes you can run it in, the public verdicts it emits, the latencies and cadences we measure, and the false-positive history that shaped the current version. The HoaxShield card links to the roadmap page for our upcoming UDP-DDoS layer.

Reference

  • API reference — public endpoints, auth, status-code semantics.
  • FAQ — false-positive appeals, whitelist requests, update cadence, emergency-bypass use cases, retention.
  • Live availability is on the status page; incidents and scheduled maintenance show up there before they show up here.

What we don't publish

These docs describe what each family does — not the exact storage locations, signal keys, regex / pattern internals or numeric score thresholds that drive the detection. Publishing those would just be a tuning sheet for bad actors. If you've signed an NDA as part of the pilot, the corresponding internals are documented in your pilot package.