How to Create a Starbound Server Guide: Difference between revisions

From Survival Servers
Jump to navigation Jump to search
[wiki:ss-claude-11372] Fixes: wrong or outdated steps, labels and facts corrected, current pictures, dead links fixed, search title and description
[wiki:wiki-operator] Reworded to the house writing rules; facts that were wrong today corrected (approved by Ryan, Nov 17)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{#seo:|title=Starbound Dedicated Server Hosting: Rent or Host Your Own|description=How to set up a Starbound dedicated server: rent one with Workshop mods installed for you, or run the free server tool on your own PC with SteamCMD.}}
{{#seo:|title=Starbound Dedicated Server Hosting: Rent or Host Your Own|description=How to set up a Starbound dedicated server: rent one with Workshop mods installed for you, or run the free server tool on your own PC with SteamCMD.}}
Starbound ships an official dedicated server, so you can run an always-on universe that your crew joins any time. This guide covers hosting one yourself on your own hardware, and the instant alternative at the end.
Starbound has an official dedicated server, so you can run a universe that stays online for your friends to join any time.


== Before you start ==
== Before you start ==


The dedicated server is a separate free download on Steam (app <code>533830</code>), but it is '''not''' anonymously installable: its licence rides with the base game, so the machine has to sign in to SteamCMD as an account that owns Starbound. The Windows depots total about 320 MB, plus room for your universe, and the server needs one port.
The dedicated server is a separate free download on Steam (app <code>533830</code>), but it '''can't''' be installed anonymously. Its licence comes with the base game, so the PC has to sign in to SteamCMD with an account that owns Starbound. The Windows server files take about 320 MB, plus room for your universe, and the server needs one port.


'''Note:''' plenty of guides say the server tool installs anonymously. It does not. Anonymous SteamCMD answers <code>No subscription</code> for app 533830.
'''Note:''' Plenty of guides say the server tool installs anonymously. It doesn't. Anonymous SteamCMD returns <code>No subscription</code> for app 533830.


== Installing the server ==
== Installing the server ==
Line 13: Line 13:
# Install the server signed in as an account that owns Starbound: <code>steamcmd +login yourname +app_update 533830 validate +quit</code>
# Install the server signed in as an account that owns Starbound: <code>steamcmd +login yourname +app_update 533830 validate +quit</code>
# Start it from '''inside''' its <code>win64</code> or <code>linux</code> folder: <code>win64\starbound_server.exe</code> on Windows, <code>linux/run-server.sh</code> on Linux.
# Start it from '''inside''' its <code>win64</code> or <code>linux</code> folder: <code>win64\starbound_server.exe</code> on Windows, <code>linux/run-server.sh</code> on Linux.
# Forward TCP port <code>21025</code> on your router and allow it through the firewall. Forward the same number on UDP as well, and set <code>runQueryServer</code> to <code>true</code>, if you want the server to answer server-list queries.
# Forward TCP port <code>21025</code> on your router and allow it through the firewall. Forward the same number on UDP as well, and set <code>runQueryServer</code> to <code>true</code>, if you want the server to show up in server lists.


'''Note:''' the working directory matters. The <code>sbinit.config</code> file next to the executable points at <code>..\assets\</code>, <code>..\mods\</code> and <code>..\storage\</code> using relative paths, so launching the server from anywhere else quietly loads a different asset and save tree.
'''Note:''' The folder you start it from matters. The <code>sbinit.config</code> file next to the server program points at <code>..\assets\</code>, <code>..\mods\</code> and <code>..\storage\</code> with relative paths. Start the server from anywhere else and it loads a different set of assets and saves, with no warning.


== Configuration ==
== Configuration ==


Settings live in <code>storage/starbound_server.config</code>, a JSON file the server writes for itself on first boot. Two things are worth knowing before you edit it:
Settings are in <code>storage/starbound_server.config</code>, a JSON file the server writes on its first start. Two things to know before you edit it:


* If the file fails to parse, the server renames it to <code>starbound_server.config.old</code> and boots on stock defaults. The only sign is a warning in <code>storage/starbound_server.log</code>. A single stray comma undoes everything you configured.
* If the file has an error, the server renames it to <code>starbound_server.config.old</code> and starts with the default settings. The only sign is a warning in <code>storage/starbound_server.log</code>. A single stray comma undoes all your settings.
* Edit it '''while the server is stopped'''. Starbound rewrites the file on a clean shutdown, so changes made while it is running are lost.
* Edit it '''while the server is stopped'''. Starbound rewrites the file on a clean shutdown, so changes made while it's running are lost.


Keys most people change: <code>serverName</code>, <code>maxPlayers</code> (default 8), <code>gameServerPort</code>, <code>serverFidelity</code>, <code>allowAssetsMismatch</code> and the scripting limits that large modpacks need.
Settings most people change: <code>serverName</code>, <code>maxPlayers</code> (default 8), <code>gameServerPort</code>, <code>serverFidelity</code>, <code>allowAssetsMismatch</code> and the scripting limits that large modpacks need.


== Access and admin ==
== Access and admin ==
Line 38: Line 38:
== Mods ==
== Mods ==


Mods are <code>.pak</code> files in the <code>mods</code> folder. There is one trap that catches nearly everybody:
Mods are <code>.pak</code> files in the <code>mods</code> folder. There's one trap that catches nearly everybody:


'''Note:''' every Steam Workshop item publishes its payload under the identical filename <code>contents.pak</code>. Copy several into <code>mods</code> without renaming them and they overwrite each other, leaving exactly one mod installed. Rename each one to something unique first.
'''Note:''' Every Steam Workshop item uses the same file name, <code>contents.pak</code>. Copy several into <code>mods</code> without renaming them and they overwrite each other, leaving only one mod installed. Give each one a unique name first.


That collision, plus the fact that a bare dedicated server has no Steam subscription to download from, is the whole reason people report that large modpacks such as Frackin' Universe "do not work" on a dedicated server.
That's why people report that large modpacks such as Frackin' Universe "don't work" on a dedicated server. Mods overwrite each other, and a plain dedicated server has no Steam subscription to download them from.


== The instant alternative ==
== The instant alternative ==


If you would rather skip the licence juggling, the port forwarding and the mod renaming, [https://www.survivalservers.com/services/game_servers/starbound/ rent a Starbound server] from Survival Servers. Workshop mods install themselves from a browser in the Command Center, the config is rebuilt from your settings on every start so it cannot be broken by a typo, and backups and full FTP access are there from day one.
To skip the Steam sign-in, the port forwarding and the mod renaming, [https://www.survivalservers.com/services/game_servers/starbound/ rent a Starbound server] from Survival Servers. Workshop mods install from a browser in the Command Center. The settings file is rebuilt from your settings on every start, so a typo can't break it. Backups and full FTP access are there from day one.

Latest revision as of 08:49, 17 November 2026

Starbound has an official dedicated server, so you can run a universe that stays online for your friends to join any time.

Before you start

The dedicated server is a separate free download on Steam (app 533830), but it can't be installed anonymously. Its licence comes with the base game, so the PC has to sign in to SteamCMD with an account that owns Starbound. The Windows server files take about 320 MB, plus room for your universe, and the server needs one port.

Note: Plenty of guides say the server tool installs anonymously. It doesn't. Anonymous SteamCMD returns No subscription for app 533830.

Installing the server

  1. Install SteamCMD.
  2. Install the server signed in as an account that owns Starbound: steamcmd +login yourname +app_update 533830 validate +quit
  3. Start it from inside its win64 or linux folder: win64\starbound_server.exe on Windows, linux/run-server.sh on Linux.
  4. Forward TCP port 21025 on your router and allow it through the firewall. Forward the same number on UDP as well, and set runQueryServer to true, if you want the server to show up in server lists.

Note: The folder you start it from matters. The sbinit.config file next to the server program points at ..\assets\, ..\mods\ and ..\storage\ with relative paths. Start the server from anywhere else and it loads a different set of assets and saves, with no warning.

Configuration

Settings are in storage/starbound_server.config, a JSON file the server writes on its first start. Two things to know before you edit it:

  • If the file has an error, the server renames it to starbound_server.config.old and starts with the default settings. The only sign is a warning in storage/starbound_server.log. A single stray comma undoes all your settings.
  • Edit it while the server is stopped. Starbound rewrites the file on a clean shutdown, so changes made while it's running are lost.

Settings most people change: serverName, maxPlayers (default 8), gameServerPort, serverFidelity, allowAssetsMismatch and the scripting limits that large modpacks need.

Access and admin

Starbound has no plain server password. Access is accounts:

  • serverUsers maps an account name to a password and an admin flag, for example "fred" : { "admin" : true, "password" : "hunter2" }.
  • allowAnonymousConnections decides whether anyone without an account may join at all. Set it to false and only your listed accounts get in.
  • To become admin, give your own account "admin" : true, log in with it, then type /admin in chat.

Source RCON is available but off by default. Set runRconServer to true, give rconServerPassword a value and forward rconServerPort (21026 by default) if you want a remote console.

Mods

Mods are .pak files in the mods folder. There's one trap that catches nearly everybody:

Note: Every Steam Workshop item uses the same file name, contents.pak. Copy several into mods without renaming them and they overwrite each other, leaving only one mod installed. Give each one a unique name first.

That's why people report that large modpacks such as Frackin' Universe "don't work" on a dedicated server. Mods overwrite each other, and a plain dedicated server has no Steam subscription to download them from.

The instant alternative

To skip the Steam sign-in, the port forwarding and the mod renaming, rent a Starbound server from Survival Servers. Workshop mods install from a browser in the Command Center. The settings file is rebuilt from your settings on every start, so a typo can't break it. Backups and full FTP access are there from day one.