ryshe/terraria

Terraria Docker镜像文档

TShock & Vanilla & Mobile 版本支持

镜像概述和主要用途

本镜像是将https://github.com/Pryaxis/TShock/releases%E5%92%8CTerraria%E7%9A%84%60TerrariaServer.exe%60%E5%AE%B9%E5%99%A8%E5%8C%96%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E4%BD%BF%E5%85%B6%E5%8F%AF%E5%9C%A8Linux%E7%B3%BB%E7%BB%9F%E4%B8%AD%E8%BF%90%E8%A1%8C%E3%80%82%E9%80%9A%E8%BF%87Docker%E5%AE%B9%E5%99%A8%E5%8C%96%E9%83%A8%E7%BD%B2%EF%BC%8C%E7%94%A8%E6%88%B7%E6%97%A0%E9%9C%80%E6%89%8B%E5%8A%A8%E9%85%8D%E7%BD%AELinux%E7%8E%AF%E5%A2%83%E4%BE%9D%E8%B5%96%EF%BC%8C%E5%8D%B3%E5%8F%AF%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BATerraria%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%8C%E7%89%B9%E5%88%AB%E9%80%82%E5%90%88%E5%88%9D%E5%AD%A6%E8%80%85%E3%80%82%E9%95%9C%E5%83%8F%E6%94%AF%E6%8C%81TShock%EF%BC%88%E5%90%AB1.4%E7%89%88%E6%9C%AC%E9%A2%84%E5%8F%91%E5%B8%83%E7%89%88%EF%BC%89%E3%80%81Vanilla%E5%8F%8AMobile%EF%BC%88%E7%A7%BB%E5%8A%A8%E7%89%88%EF%BC%89%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%8C%E6%BB%A1%E8%B6%B3%E4%B8%8D%E5%90%8C%E7%89%88%E6%9C%AC%E9%9C%80%E6%B1%82%E3%80%82

核心功能和特性

• 容器化部署：简化Linux环境下的依赖管理，一键启动服务器
• 多版本支持：包含TShock预发布版（适配Terraria 1.4）、Vanilla版及Mobile专用版（mobile-1.4.0.5标签）
• 数据持久化：通过卷挂载实现世界文件、配置文件及日志的持久化存储
• 插件扩展：支持TShock插件，可通过卷挂载自定义插件目录
• 日志管理：支持日志目录独立挂载，便于外部存储和分析
• 简易更新：通过拉取最新镜像快速更新服务器版本
• 交互式配置：支持首次运行时通过交互式命令生成世界或配置服务器

使用场景和适用范围

• 用户群体：适合希望在Linux系统（物理机、虚拟机或云服务器）上搭建Terraria服务器的用户，尤其适合初学者
• 世界规模：支持小型（1）、中型（2）、大型（3）世界生成
• 并发用户：建议8人以下服务器配置1-1.5GB内存
• 部署环境：兼容所有支持Docker的Linux发行版，云服务器需开放TCP/UDP 7777端口

环境准备

系统要求

• Linux系统（支持Docker），1-1.5GB内存（小型/中型世界，≤8用户）
• 已安装Docker，并确保Docker服务运行（systemctl start docker）

快速启动指南

步骤1：创建持久化目录

创建目录用于存储世界文件、配置及日志（避免容器删除后数据丢失）：

bash
mkdir -p $HOME/terraria/world  # 世界文件和配置  
mkdir -p $HOME/terraria/plugins  # 插件（可选）  
mkdir -p $HOME/terraria/logs  # 日志（可选）  

步骤2：生成新世界

方式1：命令行快速生成

通过命令行指定世界大小（1=小型，2=中型，3=大型）直接生成世界：

bash
docker run -it -p 7777:7777 --rm \
  -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
  ryshe/terraria:latest \
  -world /root/.local/share/Terraria/Worlds/<世界名称>.wld \
  -autocreate <世界大小>

说明：

• <世界名称>：自定义世界文件名（无需.wld后缀，生成后自动添加）
• <世界大小>：1（小型）、2（中型）或3（大型）
• -it：交互式模式，生成过程中需确认设置（如世界名称、难度）
• 生成完成后建议关闭终端，修改config.json配置（如服务器密码）

方式2：交互式生成

通过交互式终端自定义世界参数（如名称、难度、种子）：

bash
docker run -it -p 7777:7777 --rm \
  -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
  ryshe/terraria:latest

步骤3：运行已有世界

生成世界后，通过后台模式启动服务器并加载世界：

bash
docker run -d --rm --name="terraria-server" \
  -p 7777:7777 \
  -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
  -e WORLD_FILENAME=<世界文件名>.wld \  # 环境变量指定世界文件
  ryshe/terraria:latest

参数说明：

• -d：后台运行，关闭终端不影响服务器
• --name：自定义容器名称，便于管理
• -e WORLD_FILENAME：指定世界文件（需在$HOME/terraria/world目录下）

更新容器

1. 拉取最新镜像：

   bash
   docker pull ryshe/terraria:latest
   

2. 停止并删除旧容器（需替换<容器ID/名称>）：

   bash
   docker rm -f <容器ID/名称>  # 如上文的"terraria-server"
   

3. 重新启动容器（参考步骤3：运行已有世界）

从源码构建

如需自定义镜像（如修改TShock版本），可从源码构建：

1. 克隆仓库：

   bash
   git clone https://github.com/ryansheehan/terraria.git && cd terraria
   

2. （可选）修改Dockerfile中的TShock版本（默认使用最新预发布版）：

   dockerfile
   # 替换为目标TShock版本的下载链接
   ADD https://github.com/Pryaxis/TShock/releases/download/v<版本号>/<TShock压缩包> /
   

3. 构建镜像：

   bash
   docker build -t my-terraria:latest .  # "my-terraria"为自定义镜像名称
   

配置说明

环境变量

命令行参数

可在docker run命令的镜像名称后添加TShock服务器参数，完整参数参考TShock文档。常用参数：

卷挂载

通过-v参数挂载目录实现数据持久化，支持以下目录：

高级功能

插件支持

1. 创建插件目录：

   bash
   mkdir -p $HOME/terraria/plugins
   

2. 启动时挂载插件目录：

   bash
   docker run -d --rm --name="terraria-server" \
     -p 7777:7777 \
     -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
     -v $HOME/terraria/plugins:/plugins \  # 挂载插件目录
     -e WORLD_FILENAME=my_world.wld \
     ryshe/terraria:latest
   

日志管理

挂载日志目录到宿主机，避免日志占用容器空间：

bash
docker run -d --rm --name="terraria-server" \
  -p 7777:7777 \
  -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
  -v $HOME/terraria/logs:/tshock/logs \  # 挂载日志目录
  -e WORLD_FILENAME=my_world.wld \
  ryshe/terraria:latest

日志大小限制：添加--log-opt max-size=200k限制单日志文件大小，避免磁盘占满：

bash
docker run -d --rm --name="terraria-server" \
  --log-opt max-size=200k \  # 限制日志文件大小为200KB
  -p 7777:7777 \
  -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
  -e WORLD_FILENAME=my_world.wld \
  ryshe/terraria:latest

注意事项

1. 权限：部分系统可能需要sudo执行docker命令（如sudo docker run ...）。
2. 端口开放：云服务器需在防火墙/安全组中开放TCP和UDP端口7777。
3. 内存要求：小型/中型世界（≤8人）建议1-1.5GB内存，大型世界或更多玩家需增加内存。
4. 移动版支持：使用mobile-1.4.0.5标签启动移动版服务器（需参考官方指南配置）：

   bash
   docker run -it -p 7777:7777 --rm \
     -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds \
     ryshe/terraria:mobile-1.4.0.5
   

5. TShock文档：服务器管理细节（如命令行参数、权限配置）参考TShock官方文档。

贡献与开发

若发现文档或镜像问题，可通过以下方式贡献：

1. Fork https://github.com/ryansheehan/terraria
2. 创建特性分支：git checkout -b my-new-feature
3. 提交修改：git commit -am 'Add some feature'
4. 推送分支：git push origin my-new-feature
5. 提交Pull Request

问题反馈可发送邮件至：***

TODO

• Fork TShock项目并编写Dockerfile直接构建源码
• 完善移动版服务器测试与文档

---