Skip to content

LetsStarveTogether/dst-server

BranchesTags

Repository files navigation

Don't Starve Together Dedicated Server Container Image

Steam Discord

English | 简体中文

Steam store header

Image quay.io/wh2099/dst-server

Key Features

  • Don't Starve Together
  • Dedicated Server
  • Container Image
  • Steam platform
  • 64-bit Linux system
  • Minimal and clean by the KISS principle

First Install

  1. Make sure your server has a container runtime installed, such as Podman.

  2. Create a path for saved server data.

    mkdir -p "${HOME}/cluster"
    • You can choose another path. If you do, update the container command below accordingly.

  3. Upload the cluster configuration folder.

    Follow Klei's Configure and download the server settings guide. Extract the downloaded archive and upload the whole configuration folder into the storage path created above.

    • The cluster folder name is not important, but the storage path should contain exactly one cluster folder. Common names are Cluster_1 and MyDediServer.
    • To customize the world, copy the corresponding files from a local client save into the dedicated server configuration folder. See Configuration Files.
    • cluster_token.txt is dedicated-server specific and must be generated from Klei's server management page.

  4. Pull the image and start the container.

    sudo podman run --name dst -d --network host -v "${HOME}/cluster:/cluster" quay.io/wh2099/dst-server:latest

Maintenance

Basic Commands

These are regular container control commands.

  • Stop and save automatically: podman stop dst
  • Start after the first run: podman start dst
  • Restart: podman restart dst
  • View logs: podman logs dst

Game Console Commands

You can send console commands to the server through the console named pipe in the cluster or shard folder. For example:

echo 'c_announce("Server maintenance is coming. Please prepare in advance.")' > "Cluster_1/console"

Common console commands:

  • Reload the world: c_reset()
  • Regenerate the world: c_regenerateworld()
  • Save manually: c_save()
  • Shut down without saving: c_shutdown(false)
  • Send an announcement: c_announce("Announcement text")
  • List players: c_listallplayers()
  • Unlock crafting: c_freecrafting()
  • ...

Cluster Architecture

A Don't Starve Together dedicated server commonly runs as a shard cluster. Each world is an independent shard process, and exactly one shard acts as the master. The master shard and all secondary shards form one cluster. The common Forest + Caves setup is a two-shard cluster: Forest and Caves run as separate processes, with Forest as the master.

A multi-layer world usually means a cluster with more than two shards.

When the container starts, this project automatically detects the configuration directory structure mounted at /cluster. You do not need to manually specify the cluster or shard names. Just make sure the configuration directory follows these rules:

  • The configuration directory contains exactly one cluster configuration folder. The folder name is unrestricted, commonly Cluster_1.
  • The cluster configuration folder must contain cluster.ini.
  • The cluster configuration folder must contain cluster_token.txt.
  • The cluster configuration folder may contain only these folder types:
    • mods, the mod folder. It is optional and generated automatically after startup.
    • Shard configuration folders. Names are unrestricted, commonly Master and Caves.
  • Each shard configuration folder must contain server.ini.

This project starts every shard folder it finds, so multi-layer worlds do not need multiple container starts. Put all shard configuration folders under the same cluster folder.

TODO

  • Python entrypoint
    • Manage the dedicated server as child processes
    • IPC
      • Standard input and output
      • -cloudserver
    • Event messages
      • Day changes
      • Player joins
      • Player leaves
      • Player deaths
      • Player chat

Configuration Files

This section describes the dedicated server configuration file structure and variables. Commented values are defaults.

Skip this section if you do not need the details.

Cluster_1  # Cluster mode. Forest and Caves are separate server processes.
├── cluster.ini  # Cluster configuration
├── cluster_token.txt  # Cluster authentication token
├── adminlist.txt  # Admin list, one Klei ID (KU_XXXXXXXX) per line
├── blocklist.txt  # Ban list, one SteamID64 per line
├── whitelist.txt  # Privileged player list, one Klei ID (KU_XXXXXXXX) per line
├── Master  # Master server process, usually Forest
│   ├── server.ini  # Server configuration
│   ├── modoverrides.lua  # Mod settings
│   ├── leveldataoverride.lua  # World generation settings
│   └── save  # Save data
│       └── ...
├── Caves  # Caves server process
│   ├── server.ini  # Server configuration
│   ├── modoverrides.lua  # Mod settings
│   ├── leveldataoverride.lua  # World generation settings
│   └── save  # Save data
│       └── ...

mods  # Mod-related files under the game server install directory
└── dedicated_server_mods_setup.lua  # Mod loading setup

cluster.ini

[MISC]
; Maximum snapshots to keep.
; These snapshots are created on each save and are available from the Rollback tab on the Host Game screen.
; max_snapshots = 6

; Allow Lua commands from the command prompt or terminal where the server is running.
; console_enabled = true


[SHARD]
; Enable server sharding.
; For multi-level servers this must be set to true.
; For single-level servers it can be omitted.
; shard_enabled = false

; Network address listened on by the master server for secondary shard connections.
; If all servers in the cluster run on the same machine, use 127.0.0.1.
; If servers run on different machines, use 0.0.0.0.
; This only needs to be set for the master server and can be set in cluster.ini or the master's server.ini.
; Can be overridden in server.ini.
; bind_ip = 127.0.0.1

; IP address used by secondary shards when connecting to the master shard.
; If all servers in the cluster run on the same machine, use 127.0.0.1.
; Can be overridden in server.ini.
; master_ip =


; UDP port listened on by the master server and used by secondary shards when connecting to it.
; Set the same value for all shards in cluster.ini, or omit it entirely to use the default.
; This must differ from server_port for any shard running on the same machine as the master shard.
; Can be overridden in server.ini.
; master_port = 10888

; Password used to authenticate secondary servers with the master server.
; If servers that need to connect to each other run on different machines, this value must be the same on every machine.
; For servers on the same machine, setting it only in cluster.ini is enough.
; Can be overridden in server.ini.
; cluster_key =


[STEAM]
; When true, only players belonging to the Steam group specified by steam_group_id can connect.
; steam_group_only = false

; Steam group ID used by steam_group_only and steam_group_admins.
; steam_group_id = 0

; When true, administrators of the Steam group specified by steam_group_id also become server admins.
; steam_group_admins = false


[NETWORK]
; Create an offline cluster.
; The server will not be publicly listed. Only local network players can join, and Steam-related features are disabled.
; offline_cluster = false

; Number of server updates sent to clients per second.
; Increasing this improves precision but uses more bandwidth.
; The recommended default is 15.
; Change this only for LAN games, and use a number that divides 60, such as 15, 20, or 30.
; tick_rate = 15

; Number of slots reserved for whitelisted players.
; Add a Klei UserId to whitelist.txt to whitelist a player.
; This is only valid in the master shard's cluster.ini.
; whitelist_slots = 0

; Password players must enter to join the cluster.
; Empty or omitted means no password.
; This is only valid in the master shard's cluster.ini.
; cluster_password =

; Cluster name shown in the server list.
; This is only valid in the master shard's cluster.ini.
; cluster_name =

; Cluster description shown in the server information area of the Browse Games screen.
; This is only valid in the master shard's cluster.ini.
; cluster_description =

; When true, the server accepts connections only from the same LAN.
; This is only valid in the master shard's cluster.ini.
; lan_only_cluster = false

; When false, the game no longer autosaves at the end of each day.
; The game still saves on shutdown and can be manually saved with c_save().
; autosaver_enabled = true

; Cluster language.
; Chinese: zh
; cluster_language = en

[GAMEPLAY]
; Maximum number of players connected to the cluster at the same time.
; This is only valid in the master shard's cluster.ini.
; max_players = 16

; Player-versus-player combat, also known as friendly fire.
; pvp = false

; Cluster game mode.
; This field corresponds to the Game Mode field in the Create Game screen.
; Common valid values are listed below, without the comments in parentheses:
; survival  (Survival)
; endless  (Endless)
; wilderness  (Wilderness)
; For Forge, Gorge, or similar mods, this may need a mod-specific value. Check the corresponding mod documentation.
; game_mode = survival

; Pause the server when no players are connected.
; pause_when_empty = false

; Enable voting.
; vote_enabled = true

server.ini

[SHARD]
; Set a shard as the cluster's master shard.
; Every cluster must have exactly one master server.
; Set this to true in the master's server.ini.
; Set this to false in every other server.ini.
; is_master =

; Shard name shown in log files.
; Ignored for the master server. The master server name is always [SHDMASTER].
; name =

; This field is generated automatically for non-master servers and is used internally to uniquely identify a server.
; Changing or deleting it while any character is in the world managed by this server can cause problems.
; id =


[STEAM]
; Internal port used by Steam.
; Make sure every server running on the same machine uses a different value.
; authentication_port = 8766

; Internal port used by Steam.
; Make sure every server running on the same machine uses a different value.
; master_server_port = 27016


[NETWORK]
; UDP port listened on by this server.
; If you run a multi-level cluster, use a different value for each server on the same machine.
; This port must be between 10998 and 11018 inclusive for LAN players to see it in their server list.
; On some operating systems, ports below 1024 require privileged users.
; server_port = 10999


[ACCOUNT]
; Whether to encode user save paths.
; If true, Klei IDs are used directly as paths, requiring a case-sensitive filesystem.
; If false, player data uses encoded folder names and does not depend on filesystem case sensitivity.
; encode_user_path = false

dedicated_server_mods_setup.lua

-- Two leading hyphens mark a comment and are not executed.
-- There are two functions for installing mods: ServerModSetup and ServerModCollectionSetup.
-- This script runs on startup and downloads the specified mods into the mods directory.
-- ServerModSetup takes the Steam Workshop item ID as a string.
    -- For a mod or collection page, the number at the end of the URL is the ID.
    -- Example mod: https://steamcommunity.com/sharedfiles/filedetails/?id=351325790
 -- ServerModSetup("351325790")
    -- Example collection: https://steamcommunity.com/sharedfiles/filedetails/?id=2594933855
 -- ServerModCollectionSetup("2594933855")

References

  1. SteamCMD
  2. Dedicated Server Quick Setup Guide - Linux

About

Don't Starve Together Dedicated Server Image

Topics

dockerfile docker-image dedicated game-server dst dontstarvetogether

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

10 stars

Watchers

1 watching

Forks

0 forks
Report repository

Contributors

Languages