Store Page
Don't Starve Together
All Discussions Screenshots Artwork Broadcasts Videos Workshop News Guides Reviews

Don't Starve Together

Store Page
Don't Starve Together > Guides > ToNiO's Guides
Not enough ratings
How to setup dedicated server with cave on Mac OS X
By ToNiO and 1 collaborators
This guide is for helping step by step to installed a dedicated server don't starve together with cave on Mac OS X

----

I want to clarify that I will show my method to create a server on Mac OS X,
maybe it's not the best method,but at least it works fine, there are lots of ways to do this,

you can even make your own scripts, I just want to explain the installation with maximum information,
I give just one example but you can customize your install as you wish

----

This guide is making on Mac OS X Yosemite 10.10.5,

I use VMware Workstation for make this guide

this software can virtualize any system on your computer without change your current system

so I don't use FTP client to transfer files as Filezilla or Flashfxp

but you can very well do for cluster.ini, server.ini, worldgenoverride.lua and other file
   
Award
Favorite
Favorited
Unfavorite
Created by
ToNiO
Offline
Gingercook
Offline
Category: Modding or Configuration, Multiplayer
Languages: English
Posted
Updated
29 Feb, 2016 @ 9:45am
30 Dec, 2020 @ 1:45pm
2,932 Unique Visitors
22 Current Favorites
Guide Index
Overview
Summary 
Create your user for your server Don't Starve Together: 
Download SteamCMD 
Installing server Don't Starve Together with SteamCMD 
Script for server Overworld and Cave 
Start and stop both server, that's going create settings folder Master (Server Overworld) and Caves (Server Caves) 
You need to settings both servers with cluster_token.txt, server.ini, worldgenoverride.lua 
Put your token in cluster_token.txt 
Add worldgenoverride.lua on both servers 
List of option for cluster.ini and server.ini 
Create and configure cluster.ini and server.ini 
Script for restart server Overworld and Cave 
Testing both servers 
Check if servers running correctly, and make a schedule task 
We going used crontab, this service allows to create scheduled tasks on Mac OS X 
If you want stop both servers you can use htop on Mac OS X 
FAQ - How to reset the map on dedicated server? 
FAQ - How to make rollback on dedicated server? 
FAQ - How banned player if he is not on my dedicated server? 
FAQ - How add admin on your dedicated server? 
FAQ - How to reserved slots on your dedicated server? 
Comments
Summary
Create your user for your server Don't Starve Together:
when you are admin on your Mac, create user dst







Download SteamCMD
log off of your account admin and login with your user dst

now you going start the terminal and download steamcmd








Installing server Don't Starve Together with SteamCMD
extract the content of SteamCMD and install the server
  • tar -xvzf steamcmd_osx.tar.gz
  • ./steamcmd.sh
  • login anonymous
  • force_install_dir /Users/dst/server_dst
  • app_update 343050 validate
  • quit









Script for server Overworld and Cave
you need to create two scripts for start two instances for each of the servers
(start.sh and start2.sh)

so i use text editor nano, but you can use other without problem

when you are in nano,
just write your text and for save and quit press CTRL + X and Y for valid

this is for server Overworld:





this is for server Cave:
  • nano start2.sh
  • ./dontstarve_dedicated_server_nullrenderer2 -console -cluster MyDediServer -shard Caves





here the option list for command line:

-persistent_storage_root

  • Change the directory that your configuration directory resides in. This should be an absolute path. The full path to your files will be <persistent_storage_root>/<conf_dir>/ where <conf_dir> is the value set by -conf_dir. The default for this option depends on the platform:

  • Windows: <Your documents folder>/Klei
  • Mac OSX: <Your home folder>/Documents/Klei
  • Linux: ~/.klei

-conf_dir

  • Change the name of your configuration directory. This name should not contain any slashes. The full path to your files will be <persistent_storage_root>/<conf_dir> where <persistent_storage_root> is the value set by the -persistent_storage_root option. The default is: "DoNotStarveTogether".

-cluster

  • Set the name of the cluster directory that this server will use. The server will expect to find the cluster.ini file in the following location: <persistent_storage_root>/<conf_dir>/<cluster>/cluster.ini, where <persistent_storage_root> and <conf_dir> are the values set by the -persistent_storage_root and -conf_dir options. The default is "Cluster_1".

-shard

  • Set the name of the shard directory that this server will use. The server will expect to find the server.ini file in the following location:<persistent_storage_root>/<conf_dir>/<cluster>/<shard>/server.ini, where <persistent_storage_root>, <conf_dir>, and <cluster> are the values set by the -persistent_storage_root, -conf_dir, and -cluster options. The default is "Master".

-offline

  • Start the server in offline mode. In offline mode, the server will not be listed publicly, only players on the local network will be able to join, and any steam-related functionality will not work.

-console

  • Allow lua commands to be entered in the command prompt or terminal that the server is running in.

-bind_ip <bind_ip>

  • Change the address that the server binds to when listening for player connections. This is an advanced feature that most people will not need to use.

-port <port_number>

  • Valid values: 1..65535
  • The UDP port that this server will listen for connections on. This option overrides the [NETWORK] / server_port setting in server.ini. If you are running a multi-level cluster, this port must be different for each server. This port must be between 10998 and 11018 inclusive in order for players on the same LAN to see it in their server listing. Ports below 1024 are restricted to privileged users on some operating systems.

-players <max_players>

  • Valid values: 1..64
  • Set the maximum number of players that will be allowed to join the game. This option overrides the [GAMEPLAY] / max_players setting in cluster.ini.

-steam_master_server_port <port_number>

  • Valid values: 1..65535
  • Internal port used by steam. This option overrides the [STEAM] / master_server_port setting in server.ini. Make sure that this is different for each server you run on the same machine.

-steam_authentication_port <port_number>

  • Valid values: 1..65535
  • Internal port used by steam. This option overrides the [STEAM] / authentication_port setting in server.ini. Make sure that this is different for each server you run on the same machine.

-backup_logs

  • Create a backup of the previous log files each time the server is run. The backups will be stored in a directory called "backup" in the same directory as server.ini.

-tick <tick_rate>

  • Valid values: 15 .. 60
  • This is the number of times per-second that the server sends updates to clients. Increasing this may improve precision, but will result in more network traffic. This option overrides the [NETWORK] / tick_rate setting in cluster.ini. It is recommended to leave this at the default value of 15. If you do change this option, it is recommended that you do so only for LAN games, and use a number evenly divisible into 60 (15, 20, 30).
Start and stop both server, that's going create settings folder Master (Server Overworld) and Caves (Server Caves)
this is for server Overworld:
  • sh start.sh
when you see in end of log: "Your Server Will Not Start"
press CTRL+C for stop server





this is for server Cave:
  • sh start2.sh
when you see in end of log: "Your Server Will Not Start"
press CTRL+C for stop server



You need to settings both servers with cluster_token.txt, server.ini, worldgenoverride.lua
For find your token you just need to launch your game and go in your account info:
  • Go in Play

  • Go in account info




now you can see your token (Klei Dedicated Server Token)

if you don't see your token, you just need to add in the white box Klei Dedicated Server Token and click on Generate Server Token

note and keep your token for use to the next step

some users of Mac OS X report me doesn't have account info in game

so if you have same problem, you can have token with other way:

Run Don’t Starve Together.

Click Play.

Press tilde (~) (or ù on Azerty keyboards) to open the developer console and type:[/b]

  • TheNet:GenerateClusterToken()

This command will generate the cluster token under the name cluster_token.txt. The cluster token is written to a cluster_token.txt file located in:

  • /Users/dst/Documents/Klei/DoNotStarveTogether/cluster_token.txt

when you have take your token, press CTRL + X and Y for valid



Put your token in cluster_token.txt
the token is mandatory without him your server can not be online, it allows for Klei to have the option to remove the server in case of violation or problem with this server
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/cluster_token.txt
put your token and press CTRL + X and Y for valid



Add worldgenoverride.lua on both servers
worldgenoverride.lua represents the settings to generate the world for don't starve together, so you can adjust the season, monsters, or biomes and more

Server Overworld:
  • nano
    /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/worldgenoverride.lua
copy the code lua in the link below and paste in your worldgenoverride.lua:
worldgenoverride.lua for server Overworld[pastebin.com]

after that press CTRL + X and Y for save and quit





Server Cave:
  • nano
    /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Caves/worldgenoverride.lua
copy the code lua in the link below and paste in your worldgenoverride.lua:
worldgenoverride.lua for server Caves[pastebin.com]

after that press CTRL + X and Y for save and quit



List of option for cluster.ini and server.ini
cluster.ini have settings for both servers (server name, slots, gametype)

here the option list for cluster.ini:

[MISC]

max_snapshots

  • Default: 6
  • Maximum number of snapshots to retain. These snapshots are created every time a save occurs, and are available in the “Rollback” tab on the “Host Game” screen.

[SHARD]

shard_enabled

  • Default: false
  • Enable server sharding. This must be set to true for multi-level servers. For single-level servers, it can be omitted.

bind_ip

  • Overridable in server.ini
  • Default: 127.0.0.1
  • Required: If shard_enabled = true and is_master = true
  • This is the network address the master server will listen on for other shard servers to connect to. Set this to 127.0.0.1 if all of your servers in your cluster are on the same machine, or 0.0.0.0 if the servers in your cluster are on different machines. This only needs to be set for the master server, either in cluster.ini, or the master server's server.ini.

master_ip

  • Overridable in server.ini
  • Default: none
  • Required: If shard_enabled = true and is_master = false
  • This is the I.P. address that a non-master shard will use when trying to connect to the master shard. If all servers in a cluster are on the same machine, set this to 127.0.0.1

master_port

  • Overridable in server.ini
  • Default: 10888
  • This is UDP port that the master server will listen on, and that a non-master shard will use when trying to connect to the master shard. This should be set to the same value for all shards by having a single entry in cluster.ini, or omitted completely to use the default.

cluster_key

  • Overridable in server.ini
  • Default: none
  • Required if shard_enabled = true
  • This is a password used to authenticate a slave server to the master. If you are running servers on different machines that need to connect to each other, this value must be the same on each machine. For servers running on the same machine, you can just set this once in cluster.ini.

[STEAM]

steam_group_only

  • Default: false
  • When set to true, the server will only allow connections from players belonging to the steam group listed in the steam_group_id setting.

steam_group_id


steam_group_admins

  • Default: false
  • When this is set to true, admins of the steam group specified in steam_group_id will also have admin status on the server.

[NETWORK]

offline_server

  • Default: false
  • Create an offline server. The server will not be listed publicly, and only players on the local network will be able to join, and any steam-related functionality will not work.

tick_rate

  • Default: 15
  • This is the number of times per-second that the server sends updates to clients. Increasing this may improve precision, but will result in more network traffic.

whitelist_slots

  • Default: 0
  • The number of reserved slots for whitelisted players. To whitelist a player, add their Klei UserId to the whitelist.txt file (Place this file in the same directory as cluster.ini)

cluster_password

  • Default: none
  • This is the password that players must enter to join your server. Leave this blank or omit it for no password.

cluster_name

  • The name for your server cluster. This is the name that will show up in server browser.

cluster_description

  • Default: empty
  • Cluster description. This will show up in the server details area on the “Browse Games” screen.

lan_only_cluster

  • Default: false
  • When set to true, the server will only accept connections from machines on the same LAN

cluster_intention

  • Default: Varies, depending on game mode.
  • The cluster’s playstyle. This field is the equivalent of the “Server Playstyle” field on the “Host Game” screen. Valid values are cooperative, competitive, social, or madness.

[GAMEPLAY]

max_players

  • Default: 16
  • The maximum number of players that may be connected to the cluster at one time.

pvp

  • Default: false
  • Enable PVP.

game_mode

  • Default: survival
  • The cluster’s game mode. This field is the equivalent of the “Game Mode” field on the “Host Game” screen. Valid values are survival, endless or wilderness

pause_when_empty

  • Default: false
  • Pause the server when there are no players connected.

vote_kick_enabled

  • Default: false
  • Set to true to enable the “Vote to Kick” feature.

server.ini have settings for each server (server ports,steam port,activated master or slave):

here the option list for server.ini:

[SHARD]

is_master

  • Default: none
  • Required: If shard_enabled = true
  • Sets a shard to be the master shard for a cluster. There must be exactly one master server per cluster. Set this to true in your master server’s server.ini, and false in every other server.ini.

name

  • Default: none
  • Required: if shard_enabled = true and is_master = false
  • This is the name of the shard that will show up in log files. It is ignored for the master server, which always has the name [SHDMASTER].

id

  • Default: Randomly generated number.
  • This is field is automatically generated for non-master servers, and is used internally to uniquely identify a server. Altering this or removing it may cause problems on your server if anybody’s character currently resides in the world that this server manages.

[STEAM]

authentication_port

  • Default: 8766
  • Internal port used by steam. Make sure that this is different for each server you run on the same machine.

master_server_port

  • Default: 27016
  • Internal port used by steam. Make sure that this is different for each server you run on the same machine.

[NETWORK]

server_port

  • Default: 10999
  • The UDP port that this server will listen for connections on. If you are running a multi-level cluster, this port must be different for each server. This port must be between 10998 and 11018 inclusive in order for players on the same LAN to see it in their server listing. Ports below 1024 are restricted to privileged users on some operating systems.
Create and configure cluster.ini and server.ini
I'll just going give sample configuration about settings for both servers

cluster.ini:
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/cluster.ini
and add this:

[GAMEPLAY]
game_mode = survival
max_players = 10
pvp = false
pause_when_empty = true

[NETWORK]
cluster_name = TEST Server
cluster_description = Welcome
cluster_password =
cluster_intention = social
autosaver_enabled = true
enable_vote_kick = false

[MISC]
console_enabled = true

[SHARD]
shard_enabled = true
bind_ip = 127.0.0.1
master_ip = 127.0.0.1
master_port = 11001
cluster_key = dst

and press CTRL + X and Y for save and quit





server.ini for server Overworld:
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server.ini
and add this:

[NETWORK]
server_port = 10999


[SHARD]
is_master = true


[STEAM]
master_server_port = 12346
authentication_port = 12345

and press CTRL + X and Y for save and quit





server.ini for server Caves:
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Caves/server.ini
and add this:

[NETWORK]
server_port = 11000


[SHARD]
is_master = false
name = Caves


[STEAM]
master_server_port = 12348
authentication_port = 12347

and press CTRL + X and Y for save and quit



Script for restart server Overworld and Cave
we need copy the file dontstarve_dedicated_server_nullrenderer:




now we going use screen, it's terminal multiplexer

he is ability to attach and detach a session

make new script restart.sh for server Overworld:
and add this:

#!/bin/sh
# launch of server Overworld

#Path Directory
name_folder="/Users/dst/server_dst/dontstarve_dedicated_server_nullrenderer.app/Contents/MacOS"

#Command line
start_overworld="sh start.sh"

#Start or Restart the server
killall dontstarve_dedicated_server_nullrenderer
cd ${name_folder}
screen -dmS dst_server1 ${start_overworld}

and press CTRL + X and Y for save and quit





Server Cave:
and add this:

#!/bin/sh
# launch of server Cave

#Path Directory
name_folder="/Users/dst/server_dst/dontstarve_dedicated_server_nullrenderer.app/Contents/MacOS"

#Command line
start_cave="sh start2.sh"

#Start or Restart the server
killall dontstarve_dedicated_server_nullrenderer2
cd ${name_folder}
screen -dmS dst_server2 ${start_cave}

and press CTRL + X and Y for save and quit



Testing both servers
so when you launch both scripts for first time, it's start both servers

if you make again sh restart.sh or sh restart2.sh, it's going restart the server



you can see in your log, if it's server start correctly:
  • tail -f /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server_log.txt
(for stop this command press CTRL + C)
  • tail -f /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Caves/server_log.txt
(for stop this command press CTRL + C)



if you have this error '[200] Account Failed (6): "E_EXPIRED_TOKEN"'

it's look like problem with token:

Do not simply copy and paste the contents of this file from one machine to another. Move the actual file from one machine to another.

The cluster_token.txt is a null byte terminated ASCII file (no line endings). If the GSA attempts to copy-paste the contents of the token file, the null byte will be omitted and a line ending will be appended to the end. The dedicated server software will not be able to properly parse the cluster_token.txt file in this case.
Check if servers running correctly, and make a schedule task
we need check if server Overworld and server Cave works correctly

launch your game and check if your server is online









now we will schedule a task for update the server every day at 6:00 am

so you need make simple script for update the server:
and add this:

and press CTRL + X and Y for save and quit





so we can test update.sh for see if it's works correctly:

We going used crontab, this service allows to create scheduled tasks on Mac OS X
  • env EDITOR=nano crontab -e


now you need to add this in crontab:
and press CTRL + X and Y for save and quit



your server will be restarted and updated daily at 6:00 am
If you want stop both servers you can use htop on Mac OS X
you need to install homebrew for install htop

http://brew.sh/

you need to login with your account of admin

go on the process dontstarve_dedicated_server_nullrenderer or on dontstarve_dedicated_server_nullrenderer2 with the directional arrows (check screenshot)

press F9 and enter for kill (that's going stop the server)

you can also stop servers with this command:
  • killall dontstarve_dedicated_server_nullrenderer
  • killall dontstarve_dedicated_server_nullrenderer2

here are just some useful information:
dontstarve_dedicated_server_nullrenderer is server Overworld
dontstarve_dedicated_server_nullrenderer2 is server Cave

if you want start server:

Server Overworld:

Server Cave:







you can also stop servers with this command:

FAQ - How to reset the map on dedicated server?
when you are in your server DST:

- Press TAB
- Click on Server Actions
- Click on Regenerate World







FAQ - How to make rollback on dedicated server?
when you are in your server DST:

- Press TAB
- Click on Server Actions
- Click on Rollback







FAQ - How banned player if he is not on my dedicated server?
if some players report troll have destroy camp on your server but he is not on the server right now!

you can banned him with SteamID

so you just need name of player and find him in your server_log.txt:

  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server_log.txt



now you need copy this SteamID in blocklist.txt

create blocklist.txt here:

  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/blocklist.txt

just put the SteamID in blocklist.txt:



now restart your dedicated server:



check if your blocklist.txt is loaded correctly:

  • OnLoadPermissionList: /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/blocklist.txt (Success)

so now if player try to join the server, he can't because he is banned!

i have make this test with my SteamID and you can see im banned on my server:



so that's can works for all players
FAQ - How add admin on your dedicated server?
so for add new admin on your server

you need to create adminlist.txt here:
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server_log.txt
you need to find KU_****** of player in log of your server:
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server_log.txt
( KU_***** matches its identifier on server don't starve together as SteamID on steam )



now you need to add KU_***** in your adminlist.txt:



restart your server:



check now if your adminlist.txt is loading correctly on your server:
  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server_log.txt

you need to find this in your server_log.txt:

  • OnLoadPermissionList: /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/adminlist.txt (Success)

so now you can test with your friend if he have admin permission

you can see if your friend is admin on your server like the following screenshots:



FAQ - How to reserved slots on your dedicated server?
this allows to reserve a number of slots for your friends or an admin of server,

this based on number slots of your server example if you reserved 5 slots and you have 15 slots on your server only 10 players from public can connect on the server

so for my example i going put 2 slots on my server and going put 2 KU_***** in my whitelist.txt

you need to create whitelist.txt here:

  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/whitelist.txt

as adminlist.txt you need to find KU_***** in log.txt of your server:



now you need to add KU_***** in your whitelist.txt:



(i have add also another KU_***** of other friend for make this test)

so you need also to add this option in your cluster.ini:

below of [NETWORK] add this:

  • whitelist_slots = 2



now restart your server:




check now if your whitelist.txt is loading correctly on your server:

  • nano /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/Master/server_log.txt

you need to find this in your log.txt:

  • OnLoadUserIdList: /Users/dst/Documents/Klei/DoNotStarveTogether/MyDediServer/whitelist.txt (Success)

so now you can test with your friend if reserved slots works

my friend connect on the server before me on the server and then when I try to connect:



that's mean your reserved slots work fine now

this was just an example, but you can change the number of slots as you want
25 Comments
< >
Spoderman 9 Jan, 2023 @ 11:27am 
Perfect - works flawlessly! Thank you :-)
licet_insanire 25 Feb, 2021 @ 12:07pm 
when I do in the terminal "app_update 343050 validate"
it gives me "ERROR! Failed to install app '343050' (Disk write failure)". how can I fix this?
Taka 26 May, 2020 @ 1:19am 
thank you so much for this been using it since April 2020. I know I'm late but, really, thanks!
Indoorsman 1 May, 2020 @ 8:40pm 
Insanely useful guide, thank you for taking the time.
Twisted_Code 28 Jun, 2019 @ 11:06am 
thank you so much for documenting the difference between conf_dir and persistent_storage_root. I've spent the last 3.5 days troubleshooting a problem that was caused by improper usage of conf_dir; there was nothing on the wiki to indicate that it didn't support slashes, and I mistakenly assumed it was the same command line argument I used it to change the storage directory for my client (when in fact I used persistent_storage_root). when I realized there were two different arguments, my head and keyboard had an impromptu meeting...
GrumpyCheeto 28 Dec, 2018 @ 8:04pm 
I'm getting an error when I try to start sh start2.sh.

It says "start2.sh: line 1: ./dontstarve_dedicated_server_nullrenderer2: No such file or directory"

How can I fix this?
ergopony 21 Nov, 2017 @ 5:48pm 
First of all, thanks for this guide and taking the time to troubleshoot with people

Unfortunately, I've hit a snag with it, would you be able to help me figure it out?


When I try to run start2.sh to make the Caves files I get this error message:

start2.sh: line 1: ./dontstarve_dedicated_server_nullrenderer2: No such file or directory



Whereas running start.sh is no problem.
Frere 24 Aug, 2017 @ 3:55pm 
你需要注销账户并在新建的dst苹果账户中下载SteamCMD 因为你原先的管理员账号是没有权利直接修改dst的账户内容的 所以会显示Disk write failure
权小星 2 Jul, 2017 @ 10:55am 
Hi,thanks a lot for your tutorial !
I followed you step by step,but got an error now,
"
Steam>app_update 343050 validate
ERROR! Failed to install app '343050' (Disk write failure)
"
Do you know how to fix it?
ToNiO  [author] 11 Sep, 2016 @ 12:46pm 
Hi a.iquen20

i have make this guide on OSX Yosemite yes but i think that can work on El Capitan or on Sierra

i use Vmware because i have not Mac, so that's not have different don't worry

Vmware is just virtualization software for OS

if you have other questions, or if you are stuck don't hesitate to tell me :)