Install FairPlay and PacketEvents
Install both plugins before starting your Minecraft server. PacketEvents is required to run FairPlay.
Documentation
FairPlay Documentation
Install FairPlay, manage checks, configure alerts, and connect your anticheat tools.
Getting started
Browse check references
Search all 169 FairPlay checks by category and find the related configuration guide.
Find commands and permissions
Find command aliases, permissions, syntax, and examples for server staff.
Installation
Install FairPlay and PacketEvents
Install both plugins before starting your Minecraft server. PacketEvents is required to run FairPlay.
Read installation guideCommands and check references
FairPlay Commands
Find command aliases, permissions, syntax, and examples for server staff.
Read reference guideFairPlay Permissions
Review command permissions, staff access, and per-check exemption nodes.
Read reference guide169 Checks
Search all 169 FairPlay checks by category and find the related configuration guide.
Read reference guideConfigure Individual Checks
Find a check’s YAML file, identify its settings, and choose the right way to apply changes.
Read reference guideConfiguration
Main Configuration
Review alerts, player logs, check controls, model settings, and diagnostics in `config.yml`.
Read configuration guidePunishment Configuration
Understand violation timing, alert cooldowns, and shared punishment settings in `punishments.yml`.
Read configuration guideMitigation Configuration
Configure per-check mitigation, reach compensation, and separate kick and ban controls.
Read configuration guideAnticheat Hook Configuration
Configure FairPlay hooks for Grim, Vulcan, NoCheatPlus, Polar, Intave, Matrix, Spartan, and LightAntiCheat+.
Read configuration guideDiscord Webhook Configuration
Set up private Discord alerts, violation thresholds, allowed role mentions, and delivery settings.
Read configuration guideTransaction Synchronization
Choose transaction providers and review probe settings and diagnostics.
Read configuration guideBan-Wave Configuration
Review ban-wave scheduling, queue limits, permissions, and moderation safeguards.
Read configuration guideRedis Alert Relay
Configure optional Redis Pub/Sub alert forwarding while keeping credentials private.
Read configuration guideWorld Snapshot Configuration
Adjust virtual world snapshot coverage, expiration, and capture limits.
Read configuration guideIntegrations
Integrate FairPlay with GrimAC
Configure GrimAC flag alerts separately from transaction provider selection.
Read integrations guideIntegrate FairPlay with Vulcan
Configure Vulcan flag alerts separately from transaction provider selection.
Read integrations guideIntegrate FairPlay with NoCheatPlus
Configure NoCheatPlus flag alerts using the `ncp` hook entry.
Read integrations guideIntegrate FairPlay with Polar
Configure Polar flag alerts separately from transaction provider selection.
Read integrations guideIntegrate FairPlay with Intave
Configure Intave flag alerts separately from transaction provider selection.
Read integrations guideIntegrate FairPlay with Matrix
Configure Matrix flag alerts separately from transaction provider selection.
Read integrations guideIntegrate FairPlay with Spartan
Configure Spartan flag alerts separately from transaction provider selection.
Read integrations guideDeveloper guides
FairPlay Developer API
Register the FairPlay service, subscribe to violations, and use the supported API lifecycle.
Read developers guideThreading for FairPlay API Listeners
Keep API listeners responsive and schedule Bukkit work on the owning entity or region thread.
Read developers guideStaff diagnostics
Latency Diagnostics
Run a bounded latency capture and interpret its output without treating it as a ping benchmark.
Read staff guideRotation Diagnostics
Start, inspect, and stop a rotation trace while protecting player identifiers and trace files.
Read staff guideTroubleshooting
Troubleshoot Missing Combat Alerts
Check staff permissions, alert toggles, target filters, and cooldowns when combat alerts do not appear.
Read troubleshooting guideTroubleshoot Configuration Changes
Check which settings reload, confirm the YAML key, and determine when a restart is needed.
Read troubleshooting guideTroubleshoot Discord Webhooks
Check webhook enablement, URL, threshold, cooldown, and delivery settings when alerts do not arrive.
Read troubleshooting guide