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.
Official links
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
| Prerequisite | What to check |
|---|---|
| Hook entry | The 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 API | Install GrimAC and confirm its documented flag event is available for the release you use. |
| 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 grim entry. Use the key spelling and values shown in your generated file.
- Example keys in the generated file:
plugin-name: GrimAC, the event classac.grim.grimac.api.events.FlagEvent, and the excluded checksRotationBreakandRotationPlace. Check your currenthooks.ymlbefore editing.
- Confirm the
plugin-namevalue readsGrimACand theevent-classeslist containsac.grim.grimac.api.events.FlagEvent. - The default for
blacklisted-checksisRotationBreakandRotationPlace; check the current generatedhooks.ymlvalue. Any listed entry excludes that check from this hook. - Review
notification-cooldowns, whose default entry is 10000, plusevent-prioritywith defaultMONITORandignore-cancelled-eventswith default false. - Review the
triggerslist, which includesgrim-combat-aim-compensationand a disabled example entrygrim-global-example-disabled. Review Grim's alert output to confirm the integration is active. - Confirm
enabled,debug, andverbose-debugreflect the intended policy; leave notification and punishment subfields at generated values unless the operator owns the change.
If the hook stays silent
| Cause | Action |
|---|---|
| GrimAC absent API unavailable | Install 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 name | Restore the generated value ac.grim.grimac.api.events.FlagEvent 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.yml; the flag hook never selects it. |