How to manage a Vintage Story server whitelist
By default, Vintage Story servers are protected by a whitelist. Add players to the whitelist to allow them to join your server. This guide will show you how to do that in a few simple steps.
Adding players to the whitelist
- Start your server
- Open the
Console
screen in the app - Enter the command
/player PlayerName whitelist on
- Replace
PlayerName
with the actual name of the player you want to add - Capitalization of the player name does not matter
- Replace
Removing players from the whitelist
- Start your server
- Open the
Console
screen in the app - Enter the command
/player PlayerName whitelist off
- Replace
PlayerName
with the actual name of the player you want to add - Capitalization of the player name does not matter
- Replace
Problem: Player does not exist
If you try to add a player that does not exist, you'll see the following message in the server console:
[Server Notification] Handling Console Command /player PlayerName whitelist on
[Server Debug] Response from auth server: {"playeruid":null,"valid":1}
[Server Debug] Response from auth server: {"playername":null,"valid":1}
[Server Notification] Error in argument 1 (player): No player with name or uid 'PlayerName' exists
In that case, make sure to double-check the spelling of the player name and try again.
Problem: Player is not on the whitelist
If a player tries to join your server without being on the whitelist, they'll see the following message:
You were disconnected from this server
This server only allows whitelisted players to join. You are not on the whitelist.
At the same time, the server console will show a message similar to this:
[Server Notification] A Client attempts connecting via TCP on 127.0.0.1:18373, assigning client id 2
[Server Notification] UDP: Client 2 connected via: 127.0.0.1:1835
[Server Notification] Client 2 disconnected: This server only allows whitelisted players to join. You are not on the whitelist.
If you want the player in question to be able to join your server, you must add them to the whitelist.