Dedicated Server Hosting

A simple guide for getting a Staxel Dedicated server up and running.

Guide Pre-Notes

If you want to host a server on your own PC, this guide is excellent for doing so:
Edy Nelson's "How to host a server [BASICS]"

The guide was created with a dedicated server running Windows Server 2012.

This currently only works on Windows OS' due to the dedicated server requiring the XNA Framework.
If you are able to get it working on any of the Unix flavors, please let me know and I will create a section for this.

Requirements:
Server - Hardware & Windows OS (Currently)
SteamCMD
Valid Ownership of Staxel
Time & Patience
Port 38465 (Or Custom Port) forwarded

Any additional notes and notices will be posted in this section.

SteamCMD - Initial Setup

So the first step is to get SteamCMD on your server.

If you would rather a more in-depth guide on SteamCMD download and configuration, please follow:
https://developer.valvesoftware.com/wiki/SteamCMD#Windows
Note: Although the guide shows you can get it on Linux/OS X you should note that the currently supported OS for the game's dedicated server is Windows.

If you are savvy with SteamCMD, download it here:
https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip

Extract and place the exe "steamcmd.exe" into it's own folder on the desktop or wherever you would like to keep it.

Run SteamCMD and we will get onto the next step.

SteamCMD - Staxel Game Files Download

Note: All commands you will be entering will be in bold.

SteamCMD will open in a Command Prompt window like the one below:


Type in "login <steam login name>"


Enter your password and SteamGuard key

After the first time doing this it should cache your login credentials for an easier login/update


Enter these commands in order:

force_install_dir "<Directory you want the files installed to>"
Example:

 force_install_dir "C:\Users\BOB\Desktop\Staxel" 

app_update 405710 validate

Let the game download and validate.

To exit SteamCMD, type in "quit"

Assuming you have typed all the commands correctly and own the game, you should have a folder with all the Staxel files.

Server Game Files Setup

Navigate to the install folder and into the _CommonRedist\XNA folder\4.0
Example:

 E:\Staxel\_CommonRedist\XNA\4.0 

Run the msi file "xnafx40_redist.msi"
Install like you would normally.

After the install, you will go into the root bin folder.
Example:

 E:\Staxel\bin 

Run the "Staxel.ServerWizard.exe"
Example:

 E:\Staxel\bin\Staxel.ServerWizard.exe 

On to the server setup.

Server Configuration

Basic Server Configuration

Main things you will need to worry about:
Public/Private
Gamemode
Server Name
Port

Options

• Public (Server will be visible on server list)

  If checked will allow server to be seen on the master server list.
  
  

• Creative Mode

  Much like Minecraft Creative mode that allows the user to use all blocks.
  On : Starts server in Creative Mode
  Off : Starts server in Adventure(?) Mode
  Keep Server Setting : Last used setting
  
  

• Server Name

  The name that is shown on the master server list.
  Note: This will only be able to be set if server is set to Public
  
  

• Port

  The Port that network traffic will be using
  
  

• Password (Optional)

  Password protect your server
  
  

• Allow unauthenticated players

  Allows users who cannot be authenticated with steam to connect to your server.
  (I think this stops people who are using a pirated copy of the game to connect)
  Note: Only available if you set server to Public
  
  

• Attempt automatic UPnP portforwarding

  If router supports this, you are able to host without portforwarding.
  
  

• Storage name

  The save folder name for this world.
  If you type in a new name, the world will reset and create a new world in that folder.
  Note: The old folder will still stay there. If you want to go back to an old save/world you can just type in the old folder's name here.
  You can find the folder located in the LocalContent folder.
  Example:
  

   E:\Staxel\LocalContent 

  
  

• External Server Address

  Your IP address that users that are not playing on the server will use to connect to your server.
  
  

• localhost

  If you are playing on the computer that is hosting the dedicated server, you will use this too connect instead of the external.
  Note: Both External and this should work.
  
  

• Test Port

  Press the button to test if the port you had specified is currently open and accepting traffic.
  
  

• Start Server

  It starts your server.

Easier Game Updating

So with this being a new game, you will need to update quite a bit. It's not that fun to type all those pesky SteamCMD commands to update.

Here is a quick tip for creating a .bat file to auto update the game.
Note: This can only be used/done after the initial setup and sometimes if using SteamGuard you might have to do it the manual way every so often.

Open a notepad.

Type in:
<SteamCMD Path> +login <Steam Login Username> +force_install_dir "<Staxel Root Folder install>" +app_update 405710 validate +quit
Example:

 
E:\steamcmd\steamcmd.exe +login <My SteamID> +force_install_dir "E:\Staxel" +app_update 405710 validate +quit

Save as a .bat file

Run the .bat file whenever the server needs to be updated.

READ ME

Before updating the game, you NEED to shut down the server.

Additional Notes

Note: The first person to join the server is given the admin powers + tutorial.
All others will get the 700 free Petals with a pet house.

Commands (type /help in-game for a full list of commands):
/fly
/op <username> - Give admin powers
/kick <username> - Kicks the player from the server
/ban <username> - Bans a user (forever I think)
/unban <username> - Removes the ban on the player
/noclip - Walk through walls.
/tp <target player> <teleport target player>
/givepetals - Gives you money!
/stealpetals - Punish those people who steal from the friendly townsfolk

Any additional questions should be posted in the comment section. I'll try to help as time permits.

See a problem with the guide or spelling? Let me know!

[The Virologist]

@Jodian, Where in the world is the option to find the Number of Farms?

[Jodian]

Oh, the server configuration has changed too. Appears there are a couple more options now, like the world size and the number of farms. You can also run it using command-line entries instead of using the server configuration program.

[Jodian]

Thanks for the reply @#root... Played for a bit on dedicated and can confirm. When nobody is on the game pauses. When one player is on the game is completely live. That player has to tend to everything, no matter how many farms there are, or the other players will lose what they planted. Not sure what happens to animals.

To answer any other questions that might come up. The initial and main quest goes to the first player who joins the new server. They get to deal with Farm Fan. Side quests (fishing hole, museum, etc) are given out based on a "first come, first serve" basis as they're available.

The journal is NOT shared, however other players CAN help complete quests once the quest owner puts down the build outline (barn, fishing hole, etc). Also, the quest owner is the only one who gets the free items (fishing rod, etc) from completed quests, but others can buy the item in the shop the next day.

[Weasel]

@Jodian, I haven't touched this since the initial release of the game. I believe the answer is that if your friend is on and you are not, any crops that are not tended too will die.

[Jodian]

Awesome guide, but I'm wondering... What happens if you're not online but your friend decides to work on their farm? Do your animals/crops die off due to not being tended to?

[St3v3]

@StevenMoky, I Tested Server on Ubuntu with Wine and it works fine, maybe this could help you?

[Weasel]

@StevenMoky, So far only Windows OS' are supported due to the server requiring XNA Framework. If you could get XNA Framework working on CentOS you might be able to run the server. As of now, there is no official support. I'm sure in the future they will allow CentOS to use it.

[StevenMoky]

Will the server supported on CentOS ?

[StevenMoky]

Wow, that's very helpful, thank you for this tutorial.