Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mathielo/dst-dedicated-server

Don't Starve Together dedicated server guide for all platforms (Linux, Mac, Windows) with Docker. Extensive documentation covering mods installation, server config and performance, world generation and setting up admins.
https://github.com/mathielo/dst-dedicated-server

admin caves cluster dedicated-server docker docker-container dont-starve dont-starve-together dst game game-server linux mac master mod mods windows

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/mathielo/dst-dedicated-server
Owner: mathielo
License: mit
Created: 2017-11-05T13:35:47.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2022-11-11T07:50:10.000Z (about 2 years ago)
Last Synced: 2024-09-27T02:05:10.416Z (about 2 months ago)
Topics: admin, caves, cluster, dedicated-server, docker, docker-container, dont-starve, dont-starve-together, dst, game, game-server, linux, mac, master, mod, mods, windows
Language: Lua
Homepage:
Size: 1.3 MB
Stars: 291
Watchers: 11
Forks: 56
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Don't Starve Together - Dedicated Server

[![Automated Docker Builds](https://img.shields.io/docker/automated/mathielo/dst-dedicated-server.svg)](https://cloud.docker.com/repository/docker/mathielo/dst-dedicated-server)

[![Docker Build State](https://img.shields.io/docker/build/mathielo/dst-dedicated-server.svg)](https://cloud.docker.com/repository/docker/mathielo/dst-dedicated-server)

[![Docker Image Pulls](https://img.shields.io/docker/pulls/mathielo/dst-dedicated-server.svg)](https://cloud.docker.com/repository/docker/mathielo/dst-dedicated-server)

[![License: MIT]( https://img.shields.io/github/license/mathielo/dst-dedicated-server.svg)](https://github.com/mathielo/dst-dedicated-server/blob/master/LICENSE.md)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-round)](http://makeapullrequest.com)

DST Dedicated Server Guide for all platforms (Linux, Mac, Windows) with Docker.

The purpose of this project is to have DST servers up and running with the **bare minimum** necessary setup.

## README in other languages

* [README in Chinese](README.zh_CN.md)

## Installation

Any OS that [supports Docker](https://docs.docker.com/engine/installation/#supported-platforms) can run the dedicated server.

>:bulb: Linux is the _recommended_ OS to host the containers for better performance gains

This project was deployed and tested using **Debian 9**. Instructions will be focused on Linux - but it should be easy to adapt to any other OS.

### Installation Overview

#### Essentials

These are the minimum required steps to have a server running:

* Prepare the host

  * [Install Git](#prepare-the-host)

  * [Install Docker](#install-docker)

* Setup the server

  * [Server files](#prepare-the-dedicated-server) (clone this repository)

  * [Generate `cluster_token.txt`](#generate-cluster_tokentxt)

* [Manage the server](docs/ManagingTheServer.md) (how to start, save and stop)

* [Basic settings setup](#the-server) (server name, password, etc.)

#### Optionals

Enhance your server by customizing it to your liking!

* Customize your server

  * [Tweak server settings](#the-server) (game mode, max players, Steam Group, description, etc.)

  * [World Settings](#the-world) (World Size, Seasons, Difficulty, etc)

  * [Install Mods](DSTClusterConfig/mods)

  * [Set Admins, Bans and Whitelisted Players](docs/AdminBanWhitelist.md)

* How to optimize your [DST Server Performance](docs/ServerPerformance.md)

---

# Prepare the Host

Read about [server performance](./docs/ServerPerformance.md) for useful tips to make the best use of your resources! That might also help you to [pick a host](./ServerPerformance.md#picking-a-host) machine if you're unsure about it.

## Install Git

    sudo apt-get install git

## Install Docker

### Linux

Follow the official docs to install Docker on Linux. At first glance it might seem complicated, but the instructions are very detailed and thorough:

> :cop: Make sure you have your own [_sudoer user_](https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart) and perform all the steps logged as it. Running everything as `root` user will probably render you permissions issues down the road.

* [Docker Engine CE](https://docs.docker.com/engine/installation/linux/docker-ce/debian/#set-up-the-repository)

* [Docker Compose](https://docs.docker.com/compose/install/#install-compose)

* **IMPORTANT:** Read through and follow the :point_right: [post-installation steps for Linux](https://docs.docker.com/engine/installation/linux/linux-postinstall/) :point_left:

  * Enable your user to manage `docker` without the need of `sudo`

  * Configure Docker to start on boot

### Mac OS / Windows

You only need the [Docker desktop standalone](https://docs.docker.com/engine/installation/#desktop) as it has everything you need, no extra steps required.

# Prepare the dedicated server

Clone this repository in your home folder:

    cd ~ && git clone https://github.com/mathielo/dst-dedicated-server.git

> :cop: Do **not** `sudo git clone` or your might run into permission issues :angel:

See more info in [Managing the Server](./docs/ManagingTheServer.md).

## Generate `cluster_token.txt`

:warning: The cluster token is stored in the `DSTClusterConfig/cluster_token.txt` file and without it **your server won't run**.

Check the [detailed instructions to generate a cluster token](./docs/ClusterToken.md). After you get it, make sure to **delete everything** from this file and leave only your cluster token there, without any spaces or anything else.

You can easily do that replacing `InsertYourTokenHere` in the following command and executing it in your server:

    echo 'InsertYourTokenHere' > ~/dst-dedicated-server/DSTClusterConfig/cluster_token.txt

:closed_lock_with_key: The account that generates the token automatically gains admin access in-game, meaning you can rollback, regenerate the world or use console commands while playing.

:rainbow: Done! You are ready to start your server and play!

# Manage the Server

You should now have everything you **need** to start playing! See the full docs on how to [manage your server](./docs/ManagingTheServer.md) to learn how to **start**, **save** the game and **stop** the server.

Keep on reading to learn how to :point_down: [customize the server](#customizing-the-server--world) :point_down: and [install mods](#managing-mods) to your liking!

---

# Customize the Server and World

The files listed below are the ones you'll likely be tweaking to customize your server and world to your likes.

> :rotating_light: Changing any files **other than the ones listed below** is only advised if you know what you're doing.

```

DSTClusterConfig/

  Caves/

    leveldataoverride.lua

  Master/

    leveldataoverride.lua

  mods/

    dedicated_server_mods_setup.lua

    modoverrides.lua

  adminlist.txt

  blocklist.txt

  cluster.ini

  whitelist.txt

```

## The Server

* [DSTClusterConfig/cluster.ini](./DSTClusterConfig/cluster.ini)

This file holds server attributes, such as `max_players`, `pause_when_empty`, `cluster_intention` - and [many others :link:](https://forums.kleientertainment.com/topic/64552-dedicated-server-settings-guide/).

> :bulb: On your **first setup** it's important to change at least the [`cluster_name`](./DSTClusterConfig/cluster.ini#L27) and [`cluster_password`](./DSTClusterConfig/cluster.ini#L29) to be able to identify and join your sever from the game's server list.

> :cop: Please handle with care. There are sections where `[ CHANGE THIS ]` denotes places you **should** change. There are also smaller secitions which **should not be touched** as it might compromise the communication between Master <-> Caves shards.

By default the server will autosave once every game day (`autosaver_enabled = true`).

## The World

Determines the settings for world generation for each shard, respectively:

* [DSTClusterConfig/Master/leveldataoverride.lua](./DSTClusterConfig/Master/leveldataoverride.lua)

* [DSTClusterConfig/Caves/leveldataoverride.lua](./DSTClusterConfig/Caves/leveldataoverride.lua)

You may tweak them as much as you like, granted that **the cave one** always have these defined:

    id="DST_CAVE"

    location="Cave"

## Mods

Check the [detailed instructions](./DSTClusterConfig/mods) on how to install, configure and enable mods. :alien:

## Admins, Bans and Whitelists

If you know what you're after, the `(admin|block|white)list.txt` files can be found within the [`DSTClusterConfig/`](./DSTClusterConfig) folder.

You can find detailed information and a complete guide in the [Setting Admins, Bans and Whitelisted Players](./docs/AdminBanWhitelist.md) docs.

---

# Contributing

Contributions and feedback are always welcome! Feel free to open an [issue](/../../issues) or a [pull request](/../../pulls) with improvements!

# References

* [How to setup dedicated server with cave on Linux](http://steamcommunity.com/sharedfiles/filedetails/?id=590565473)

* [Dedicated Server Settings Guide](https://forums.kleientertainment.com/topic/64552-dedicated-server-settings-guide/)

* [Dedicated Server Command Line Options Guide](https://forums.kleientertainment.com/topic/64743-dedicated-server-command-line-options-guide/)

### Other links

* [Thread in Klei forums](https://forums.kleientertainment.com/topic/84574-dedicated-server-setup-guide-on-any-platform-windowsmaclinux-with-docker/)

* [Steam Guide](http://steamcommunity.com/sharedfiles/filedetails/?id=1206742951)