Whitelist Setup and Management Print

The whitelist restricts your server so only approved players can join. This is useful for private servers, friend groups, or any situation where you want full control over who can connect.

All commands below can be run from the in-game chat (if you have admin rights) or from the server console.

Enabling and Disabling the Whitelist

To turn the whitelist on:

/whitelist enable

Once enabled, only players on the whitelist can join. Anyone not on the list will be denied access.

To turn it off and allow all players to join again:

/whitelist disable

To check whether the whitelist is currently active:

/whitelist status

Adding and Removing Players

To add a player to the whitelist:

/whitelist add <playername>

To remove a player:

/whitelist remove <playername>

These changes take effect immediately — no restart needed.

Viewing and Clearing the Whitelist

To see all whitelisted players:

/whitelist list

To remove everyone from the whitelist at once (without disabling it):

/whitelist clear

Use /whitelist clear with caution — it removes all entries immediately and anyone currently on the whitelist will no longer be able to join until re-added.

Managing the Whitelist via File

The whitelist is stored in whitelist.json in your server directory. You can edit this file directly if you need to make bulk changes or prepare the whitelist before starting the server.

The file looks like this:

{
  "enabled": true,
  "players": [
    "PlayerName1",
    "PlayerName2"
  ]
}

Set "enabled" to true or false to control whether the whitelist is active, and add or remove player names from the "players" list.

Important: Always stop your server before editing whitelist.json by hand. Changes made while the server is running can be overwritten on shutdown.

Frequently Asked Questions

Does the whitelist survive a server restart?
Yes. The whitelist is saved to whitelist.json and persists across restarts.

Can I add players to the whitelist while the server is offline?
Yes — edit whitelist.json directly and add their names to the players list. Start the server once you're done.

A whitelisted player can't connect — what's wrong?
Double-check that their username is spelled correctly in the whitelist (names are case-sensitive). Also confirm the whitelist is enabled with /whitelist status.