ThisCalculator

Everyday

How to Edit Starbound Server Config File

Updated · Standard formula, shown below

How to Edit Starbound Server Config File

Editing the Starbound server configuration file lets you control how your multiplayer server behaves, from the maximum number of players to whether PvP is allowed. This guide walks you through locating, editing, and applying changes to the starbound_server.config file, so you can tailor your server to your group’s preferences.

What You’ll Need

  • A Starbound dedicated server installed (either the SteamCMD version or the one included with the game).
  • Access to the server’s file system (local or remote via SSH/FTP).
  • A text editor that saves plain UTF-8 text (Notepad++, VS Code, or even Notepad on Windows). Avoid word processors like MS Word.

Step-by-Step

  1. Locate the configuration file. The server config is named starbound_server.config. It is generated automatically the first time you run the server. Typical locations:
    • Windows (Steam): C:\Program Files (x86)\Steam\steamapps\common\Starbound\
    • Linux (SteamCMD): /home/steam/starbound/ (or wherever you installed it)
    • If you don’t see the file, run the server once, let it generate the file, then stop it.
  2. Back up the original file. Copy starbound_server.config to a safe location like starbound_server.config.backup. This lets you restore defaults if you make a mistake.
  3. Open the file in a text editor. Right-click the file and choose “Open with� → your chosen editor. The file is in JSON format—it looks like a list of "setting": value pairs separated by commas inside curly braces.
  4. Understand the key settings. Here are the most common ones you’ll want to edit:
    • "maxPlayers" – Maximum number of players allowed (default 8).
    • "port" – The port the server listens on (default 21025).
    • "serverName" – The name shown in the server list.
    • "serverDescription" – A short description.
    • "allowAdminCommands" – Set to true to let admins use admin commands.
    • "allowAdminCommandsFromAnyone" – Set to true to let any player use admin commands (not recommended).
    • "anonymous" – Set to false to require authentication (only for servers with a registered account).
    • "clearPlayerFiles" – Set to true to wipe player data on startup (use with caution).
    • "serverFidelity" – Set to "classic" for original Starbound behavior, or "optimized" for better performance.
    • "bannedUuids" and "bannedIPs" – Lists of banned players/IPs.
  5. Make your edits. Change values carefully, keeping the JSON syntax valid. For example, to change the max players to 12, find the line "maxPlayers": 8 and change it to "maxPlayers": 12. Ensure commas are placed correctly between entries.
  6. Save the file. Save with UTF-8 encoding (most editors default to this). Do not change the file name or extension.
  7. Restart the server. Stop the server if it is running, then start it again. The server reads the config on startup. If you’re using a service like systemd, restart the service.
  8. Verify changes. Connect to your server and check that the changes took effect (e.g., see the new server name in the list, or try to have more players join if you increased the limit).

Common Mistakes

  • Broken JSON syntax: Missing a comma, leaving a trailing comma, or forgetting a quote can make the server fail to start. Always validate JSON with an online validator or by eye.
  • Editing the wrong file: There is also a starbound.config (client settings). Make sure you edit starbound_server.config.
  • Not restarting the server: Changes only apply on startup. If you edit while the server is running, they won’t take effect until you restart.
  • Changing port without firewall rules: If you change the port, you must also open that port in your firewall/router, or players won’t connect.
  • Using a word processor: Word processors may add smart quotes or other formatting that breaks JSON. Use a plain text editor.

Tips

  • Make a backup before every change, especially if you’re experimenting.
  • Use a JSON validator (like jsonlint.com) after editing to catch syntax errors before restarting.
  • Start with small changes and test incrementally.
  • If you want to reset to defaults, delete the config file and restart the server; it will regenerate with default values.
  • For a server with friends, set "allowAdminCommands" to true and give yourself admin via the admin command in-game.
  • Keep the config file in the same folder as the executable; don’t move it.

Troubleshooting

  • Server won’t start after editing: Check the server log (usually starbound_server.log in the same folder) for a JSON parse error. It will point to the line number. Fix the syntax and restart.
  • Changes not taking effect: Ensure you saved the file and restarted the server. Also check that you edited the correct file (not the client config).
  • Players can’t connect: If you changed the port, verify the firewall/router is forwarding the new port. Also check that "anonymous" is set to true if you don’t have authentication set up.
  • Server lags or crashes: If you set "maxPlayers" very high, the server may struggle. Consider lowering it or setting "serverFidelity" to "optimized".
  • Admin commands not working: Make sure "allowAdminCommands" is true, and that you are logged in as admin (use /admin in the chat, or add your UUID to "adminUuids" list).

Frequently Asked Questions

Where is the Starbound server config file located?

It’s in the same directory as the server executable. For Steam installations, it’s typically in the Starbound folder under Steam’s steamapps/common. For Linux dedicated servers, it’s wherever you installed the server files.

Can I edit the config while the server is running?

Yes, but changes won’t take effect until you restart the server. It’s best to edit with the server stopped to avoid accidental overwrites.

How do I change the server port?

Find "port" in the config and change the number (e.g., to 21026). Then update your firewall/router port forwarding to match the new port.

What does “serverFidelity” do?

It sets the game’s simulation mode. "classic" uses the original behavior, while "optimized" reduces CPU usage by simplifying some physics, which can improve performance on large servers.

How do I ban a player?

You can add their UUID to the "bannedUuids" list or their IP to "bannedIPs". The UUID can be found in the player’s .player file or via the /who command if you have admin.

Can I reset the config to default?

Yes, simply delete the starbound_server.config file and restart the server. It will generate a fresh one with all defaults.

Related

Method: the standard formula for this calculation, rounded as each result states. See how the calculators work or report an error.