How to Make a Private Vintage Story Server (Friends Only)
Password, whitelist or both: the three settings that keep a Vintage Story server for your group, and the 1.20 default that turns your own friends away.
Most Vintage Story groups want the same thing: a world just for them, online all the time, that a stranger can't walk into and burn down. Vintage Story gives you three settings for that, and since version 1.20 two of them already start in the private position. This guide covers how to make a private Vintage Story server, which setting to use when, and how your friends get in.
The three settings that make a Vintage Story server private
All three live in the server's serverconfig.json, and each can be changed from the server console.
Public listing: off. The AdvertiseServer setting decides whether your server appears in the in-game list of public servers. Since 1.20 it is off by default. An unlisted server still works: players join by address.
A password. Everyone who joins has to enter it. Set one with /serverconfig password yourpassword. Passwords can't contain spaces, and /serverconfig nopassword removes it again.
The whitelist. With the whitelist on, only players you've added can join, password or not. Since 1.20 a new dedicated server is whitelisted out of the box. In the server's own start-up words, servers "no longer register themselves to the public servers list and are invite-only (whitelisted) out of the box".
The step up from the official server
The official Vintage Story server software from the developer, installed and running about a minute after you pay, with your worlds, mods and settings as ordinary files under data/. Backups, file manager and SFTP on every plan.
A password suits a friend group. You share one word in your group chat and anyone who has it gets in. If it leaks, change it.
A whitelist suits a group you want to name one by one, such as a community server or a group whose password has done the rounds. Turn it on and add each player:
/serverconfig WhitelistMode on
/player FriendName whitelist on
Use the exact spelling of their Vintage Story account name. It's shown at the bottom left of their game's main menu. The game's wiki notes the server doesn't need a restart after you whitelist someone.
You can use both: the whitelist decides who may join, and the password stops anyone who guesses a name.
The trap: a private server nobody can join
The 1.20 default catches a lot of first-time owners. You start a dedicated server, send your friends the address, and every one of them is turned away, because the whitelist is on and nobody is on it. The server is private, but too private.
Choose one before you invite anyone:
Friends only, with a password:/serverconfig WhitelistMode off, then set a password.
Named players only: leave the whitelist on and add everyone with /player Name whitelist on, yourself included if you'll join from the game.
Option 1: Host it yourself
Vintage Story's dedicated server comes with the game (VintagestoryServer.exe on Windows, a "server only" download on Linux). To run it privately from home:
Pick a password, or set up the whitelist as above.
Leave AdvertiseServer off.
Forward port 42420 on your router, for TCP and UDP.
Give friends your public IP.
Keep that PC on whenever anyone wants to play.
That last line is where most home-hosted worlds stop. The world is only online while your PC is, every update is yours to install, and your home IP is the address you hand out.
Open the Server Settings tab. Set the server name, a Password, and choose the Whitelist mode: off (anyone with the address and password) or on (whitelisted players only). Leave List in the public server browser off.
Restart. The game reads serverconfig.json when it starts.
Make yourself an admin. On the Console tab, type /op YourName.
Share the address. Copy it from the top of your dashboard. Friends add it under Multiplayer → Add new server as IP:port and type the password into the same form.
New Connect servers start with the whitelist off, so the "nobody can join" trap never happens. The password and whitelist are yours to switch on.
Want your existing world on it? Upload your .vcdbs save and pick it as the active world: upload your world shows how. Coming from the official server? Its store page says you can download your world, so moving off the official Vintage Story server walks through the switch.
Keeping it private once you're playing
Kick or ban someone who shouldn't be there from the console: /kick Name or /ban Name.
See who's online with /list clients.
Take a backup before you change access, mods or the world. Restoring is one click on the Backups tab.
Think about roles. A new player joins with the default role. Hand out admin with /op sparingly; an admin can change every setting above.
Since 1.20 your server is already unlisted and invite-only. Decide how friends get in: turn the whitelist off and set a password, or keep the whitelist on and add each name. If you'd rather not run a PC for it, a private Vintage Story server starts with the whitelist off and the password, whitelist and listing on one settings page.
Frequently Asked Questions
How do I make my Vintage Story server private?
Set a password with /serverconfig password yourpassword, or turn on the whitelist with /serverconfig WhitelistMode on and add players with /player Name whitelist on. Keep AdvertiseServer off so the server isn't in the public list; it's off by default since 1.20.
Is a new Vintage Story server private by default?
Since 1.20, yes. A new dedicated server isn't listed in the public server browser and is whitelisted, so only added players can join. Turn the whitelist off or add your friends before you invite them.
How do friends enter a Vintage Story server password?
In Multiplayer, they add the server (or click the pencil icon next to it), type the password into the Password field and save.
Can a Vintage Story password have spaces?
No. Use a password without spaces.
How do I add someone to the whitelist in Vintage Story?
Run /player Name whitelist on in the server console, or in chat as an admin, with their exact account name. No restart is needed.
The step up from the official server
The official Vintage Story server software from the developer, installed and running about a minute after you pay, with your worlds, mods and settings as ordinary files under data/. Backups, file manager and SFTP on every plan.