Anticheat Hook Configuration

Use hooks.yml to manage external anticheat events, notifications, filters, and priorities.

What this file controls

FairPlay provides hooks for Grim, Vulcan, NoCheatPlus, Polar, Intave, Matrix, and Spartan. The generated hooks.yml lists each hook’s plugin name, event classes, triggers, and filters.

Hook entries can include enablement, notifications, debug output, event priority, canceled-event handling, event class names, triggers, and blacklisted checks. Use the serialized names in the generated YAML file.

See the integration guide for the relevant anticheat, and follow that project’s installation and API requirements.

Enable one hook at a time using the relevant anticheat's documentation

  1. Back up hooks.yml and choose the entry for GrimAC, Vulcan, ncp, PolarLoader, Intave, Matrix, or Spartan.
  2. Use the serialized key names and values in that entry; do not infer YAML keys from Java field names or copy keys from another integration.
  3. Install the anticheat and ask its Plugin Developer for the event API required by the integration.
  4. Enable one hook, then review its notifications, filters, event priority, and canceled-event handling before changing another.

Apply and verify changes

After editing a setting, use the reload command when that setting supports reload. If the change does not take effect, check the configuration troubleshooting guide for the setting’s restart requirements.

Browse all documentation