📜 Rapid Whitelist

A high-performance, hot-reloadable whitelist system for modern Fabric servers.

Rapid Whitelist replaces the vanilla Minecraft whitelist entirely, offering asynchronous I/O, hot-reloading, and advanced rate limiting. It is designed for servers that need a robust access control system without the performance hit of the main thread.

---

🚀 Why Use This Mod?

• ⚡ Zero Lag: All whitelist operations (add/remove/check) use async I/O to keep your server TPS high.
• 🔥 Hot-Reloadable: Edit whitelist.json manually or via command, and changes apply instantly without restarting.
• 🛡️ Rate Limiting: Built-in protection against command spam for adding/removing players and reloading.
• 🔌 Developer API: Includes a CustomWhitelistAPI for easy integration with other mods or plugins.
• 🚫 Complete Replacement: Fully bypasses the vanilla whitelist logic for total control.

---

✨ Features

🔒 Core Whitelist

• Async Storage: Player data is stored in config/customwhitelist/whitelist.json and loaded asynchronously.
• UUID & Name Support: Whitelists by GameProfile (UUID + Name) for security.
• Instant Updates: Commands update the cache immediately; manual file edits are detected via file watcher.

⚙️ Management & Control

• Full Command Suite: /rapidwhitelist add, remove, list, enable, disable, reload.
• Configurable Messages: Customize kick messages and feedback text in config.json.
• Permission Levels: Restrict commands to specific OP levels (default: Level 3).

🛡️ Protection

• Rate Limits: Configurable limits on how many players can be added/removed per minute.
• Logging: detailed logs for denied joins and administrative actions.

---

📜 Commands

Admin Commands

(Requires OP Level 3 by default)

• /rapidwhitelist add <player> - Add a player to the whitelist.
• /rapidwhitelist remove <player> - Remove a player from the whitelist.
• /rapidwhitelist list - List all whitelisted players.
• /rapidwhitelist reload - Reload config and whitelist data from disk.
• /rapidwhitelist enable - Enable the whitelist enforcement.
• /rapidwhitelist disable - Disable the whitelist (allow everyone).

---

⚙️ Configuration

The main configuration file config/customwhitelist/config.json controls behavior:

{
  "enableWhitelist": true,
  "commandPermissionLevel": 3,
  "storageMode": "json",
  "messages": {
    "kickMessage": "You are not whitelisted on this server.",
    "whitelistEnabled": "Whitelist has been enabled.",
    "whitelistDisabled": "Whitelist has been disabled."
  },
  "rateLimits": {
    "addPerMinute": 10.0,
    "removePerMinute": 10.0,
    "reloadCooldownMs": 5000
  }
}

See DOCUMENTATION.md for the full guide.