Integrate FairPlay with GrimAC

The Grim integration can forward Grim flag events through its hooks.yml entry. Transaction provider selection is configured separately in transaction.yml.

Grim flag events and transaction sync

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

Install Grim 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
PrerequisiteWhat to check
Hook entryThe grim entry in generated hooks.yml owns this integration; review its enabled flag in the generated file rather than assuming it is on.
Grim plugin APIInstall GrimAC and confirm its documented flag event is available for the release you use.
Transaction settingSet 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 grim entry. Use the key spelling and values shown in your generated file.

  • Example keys in the generated file: plugin-name: GrimAC, the event class ac.grim.grimac.api.events.FlagEvent, and the excluded checks RotationBreak and RotationPlace. Check your current hooks.yml before editing.
  1. Confirm the plugin-name value reads GrimAC and the event-classes list contains ac.grim.grimac.api.events.FlagEvent.
  2. The default for blacklisted-checks is RotationBreak and RotationPlace; check the current generated hooks.yml value. Any listed entry excludes that check from this hook.
  3. Review notification-cooldowns, whose default entry is 10000, plus event-priority with default MONITOR and ignore-cancelled-events with default false.
  4. Review the triggers list, which includes grim-combat-aim-compensation and a disabled example entry grim-global-example-disabled. Review Grim's alert output to confirm the integration is active.
  5. Confirm enabled, debug, and verbose-debug reflect the intended policy; leave notification and punishment subfields at generated values unless the operator owns the change.

If the hook stays silent

If the hook stays silent
CauseAction
GrimAC absent API unavailableInstall the Grim release using its documentation and confirm the required event API is available; the hook cannot fire without it.
event-classes edited to a wrong nameRestore the generated value ac.grim.grimac.api.events.FlagEvent and check the generated file for the expected key names.
Check excluded via blacklisted-checksRemove the entry or keep the exclusion as an explicit policy decision.
Staff messages throttled by notification-cooldownsAllow for the 10000 default window and compare against the deployed value; throttled output does not mean accounting stopped.
Expecting transaction sync from the flag hookConfigure the provider separately under transaction.yml; the flag hook never selects it.
Browse all documentation