# dst-dedicated-server

**Repository Path**: foraurora/dst-dedicated-server

## Basic Information

- **Project Name**: dst-dedicated-server
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-27
- **Last Updated**: 2021-01-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 饥荒-联机版 - 专用服务器

[![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)

饥荒-联机版 专用服务器 Docker 版搭建指南 (Linux、Mac、Windows) 

此项目的目的是使用**最少**的配置快速搭建出一个饥荒联机版的专用服务器。

## 其他语言的安装指南

- [README in English](README.md)

# 安装

任何支持 [Docker](https://docs.docker.com/engine/installation/#supported-platforms) 的系统都可以运行这个专用服务器。

> :bulb: Linux 是最推荐使用 Docker 的高性能操作系统。

该项目主要使用 **Debian 9** 来进行部署测试，侧重 Linux。但是其他操作系统应该也没问题。

## 安装速览

### 必须条件

这些是满足服务器运行的最低条件

- 本地/服务器 软件
  - [安装 Git](#安装-Git)
  - [安装 Docker](#安装-Docker)
- 设置服务器
  - [服务器端文件](#准备服务器端文件) (克隆这个项目)
  - [生成 `cluster_token.txt` 令牌文件](#生成令牌文件)
- [管理服务器](docs/ManagingTheServer.md) (如何启动、保存、停止服务器)
- [基础服务器设定](#服务器设定) (服务器名、密码、其他配置)

### 可选设定

根据自己的喜好来配置自己的服务器

- 自定义自己的服务器
  - [调整服务器配置](#服务器设定) (游戏MOD、玩家人数、Steam组、简介、其他配置)
  - [世界设定](#世界设定) (世界大小、四季、难度、其他配置)
  - [安装 Mods](DSTClusterConfig/mods)
  - [设置管理员、Ban人、白名单用户](docs/AdminBanWhitelist.md)
- 如何[优化你的 DST 服务器性能 Tips](docs/ServerPerformance.md)

* * *

# 准备一台主机

请阅读 [DST服务器性能Tips](docs/ServerPerformance.md) 来充分利用您的服务器资源。如果你不了解这些，可以看其中的 [如何选择服务器](docs/ServerPerformance.md#picking-a-host) 一节来帮你选择一台配置合适的主机。

## 安装 Git

    sudo apt-get install git

## 安装 Docker

### Linux

按照Docker官网的 [Get Docker CE for Debian](https://docs.docker.com/install/linux/docker-ce/debian) 文档进行安装，第一次看可能觉得复杂，但是文档描述的很详细和透彻。

> 译者注：如果你的英文不太好或者对 Linux 配置不太熟悉，也可以看[这里](https://yeasy.gitbooks.io/docker_practice/install/)的教程来安装 Docker。

> :cop: 确定您的用户拥有 sudo 权限。如果以 root 用户执行可能会在之后遇到权限问题。[_sudoer user_](https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart)

- [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)
- **重点:** 阅读 :point_right: [post-installation steps for Linux](https://docs.docker.com/engine/installation/linux/linux-postinstall/) :point_left: 来确保你使用的用户具有免sudo使用docker的权限。
  - 设置你的用户可以免 `sudo` 使用 `docker`
  - 配置你的 `Docker` 为开机启动

### Mac OS / Windows

您只需要下载适合您系统的 [Docker desktop standalone](https://docs.docker.com/engine/installation/#desktop) 安装文件就可以了，几乎无需配置。

# 准备服务器端文件

克隆(clone)这个仓库下来到你的用户目录：

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

> :cop: **不要**使用 `sudo git clone` 来操作，不然可能会遇到权限问题。 :angel:

在 [Managing the Server](docs/ManagingTheServer.md) 查看更多相关信息。

## 生成令牌文件

:warning: 饥荒服务器的令牌文件存储在 `DSTClusterConfig/cluster_token.txt` 文件中，如果没有这个文件，**饥荒服务器无法启动**。

查看 [如何生成Token令牌](docs/ClusterToken.md) 这个文档，并生成自己的 Token 令牌，替换这个 `DSTClusterConfig/cluster_token.txt` 文件，文件中不能存在空格或者其他字符。

你可以使用如下命令快速替换你的 token 令牌

    echo 'token字符串' > ~/dst-dedicated-server/DSTClusterConfig/cluster_token.txt

:closed_lock_with_key: 生成令牌的账户会获得管理员权限，管理员可以在游戏里重置世界、使用命令等。

:rainbow: OK! 到这里你就可以启动你的服务器进行游玩啦！

# 管理服务器

你现在应该已有所需的一切！请参阅有关 [管理服务器](docs/ManagingTheServer.md) 的完整文档，以了解如何**启动**，**保存**游戏和**停止**服务器。

继续阅读 [自定义服务器](#自定义服务器和世界设定) 和 [管理MOD](#Mods) 并根据自己的喜好配置。

* * *

# 自定义服务器和世界设定

如下目录结构和文件列表是配置您喜欢的服务器设定和世界设定的配置文件

> :rotating_light: 除非您知道您在做什么，否则请勿修改除了下列文件之外的文件.

```
DSTClusterConfig/
  Caves/
    leveldataoverride.lua
  Master/
    leveldataoverride.lua
  mods/
    dedicated_server_mods_setup.lua
    modoverrides.lua
  adminlist.txt
  blocklist.txt
  cluster.ini
  whitelist.txt
```

## 服务器设定

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

此文件包含服务器配置，比如 `max_players`(最大玩家数)、`pause_when_empty`(无玩家时暂停服务器)、`cluster_intention`(游戏模式,合作，竞争，生存等)，以及 [更多配置 :link:](https://forums.kleientertainment.com/topic/64552-dedicated-server-settings-guide/) 。

> :bulb: 当你**第一次设置** 时，请至少修改 [`cluster_name`](./DSTClusterConfig/cluster.ini#L27) 和 [`cluster_password`](./DSTClusterConfig/cluster.ini#L29) 两个参数，来确保能第一时间从游戏列表中找到。
>
> :cop: 请小心修改。有些部分的 `[ CHANGE THIS ]` 表示需要你修改此处的值；还有一些属性除非你知道你在做什么，否则请不要修改，不然可能会破坏 `Master`(地上) 和 `Caves`(洞穴) 之间的通讯。

默认情况下，游戏会在游戏中的清晨自动保存一次(`autosaver_enabled = true`)。

## 世界设定

需要为 `Master`(地上)/`Caves`(洞穴) 配置对应的世界配置文件:

- [DSTClusterConfig/Master/leveldataoverride.lua](./DSTClusterConfig/Master/leveldataoverride.lua)
- [DSTClusterConfig/Caves/leveldataoverride.lua](./DSTClusterConfig/Caves/leveldataoverride.lua)

你可以根据自己的喜好自定义配置，并请为洞穴指定如下两个配置:

```
    id="DST_CAVE"
    location="Cave"
```

## Mods

查看 [详细说明](./DSTClusterConfig/mods) 来配置 MOD (安装、配置、启用等) :alien:

## 管理员、BAN人、白名单

如果你明确你的目的，这些文件 `(admin|block|white)list.txt` 可以在 [`DSTClusterConfig/`](./DSTClusterConfig) 中找到。

您可以在 [设置管理员及黑白名单](docs/AdminBanWhitelist.md) 文档中找到详细信息和完整指南。

* * *

# 贡献

我们随时欢迎您的贡献和反馈！随意打开一个 [issue](/../../issues) 或 [pull request](/../../pulls) 来提交改进。

# 参考文献

- [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/)

### 其他链接

- [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)