A Vintage Story server keeps its settings in one file, serverconfig.json. On your server it is at data/serverconfig.json. You can change settings two ways: with /serverconfig commands while the server runs, or by editing the file while the server is stopped.
The Server Settings tab
The Server Settings tab edits the settings most owners change: server name, description, password, welcome message, public listing, whitelist, PvP, fire spread and view distance. Save, then restart the server to apply them.
Editing the file by hand
- Stop the server. The game's wiki says the server needs to be stopped before you edit the file.
- Open
data/serverconfig.jsonon the Files tab. - Change the value, keeping the quotation marks around text and the comma at the end of the line.
- Save and start the server. Changes apply on the next start.
The settings that matter
These are the lines most owners touch, with what the game's own config notes say about them.
| Setting | What it does |
|---|---|
ServerName | The name in the public server list, 4 to 80 characters. |
ServerDescription | A longer description for the public server list. May be null. |
WelcomeMessage | Shown to players when they join. {0} becomes the player's name. It may not be null, which crashes clients: use "" to turn it off. |
Password | null for no password, or a password in quotation marks. |
WhitelistMode | 0 default, 1 off, 2 on. See below. |
AdvertiseServer | true lists the server in the public server list. |
AllowPvP | false stops players hurting each other. |
AllowFireSpread | false stops fire spreading. |
AllowFallingBlocks | false turns off falling blocks completely. |
PassTimeWhenEmpty | true keeps the calendar running with nobody online. |
MaxChunkRadius | The highest view distance a player may have, in chunks. Higher values need more memory. |
DefaultRoleCode | The role new players get, suplayer (survival player) by default. |
StartupCommands | Commands the server runs at every start, one per line. |
The whitelist since 1.20
Since version 1.20, a new dedicated server is invite-only by default. The server says so as it starts: servers "no longer register themselves to the public servers list and are invite-only (whitelisted) out of the box". WhitelistMode set to 0, the default, means the whitelist is on for a dedicated server. The older OnlyWhitelisted setting no longer does anything.
Connect servers are created with the whitelist off, so friends can join with just the address.
To change it while the server runs:
/serverconfig WhitelistMode onturns the whitelist on,offturns it off./player PlayerName whitelist onadds a player. No restart needed.
To appear in the public server list, set AdvertiseServer to true and give the server a ServerName.
Port and player count
Leave Port and MaxClients as they are. Your server's start command sets both: the port to the one on your dashboard, and the player count to your plan's limit. To make room for more players, change plan: see Plans & resources.
World settings
The WorldConfig block describes the world the server loads:
SaveFileLocationis the world file the server loads at start, and creates if it does not exist. See Upload your world.Seed,WorldName,PlayStyleandWorldConfigurationare used when the server creates a new world. Changing them does nothing to a world that already exists.AllowCreativeModedecides whether/gamemode creativeis allowed at all. See Server commands.
To change a setting of the world you are already playing, use the /worldconfig command; the game's wiki has a page for it, World Configuration.
Mods and settings
Two settings deal with mods:
ModIdBlackList: players with any of these mod IDs enabled are not allowed to join.DisabledMods, underWorldConfig: installed mods, by ID, that the world should ignore.
Related
- Commands for the settings above: Server commands
- Nobody can join: Players can't join