FairPlay

FairPlay

Validates the client mod list to keep gameplay fair. FairPlay is designed for server administrators and players who want to ensure clients are running a legitimate, unmodified game environment.

Features

• Client Mod List: Lists active client mods if the client has the mod installed
• Mod Blacklist: Configurable blacklist of prohibited mods
• Auto-kick: Optionally automatically kick players using blacklisted mods or does not have FairPlay installed
• Time Flexibility: Adjustable timeframe for mod validation during server join

Commands

• /fairplay: Check if the mod is installed on the server
• /fairplay reload: Reloads the mod configuration from JSON file
• /fairplay modlist <player_username>: View the active client mods of a player (requires the player to have the mod installed)

Configuration

FairPlay is configured via fairplay.json in the server config directory. The file is regular JSON, so list values are saved as arrays and the current schema looks like this:

{
  "configVersion": 2,
  "enabled": true,
  "requiredEnforcementMode": "OFF",
  "whitelistPlayers": ["never_a_cheater"],
  "blacklistPlayers": ["history_of_cheating"],
  "handshakeWindowMS": 3000,
  "modEnforcementMode": "BLACKLIST",
  "modWhitelist": [],
  "modBlacklist": ["meteor-client"]
}

Config Options

• configVersion: Internal schema version used for migration
• enabled: Master enable/disable switch for FairPlay
• requiredEnforcementMode: Controls whether the FairPlay mod itself is required on clients
  • OFF: never require the mod
  • ALL: require the mod from everyone
  • WHITELIST: require the mod from everyone except whitelisted players
  • BLACKLIST: require the mod from only blacklisted players
• whitelistPlayers: Players exempted from requiredEnforcementMode = WHITELIST
• blacklistPlayers: Players forced into requiredEnforcementMode = BLACKLIST
• handshakeWindowMS: Time window, in milliseconds, for the client/server mod handshake
• modEnforcementMode: Controls which client mods are allowed
  • OFF: do not check client mods
  • WHITELIST: only allow mods listed in modWhitelist
  • BLACKLIST: block mods listed in modBlacklist
• modWhitelist: Allowed client mod IDs when modEnforcementMode = WHITELIST
• modBlacklist: Blocked client mod IDs when modEnforcementMode = BLACKLIST

Dependencies

Requires Fabric API

Credits

P3nguinMinecraft