Overview
In this guide I will explain, in the simplest terms I can, how to set up a starbound server from a dedicated server location.
Introduction
For people wanting to run a home server I suggest using PenGUIn. Makes it very simple and its a very powerful tool. This guide doesn’t include anything about penguin! Its just a tool you can use if this one doesn’t meet your needs well!
[link]I have not tested the scripts outside my dedicated server. Any problems, message me. I will fix them no problem!
Just a quick few words about why I am making this guide. I recently was introduced to starbound from a close friend. I was interested in having a constant world we could come to. I also own a dedicated server. So I did so. Was sad to see there wasn’t much information about starting a modded server. You can find enough information but its a pain. My goal is to make this the only post you need.
Keep an eye out for spelling errors/typos. I am terrible. Just terrible. Let me know of any changes that need made. I work often, but I wanted to get this guide out to everyone. Hope it helps.
Also, anyone can use any of the content to make their own guides for X type of server if you need to. Just don’t repost this same guide obviously….that would just be pointless….unless its in another language….then I guess thats cool. Yeah thats cool.
Step One: Steamcmd and Script
The first step to setting up a Starbound server is of course owning the game. You cannot download the required files if you don’t own the game. Don’t ask for support if you don’t own the game. Enough said about that.
Go ahead and download steamcmd from: HERE
Once you have done this, make a folder for the steamcmd.exe to be held. This will end up being where your server is held. (I do not show how to force an install directory)
Example I will be using is C:SteamCMD
Move the steamcmd.exe into your custom made folder. It should be empty other than the steamcmd itself. Next, you will need to make a text document and paste the following code into it:
Change the STEAM_CMD_LOCATION to the location of the folder that steamcmd is sitting in. So if you made a folder in the root of the C dive it would be “C:nameOFfolder” Replace the USERNAME and PASSWORD to your steam login info (again, you must own the game on the account you are using here.)
You will then need to save the file, naming it “starboundUP.bat” and selecting “all files” as the save type. This will make a starboundUP.bat appear in the folder. You can delete the text file at this point. You should be able to run this bat from any location on your computer.
Run starboundUP.bat
Step Two: Configure/Start Starbound Server Script
In this step you will have a functional starbound server, without mods.
Navigate to “C:Steamcmd FOLDERsteamappscommonstarboundx64 (or x32 if on a 32 bit system.) There you will see a starbound_server.exe Run it once. Then after you see “listening for incoming blah blah” close the server back down. This will generate some files.
After doing this head to C:Steamcmd FOLDERsteamappscommonstarboundstorage
You will need to edit the starbound_server.config.
THIS IS WHERE MOST OF YOU WILL HAVE A PROBLEM!
Pay close attention to this part, failure will result in your config being overwritten to the default configuration.
Edit starbound_server.config, change any true/false statements that you wish. Change your server name if you wish. You will then need to add in this code INTO the “serverUsers” : {}.
the result:
I expect a lot of reports saying this will not save. Trust me it will. This config in so picky tho. The smallest error and its overwritten.
Once the server starts, login with starbound and confirm that you can use /admin command (do not login if you plan on using mods, wait until after you are finished with guide) in chat. This command will save you a lot of heart-ache later if you ever need to cheat a bit to catch up with a friend or something.
Lastly is the server start BAT. I have written a batch file that you can leave running on a dedicated server, and if the server ever goes down while this batch file is running, it will restart it for you. The process for making the bat file is the same, make a text file and paste the following code into it:
Change “C:Change Mex64” to the location of starbound_server.exe that you want to use, either x64 or x32. Save the file as starboundstart.bat and as “all files” type. With that, you have a running vanilla server.
[FOR ADVANCED USERS]
You can add this batch as a system service. If you do, there will be no gui or terminal. It will work in the same way tho. Just go though the process of adding a system service and restart your server.
Step Three: Mods /Workshop Script
Now I know, there is much debate on the best way to load mods into your server. I will be showing the way that has worked the best for me.
First, you can do this a really easy way. Have the mods you want subscribed before you do any of this guide. This will make sure the first script downloads all your subscribed items. However, if you need to add a mod after you already made the server, you can use this simple script I made.
You will need to (again) make a text file and paste the following code into it:
Edit the steamcmd location (this is the location of the steamcmd.exe) and the username and password for your steam account.
Save the file as starboundWS.bat as “all files” type. Launching this will give you a terminal with a blank screen. This is where you type the mods id. The mods id can be found in the workshop URL for that mod. Example:
[link]1308528328
The bold and underlined part is the ID for that mod.
Type in the ID and hit enter, the script will do the rest for you. After you do this, you will need to navigate to the location of the starbound_server.exe (C:steamcmd LOCATIONsteamappscommonstarboundx64 or x32 if running 32 bit.) Edit the sbinit.config
At the top, but within assetDirectories you will need to add this line for each mod id you add:
IT IS VERY IMPORTANT that the last entry in assetDirectories doesn’t have a comma. Example of how it should look:
With that. You are finished.