Skip to content

Latest commit

 

History

History
executable file
·
291 lines (225 loc) · 11.2 KB

README-zh.md

File metadata and controls

executable file
·
291 lines (225 loc) · 11.2 KB

Dockerized Don't Starve Together Dedicated Server

English | 中文



简介

饥荒联机版独立服务器程序容器化后的极简镜像。仅仅将程序打包并把dontstarve_dedicated_server_nullrenderer_x64作为容器入口

支持的标签

  • latest、public：正式版
  • 其它：可以在Steam里，右键->属性->测试版->参与测试，找到对应的测试分支

更新频率

每半小时对比当前镜像版本和官方最新版本，如果版本落后则自动更新镜像，故可近似认为本仓库是实时更新

使用方法

前提

  • amd64架构且安装有docker环境的系统
  • 您对docker使用足够熟悉
  • 您对非docker环境下部署饥荒联机版独立服务器足够熟悉

说明

  • 该镜像基于SteamCMD的官方镜像修改而来，在其中安装最新版的饥荒联机版独立服务器程序，并将64位的程序作为容器入口
  • 容器内，游戏目录为/home/steam/dst/game
  • 容器内，存档目录为/home/steam/dst/save
  • 容器内，V1模组目录为/home/steam/dst/game/mods
  • 容器内，V2模组（UGC模组）目录为/home/steam/dst/game/ugc_mods
  • 容器外，存档和模组的持久化存储由您自己定义，您只需要在运行的时候挂载进容器对应的目录

示例

因为本镜像是直接将dontstarve_dedicated_server_nullrenderer_x64作为容器入口，所以命令参数与官方提供的命令行程序参数一致（因为本身就是同一个程序），所有支持的命令可参考官方指南：

Dedicated Server Command Line Options Guide

首次使用前，您应当先在您的宿主机上创建存档和模组的目录，之后运行容器的时候再挂载进去，以持久化存档数据并避免重复下载模组：

# 在您的宿主机上
$ mkdir -p <path>/dst/save
$ mkdir -p <path>/dst/mods
$ mkdir -p <path>/dst/ugc_mods

<path>代表某个合适的目录，这完全取决于您（例如我的是~/.klei）， save用来放置存档，mods和ugc_mods用来放置模组（mods放置V1版本的，ugc_mods放置V2版本的）

随后，您需要在<path>/dst/mods中放入2个空文件：

$ cd <path>/dst/mods
$ touch dedicated_server_mods_setup.lua
$ touch modsettings.lua

之后的启动命令就完全取决于您要如何使用容器了，强烈建议先完整看一遍Dedicated Server Command Line Options Guide ，以下是几个典型的使用场景：

示例一：启动地上世界

首先，您可以预先在宿主机的存档目录里放入合适的配置：

# 在您的宿主机上
<path>/dst/save/<cluster>/cluster.ini
<path>/dst/save/<cluster>/<shard>/server.ini

<cluster>代表一个存档的根目录，取名随意，如Cluster_1；<shard>代表世界实例的目录，对于地上世界，通常会使用Master（但其实取名随意）

至于配置文件如何设定，请参考官方指南：

Dedicated Server Settings Guide

稍后我们会通过docker run的-v参数挂载到容器的对应目录：

# 在容器内部
/home/steam/dst/save/<cluster>/cluster.ini
/home/steam/dst/save/<cluster>/<shard>/server.ini

这样在dontstarve_dedicated_server_nullrenderer_x64启动的时候就会读取这些配置文件

以下是启动地上世界的指令模板，请根据您的实际需求修改：

docker run --rm -itd --name=dst-master \
    # 主世界实例需要使用的端口，一般来说，地上世界是主世界，因此需要该端口，而地下世界不用，:左边的端口号需要在宿主机上未被占用
    -p 10888:10888/udp \
    # 当前世界实例需要使用的端口，:左边的端口号需要在宿主机上未被占用
    -p 10999:10999/udp \
    # Steam需要使用的端口，:左边的端口号需要在宿主机上未被占用
    -p 27016:27016/udp \
    # 挂载存档路径
    -v "<path>/dst/save:/home/steam/dst/save" \
    # 挂载V1模组路径
    -v "<path>/dst/mods:/home/steam/dst/game/mods" \
    # 挂载V2模组路径
    -v "<path>/dst/ugc_mods:/home/steam/dst/game/ugc_mods" \
    superjump22/dontstarvetogether:latest \
    # 以下为传给dontstarve_dedicated_server_nullrenderer_x64的参数
    # 不更新模组，直接启动（我们会用别的方式更新模组，因此请勿修改）
    -skip_update_server_mods \
    # 指定容器内部的V2模组存放路径，方便管理（请勿修改）
    -ugc_directory "/home/steam/dst/game/ugc_mods" \
    # 游戏程序需要指定的持久化根目录（请勿修改）
    -persistent_storage_root "/home/steam/dst" \
    # "<persistent_storage_root>/<conf_dir>"是所有存档的总目录（请勿修改）
    -conf_dir "save" \
    # 当前世界存档的目录名，请与<cluster>保持一致
    -cluster "Cluster_1" \
    # 此处是开启地上世界，通常叫Master（实际上改成什么都行）
    -shard "Master" \
    # 其它你需要的参数，参考官方指南
    ...

示例二：启动地下世界

首先，您可以预先在宿主机的存档目录里放入合适的配置：

# 在您的宿主机上
<path>/dst/save/<cluster>/cluster.ini
<path>/dst/save/<cluster>/<shard>/server.ini

<cluster>代表一个存档的根目录，取名随意，如Cluster_1；<shard>代表世界实例的目录，对于地下世界，通常会使用Caves（但其实取名随意）

至于配置文件如何设定，请参考官方指南：

Dedicated Server Settings Guide

稍后我们会通过docker run的-v参数挂载到容器的对应目录：

# 在容器内部
/home/steam/dst/save/<cluster>/cluster.ini
/home/steam/dst/save/<cluster>/<shard>/server.ini

这样在dontstarve_dedicated_server_nullrenderer_x64启动的时候就会读取这些配置文件

以下是启动地下世界的指令模板，请根据您的实际需求修改：

docker run --rm -itd --name=dst-caves \
 # 当前世界实例需要使用的端口，:左边的端口号需要在宿主机上未被占用
    -p 11000:10999/udp \
    # Steam需要使用的端口，:左边的端口号需要在宿主机上未被占用
    -p 27017:27016/udp \
    # 挂载存档路径
    -v "<path>/dst/save:/home/steam/dst/save" \
    # 挂载V1模组路径
    -v "<path>/dst/mods:/home/steam/dst/game/mods" \
    # 挂载V2模组路径
    -v "<path>/dst/ugc_mods:/home/steam/dst/game/ugc_mods" \
    superjump22/dontstarvetogether:latest \
    # 以下为传给dontstarve_dedicated_server_nullrenderer_x64的参数
    # 不更新模组，直接启动（我们会用别的方式更新模组，因此请勿修改）
    -skip_update_server_mods \
    # 指定容器内部的V2模组存放路径，方便管理（请勿修改）
    -ugc_directory "/home/steam/dst/game/ugc_mods" \
    # 游戏程序需要指定的持久化根目录（请勿修改）
    -persistent_storage_root "/home/steam/dst" \
    # "<persistent_storage_root>/<conf_dir>"是所有存档的总目录（请勿修改）
    -conf_dir "save" \
    # 当前世界存档的目录名，请与<cluster>保持一致
    -cluster "Cluster_1" \
    # 此处是开启地下世界，通常叫Caves（实际上改成什么都行）
    -shard "Caves" \
    # 其它你需要的参数，参考官方指南
    ...

示例三：下载/更新模组

首先，您需要修改宿主机上的dedicated_server_mods_setup.lua，往其中写入需要下载/更新的模组：

# 在您的宿主机上修改<path>/dst/mods/dedicated_server_mods_setup.lua：
ServerModSetup("3055375757")
ServerModSetup("398858801")

（3055375757和398858801是创意工坊的模组id）

以下为下载/更新模组的指令模板：

docker run --rm -itd \
    -v "<path>/dst/mods:/home/steam/dst/game/mods" \ # 挂载V1模组路径
    -v "<path>/dst/ugc_mods:/home/steam/dst/game/ugc_mods" \ # 挂载V2模组路径
    superjump22/dontstarvetogether:latest \
    # 以下为传给dontstarve_dedicated_server_nullrenderer_x64的参数
    # 只更新模组，不启动世界
    -only_update_server_mods \
    # 指定容器内部的V2模组存放路径，方便管理（请勿修改）
    -ugc_directory "/home/steam/dst/game/ugc_mods"

示例四：我常用的三条命令

请注意：我通常把容器运行在host模式下，并且把存档放在三个叫dst_save、dst_mods和dst_ugc_mods的卷里

更新模组：

docker run --rm -itd \
    -v "dst_mods:/home/steam/dst/game/mods" \
    -v "dst_ugc_mods:/home/steam/dst/game/ugc_mods" \
    superjump22/dontstarvetogether:latest \
    -only_update_server_mods \
    -ugc_directory "/home/steam/dst/game/ugc_mods"

启动地上：

docker run --rm -itd --network=host --name=dst-master \
    -v "dst_save:/home/steam/dst/save" \
    -v "dst_mods:/home/steam/dst/game/mods" \
    -v "dst_ugc_mods:/home/steam/dst/game/ugc_mods" \
    superjump22/dontstarvetogether:latest \
    -skip_update_server_mods \
    -ugc_directory "/home/steam/dst/game/ugc_mods" \
    -persistent_storage_root "/home/steam/dst" \
    -conf_dir "save" \
    -cluster "test" \
    -shard "m"

启动地下：

docker run --rm -itd --network=host --name=dst-caves \
    -v "dst_save:/home/steam/dst/save" \
    -v "dst_mods:/home/steam/dst/game/mods" \
    -v "dst_ugc_mods:/home/steam/dst/game/ugc_mods" \
    superjump22/dontstarvetogether:latest \
    -skip_update_server_mods \
    -ugc_directory "/home/steam/dst/game/ugc_mods" \
    -persistent_storage_root "/home/steam/dst" \
    -conf_dir "save" \
    -cluster "test" \
    -shard "c"

示例五：在脚本或程序中使用

前面的示例中，docker run都加上了-t参数，这适合于您用终端手动管理容器的场景

在非Docker环境中，如果需要在脚本或程序中管理dontstarve_dedicated_server_nullrenderer_x64进程，通常的做法是用supervisor或screen等工具包一层， 然后通过类似screen -r "dst" -p 0 -X stuff "c_shutdown()$(printf \\r)"这样的方式来向dontstarve_dedicated_server_nullrenderer_x64进程传递指令

在Docker环境中，您不需要这样做，您只需要在启动容器的时候去掉-t参数：

docker run --rm -id --network=host --name=dst-master \
    -v "dst_save:/home/steam/dst/save" \
    -v "dst_mods:/home/steam/dst/game/mods" \
    -v "dst_ugc_mods:/home/steam/dst/game/ugc_mods" \
    superjump22/dontstarvetogether:latest \
    -skip_update_server_mods \
    -ugc_directory "/home/steam/dst/game/ugc_mods" \
    -persistent_storage_root "/home/steam/dst" \
    -conf_dir "save" \
    -cluster "test" \
    -shard "m"

然后在脚本中：

docker exec -i dst-master bash -c 'echo "c_shutdown()" > /proc/1/fd/0'

这是因为dontstarve_dedicated_server_nullrenderer_x64是容器的主进程，PID为1，其标准输入为/proc/1/fd/0