Set Vintage Story Server Name & Description

This guide walks you through changing your Vintage Story server’s name and description, which are the details players see in the server list before they join. You’ll edit a simple text file and then either restart the server or use in-game commands to apply the changes. No special tools are needed—just access to your server’s files and, optionally, the server console.

What You’ll Need

• Access to the server’s root directory (where the server executable or start script is located).
• A text editor (Notepad, VS Code, nano, etc.) that can handle plain text files.
• If you want to change the description without restarting, the server console (or admin access in-game).

Step-by-Step

1. Stop the server (if it’s running) to avoid any file write conflicts. You can do this by sending stop in the console or using your hosting panel’s stop button.
2. Locate the server configuration file. In the server directory, find the file named serverconfig.json. This is the main configuration file for a Vintage Story server.
3. Open the file with your text editor. It will contain a JSON object with many settings. Look for the keys ServerName and ServerDescription. They are usually near the top of the file.
4. Edit the server name. Change the value of ServerName to your desired name. For example: "ServerName": "My Awesome Vintage World". Keep it under 40 characters if possible, as the server list may truncate longer names.
5. Edit the server description. Change the value of ServerDescription to a short description. For example: "ServerDescription": "A friendly PvE server with extra lore and events.". There’s no hard limit, but keep it concise—players see this in the list.
6. Save the file. Make sure you save it as UTF-8 without BOM if your editor offers that option. Also, ensure the file remains valid JSON—commas, quotes, and brackets must be correct.
7. Restart the server. Start the server again. The new name and description will appear in the server list after it finishes loading.
8. Alternative: change without restarting. If you have console access, you can use the command serverconfig ServerName "New Name" and serverconfig ServerDescription "New description" while the server is running. This updates the values in memory and also writes them to the config file. The changes appear immediately in the server list (though the list may take a few minutes to refresh).

Common Mistakes

• Editing the wrong file: There is also a serverconfig.json in your client save folder, but that’s for single-player. Make sure you’re editing the one in the server’s directory.
• Invalid JSON: Forgetting a comma or leaving a trailing comma before a closing brace will break the file. The server may fail to start or revert to defaults. Use a JSON validator if unsure.
• Using the wrong command syntax: The console command is serverconfig <key> <value>—note the space, not an equals sign. Also, the key is case-sensitive: ServerName, not servername.
• Not saving the file: If you edit but forget to save, or save to a different location, the changes won’t apply.

Tips

• Backup the config file before making changes. Copy serverconfig.json to serverconfig.json.bak so you can restore it if something goes wrong.
• Use a clear, unique name that reflects the server’s theme or gameplay style. Avoid special characters that might render oddly in the server list.
• Keep the description informative—mention game mode (PvP/PvE), mods, or rules. This helps players decide if they want to join.
• Test the changes by refreshing the server list in the game. Sometimes it takes a few minutes for the list to update, so be patient.
• If you use a hosting panel, there may be a GUI field for the server name—but editing the JSON still works and is often more reliable.

Troubleshooting

• The server won’t start after editing: Check the file for JSON errors. Look at the server log (usually server-main.log) for a line like “Failed to parse serverconfig.json”. Restore the backup and try again with a JSON validator.
• The name is still the old one: Make sure you saved the file and that you’re looking at the correct server in the list. If you used the console command, verify you typed the key exactly. Also, the server list may cache old names for a while—wait a few minutes or restart the server.
• The description shows as blank: This can happen if the value is an empty string or if the JSON has an error. Ensure the description is between quotes. If you used the console command, try setting it again with a non-empty value.
• Changes revert after restart: This usually means the server is writing a default config because the file is corrupted or not readable. Check file permissions—the server process must have write access to the file. Also, make sure you didn’t accidentally edit the wrong file.
• The console command says “Unknown command”: Ensure you’re typing it in the server console, not the in-game chat. The command is serverconfig, not setconfig. Also, check that you have admin rights if using it in-game (via the chat with a slash).

Frequently Asked Questions

Can I change the server name without stopping the server?

Yes, use the serverconfig ServerName "New Name" command in the console. It applies immediately and saves to the config file.

Where is the serverconfig.json file located?

In the same folder as the server executable, typically named VintagestoryServer.exe or server.sh. If you’re using a hosting provider, check their file manager for the server root.

What characters are allowed in the server name?

Any Unicode characters are allowed, but avoid control characters and quotes (unless escaped with a backslash). The server list may not display very long names well, so keep it under 40 characters.

Will changing the description affect my world or players?

No, it only changes the metadata shown in the server list. Your world and player data are unaffected.

How do I add color or formatting to the description?

Vintage Story does not support markup in the server description. It is plain text only.

Can I set the name and description from the in-game chat?

Yes, if you are an admin, type /serverconfig ServerName "New Name" in the chat. The slash is needed for chat commands.

Related

• Unlock Motorola Phone After Factory Reset
• Todo Backup Guide: Full Steps for Files, System, and Apps
• Zoom AI Companion vs Third-Party AI Agents: Privacy