Hosting a server

From Space Station 13 Wiki
Jump to: navigation, search

A simple guide for hosting your very own goonstation server, for all people of all computers, no previous admin experience, dedicated hardware, or technical know-how required. Shamelessly stolen Borrowed with permission from a forum post by Haine.

Get a copy of a server's code

Here is the code for Goonstation's last release, from March 2016. You can click the green Clone or Download button on the right side of that page, and then Download ZIP, or if you know how to use git, do that. For this guide, we will simply download it.

Note: If your BYOND version is 510 or higher, be sure to grab the goonstation-2016-byond510 branch. The file you've downloaded should be named something like goonstation-2016-goonstation-2016-byond510.

Compile the server

Unzip your chosen code somewhere or navigate to where git downloaded it. Open the .DME file (in goonstation's case this is goonstation.dme). It should load up in Dream Maker (if not, use Open With to make sure it does open with DM). Once Dream Maker loads up (it might take a couple minutes), go to Build -> Compile, seen here:

Or hit CTRL+K.

It will take a few minutes to finish compiling. Once it does, if no errors have occurred, you're ready for the next step. A successful compile should look somewhat like this (by default the server compiles with different maps):

If errors HAVE occurred, please post them here or join #imcoder on and Haine and co. will try to help resolve them.

Load Dream Daemon

You can open it through the BYOND Pager by going to the gear wheel icon in the upper right corner, or by hitting CTRL+D. This is what Dream Daemon looks like:

First you will want to hit the ... button next to the File: box at the bottom. Navigate to where your server code is (the folder with the .DME) and select the .DMB (in goonstation's case this is goonstation.dmb). If you don't have a .DMB file, go back and try step 2 again. Security, Visibility, and webclient settings can be set up however you feel like. (Set visibility to Public if you would like your server to appear on the BYOND Hub).

Select a port and forward it

In Dream Daemon, enter a number for the port (0 makes it random each time the server is started, we don't want that unless you feel like messing with the port forwarding each time (you probably don't)). It should be something in the 1000+ range, for example 8085. You will then need to forward your chosen port to your computer, through your router's admin settings. As this is different for every router and network setup, please consult for instructions on how to do so for your router.

Start the server

The GO button next to the Visibility settings box should have turned green once you loaded the .DMB and if you click on it now, the server will start up. After a minute or so (the window may appear frozen, but it isn't) the window should change to look like this:

After a minute, the window should update to tell you if the server's port is accessible to outside connections. If it says "BYOND hub reports port 8085 cannot be reached by players." you will need to go back to the port forwarding step and try again. Otherwise:

You are now all set to play!

Click the yellow arrow sign to join the game through DD, and the red stop sign to shut the server down when you're done. Click on the byond://[IP]:[port] text to copy the link to the server into your clipboard. You can then share that link with others and they will be able to join your server with it!

Once you've compiled the code the first time, you'll only need to load Dream Daemon and start up the server when you want to run it - you don't need to compile each time.

Quick Useful Tibits

Setting yourself as admin

To make yourself an admin, add your ckey (lowercase byond key) to the admins.txt file, located in the goonstation-2016/config folder. For example, if your byond key/username is GokuSmokeWeed420, your ckey would be gokusmokeweed420, and if it were Awesome McCoolkey, your ckey would be awesomemccoolkey (note that the space is removed)

Changing the map

Edit, located in the goonstation-2016/maps/config/ folder. It should not be hard to figure out what to add/change.

Further Information

You can ask for server help on the goonstation's dedicated gooncode channel, #imcoder, on SynIRC or post a new thread in the General Discussion forum.