Tutorial / Settings

Join Whitelist / Blacklist

Control who may join the server: a blacklist of SteamIDs that can never join, and an optional whitelist that only lets listed players in.

What it does

This panel controls who may join the server. Blacklisted players can never join, and are kicked right away if they are online. They see the reason you typed.

With the whitelist on, only whitelisted players can join. Admins can join too while Admins may join without being on the whitelist is ticked.

Bans are separate: use Utilities > Bans for those. The lists are saved in data/kgx_admin_toolbox/joinlist.json.

Where to find it

Q menu > KGX's Admin Toolbox > Settings > Join Whitelist / Blacklist.

Superadmins only. Everyone else sees "Only superadmins can see and change who may join."

The panel

Switches
Option What it does Default
Whitelist on: only listed players may join Turns the whitelist on, after a confirmation. You are added to the whitelist automatically. Off
Admins may join without being on the whitelist Admins get in while the whitelist is on. On
Whitelist
Option What it does
List: Name, SteamID, Added by Everyone on the whitelist.
Add online player Pick a player who is online, or (type a SteamID below).
or SteamID A SteamID such as STEAM_0:1:12345678, used when no online player is picked.
Add to whitelist Adds the picked player or typed SteamID.
Add everyone online now Adds every player online who is not listed yet.
Remove selected from whitelist Removes the selected line.
Blacklist
Option What it does
List: Name, SteamID, Reason Everyone on the blacklist.
Add online player Pick a player who is online, or (type a SteamID below).
or SteamID A SteamID, used when no online player is picked.
Reason (shown to them) The reason in their disconnect message.
Add to blacklist Blacklists the player after a confirmation. Kicks them if online.
Remove selected from blacklist Removes the selected line.

How to use it

Make the server whitelist-only
  1. Open Q menu > KGX's Admin Toolbox > Settings > Join Whitelist / Blacklist as a superadmin.
  2. Press Add everyone online now to keep the players who are on.
  3. Add others with or SteamID and Add to whitelist.
  4. Tick Whitelist on: only listed players may join and press Turn on.
  5. Players not on the list see "This server is whitelisted and you are not on the list."
Keep one player out for good
  1. Pick them in the blacklist's Add online player, or type their SteamID in or SteamID.
  2. Type a Reason (shown to them).
  3. Press Add to blacklist, then Blacklist. They are kicked if online.
  4. When they try to join, they see "You are not allowed on this server: <reason>".
Let someone back in
  1. Select their line in the blacklist.
  2. Press Remove selected from blacklist.

Tips and limits

  • You cannot blacklist yourself, or an online player of a higher rank.
  • Admins are recognized a moment after joining, once your admin mod sets their rank, the same way as the server lock. With the admin bypass on, non-listed players connect and are then kicked after a few seconds if they are not admins.
  • With the admin bypass off, non-listed players are turned away before they load in.
  • Turning the whitelist on always adds you, so you cannot lock yourself out.
  • Blacklisting and removing from the blacklist are written to the player's history.
  • A SteamID must look like STEAM_0:1:12345678; otherwise you get an error.

Back to Settings

Type to search every tool, panel, setting, FAQ answer and release.