Integrate FairPlay with Matrix

The Matrix integration handles external flag events through its hooks.yml entry. Transaction provider selection is configured separately in transaction.yml.

Official links

View Matrix AntiCheat

Matrix flag events and transaction sync

FairPlay can receive Matrix flag events through its matrix entry in hooks.yml. Configure transaction synchronization separately in transaction.yml; the flag hook does not select a transaction provider.

Install Matrix and follow its documentation for the event API required by this integration. Check the integration entry and your server log if alerts do not appear.

Prerequisites

Prerequisites
Prerequisite	What to check
Hook entry	The `matrix` entry in generated `hooks.yml` owns this integration; review its `enabled` flag in the generated file rather than assuming it is on.
Required event API	Install Matrix and confirm its documentation describes the event API used by this integration.
Transaction setting	Set transaction provider options separately in `transaction.yml`; this flag hook does not configure synchronization.

Configure the hooks.yml entry

Open hooks.yml and locate the matrix entry. Use the key spelling and values shown in your generated file.

Generated entry: plugin-name: Matrix and blacklisted-checks: []. Check your current hooks.yml before editing.

Confirm the plugin-name value reads Matrix and compare the event-classes list with the event API required by your installed Matrix release.
Review blacklisted-checks, which defaults to an empty list; any entry there excludes that check from this hook.
Review notification-cooldowns, whose default entry is 10000, plus event-priority with default MONITOR and ignore-cancelled-events with default false.
Review the triggers list in the generated matrix entry. Review Matrix's alert output to confirm the integration is active.
Confirm enabled, notifications-enabled, debug, and verbose-debug reflect the intended policy; leave the punishments subfields (notify, command, increase-reach, cancel-hits) at generated values unless the operator owns the change.

If the hook stays silent

If the hook stays silent
Cause	Action
Matrix absent API unavailable	Install the Matrix release using its documentation and confirm the required event API is available; the hook needs that API to receive events.
`event-classes` edited to a wrong name	Restore the generated values and check the generated file for the expected key names.
Check excluded via `blacklisted-checks`	Remove the entry or keep the exclusion as an explicit policy decision.
Staff messages throttled by `notification-cooldowns`	Allow for the 10000 default window and compare against the deployed value; throttled output does not mean accounting stopped.
Expecting transaction sync from the flag hook	Configure the provider separately under transaction configuration; the flag hook never selects it.