Rapid Whitelist Mod Documentation

This documentation provides a complete guide to configuring and using the Rapid Whitelist mod.

0. Installation & Compatibility

Minecraft Version Support: 1.21.x Fabric Loader: 0.18.4 or newer Java: 21

⚠️ Important Requirement: This mod requires Fabric API. Ensure you have the version matching your Minecraft installation.

1. Commands

All commands are prefixed with /rapidwhitelist. Default Permission: OP Level 3 (Configurable in config.json).

• /rapidwhitelist add <player>

  • Description: Adds a player to the whitelist.
  • Behavior: Updates the in-memory cache and saves to whitelist.json asynchronously.
  • Rate Limit: Default 10 adds per minute.

• /rapidwhitelist remove <player>

  • Description: Removes a player from the whitelist.
  • Behavior: Immediately revokes access. The player is not kicked automatically if online, but will be denied on next login.
  • Rate Limit: Default 10 removes per minute.

• /rapidwhitelist list

  • Description: Displays all currently whitelisted players.
  • Output: Lists player names and UUIDs in chat.

• /rapidwhitelist reload

  • Description: Reloads both config.json and whitelist.json from disk.
  • Usage: Use this if you have manually edited the files.
  • Cooldown: Default 5 seconds between reloads.

• /rapidwhitelist enable

  • Description: Turns the whitelist enforcement ON.
  • Effect: Non-whitelisted players will be kicked on join.

• /rapidwhitelist disable

  • Description: Turns the whitelist enforcement OFF.
  • Effect: Anyone can join the server.

---

2. Configuration

Main Config (config/customwhitelist/config.json)

This file controls the mod's behavior.

• enableWhitelist: (Boolean) Master switch for the whitelist.
• commandPermissionLevel: (Integer) OP level required to use commands (1-4).
• storageMode: (String) Currently supports "json". Future updates may add "database".

Messages (messages)

Customize the text sent to players.

• kickMessage: Shown when a non-whitelisted player tries to join.
• whitelistEnabled/Disabled: Feedback messages for admin commands.
• alreadyWhitelisted/notWhitelisted: Feedback for add/remove commands.

Rate Limits (rateLimits)

Protect the server from command spam.

• addPerMinute: Max /rapidwhitelist add executions per minute.
• removePerMinute: Max /rapidwhitelist remove executions per minute.
• reloadCooldownMs: Minimum time (in milliseconds) between /rapidwhitelist reload calls.

Logging (logging)

• logJoins: (Boolean) Log allowed joins to console.
• logDenials: (Boolean) Log denied access attempts to console.

Whitelist Data (config/customwhitelist/whitelist.json)

This file stores the actual list of allowed players. It is automatically managed by commands but can be edited manually.

Format:

[
  {
    "id": "uuid-here",
    "name": "PlayerName",
    "created": "2024-01-01T12:00:00.000Z"
  }
]

• Note: If you edit this file manually, the file watcher should detect changes automatically. If not, run /rapidwhitelist reload.

---

3. Developer API

This mod exports a public API for other mods to integrate with.

Class: orvyn19.whitelist.api.CustomWhitelistAPI

• boolean isWhitelisted(UUID uuid): Check if a player is allowed.
• void addPlayer(UUID uuid, String name): Add a player programmatically.
• void removePlayer(UUID uuid): Remove a player programmatically.
• void reload(): Trigger a reload.