hexlo/terraria-tmodloader-server

tModLoader 1.4.4 Server Docker镜像

镜像概述和主要用途

本镜像提供了基于tModLoader的Terraria 1.4.4模组服务器的Docker化部署方案，支持自动创建世界、管理模组、配置服务器参数，可快速搭建多人Terraria模组游戏环境。

Docker Hub镜像地址：
hexlo/terraria-tmodloader-server:latest

同时提供：https://github.com/hexlo/terraria-server-docker ===> Dockerhub镜像：hexlo/terraria-server-docker:latest

需求

服务器端

• Docker
• docker compose

客户端

• Terraria 1.4.4或更高版本
• tModLoader 1.4.4或更高版本

通用配置

1. 克隆本仓库
2. 创建docker-compose.yml文件（见下方示例）。也可将docker-compose-example.yml重命名为docker-compose.yml并修改
3. 根据需要编辑环境变量（详见下方环境变量说明）
4. 在tModLoader/Mods目录中，编辑install.txt和enabled.json以包含所需模组（见下方模组配置示例）
5. 本镜像使用环境变量设置服务器配置文件，也可通过serverconfig.txt文件覆盖此行为，需在Dockerfile中设置（取消注释）USE_CONFIG_FILE=1

生成世界

生成世界的最简单方法是使用特定环境变量在容器启动时自动创建世界。以下是自动创建世界所需的变量：

• AUTOCREATE=1
• WORLDNAME=YourWorld.wld
• DIFFICULTY=1

所有变量详见下方环境变量部分。

docker-compose.yml示例

yaml
services:
  tml:
    container_name: tml
    #restart: unless-stopped
    build:
      context: .
      args:
        UID: 1000
        GID: 1000
        #TML_VERSION: v2023.8.3.3
    #entrypoint: [ "/bin/bash" ] # 如需进入容器内部调试，取消此行注释
    tty: true
    stdin_open: true
    ports:
      - 7785:7777
    volumes:
      - ./tModLoader:/home/tml/.local/share/Terraria/tModLoader
    environment:
      - AUTOCREATE=1
      - WORLDNAME=tmlCalamity1.wld
      - DIFFICULTY=1
      # - WORLD=/home/tml/.local/share/Terraria/tModLoader/Worlds/tmlCalamity1.wld
      - PASSWORD=passworld
      - MOTD="Welcome to my tModLoader Server :)"

• 启动容器（命令行界面）：
  docker-compose up -d

创建和使用世界

使用现有世界

Terraria tModLoader世界由两个文件组成：.wld和.twld。若已有tModLoader兼容世界，只需将这两个文件放入Worlds目录。

创建新世界

有两种创建新世界的方法：

1. 使用docker-compose.yml中的变量（推荐）

在docker-compose.yml的environment:部分设置以下变量：

yaml
...
    environment:
      - AUTOCREATE=1
      - WORLDNAME=tmlCalamity1.wld
      - DIFFICULTY=1
...

变量的描述和可能值见下方环境变量部分

2. 手动创建世界

可通过附加到容器并通过Terraria服务器命令提示符创建或选择世界。确保未使用环境变量，删除或注释docker-compose.yml中的environment:部分。

bash
docker exec -it <容器名称> tmux a

若使用提供的docker-compose.yml，容器名称为tml，可执行：

bash
docker exec -it tml tmux a

• 按Enter键
• 按照提示选择选项

不停止容器而分离：ctrl+b + d

重要注意事项

若希望服务器在后续运行时自动启动，需通过WORLD环境变量提供现有世界的路径，同时可安全移除用于自动创建世界的变量。以下是environment:部分示例：

yaml
    environment:
      - WORLD=/home/tml/.local/share/Terraria/tModLoader/Worlds/tmlCalamity1.wld
      - PASSWORD=passworld
      - MOTD="Welcome to my tModLoader Server :)"

模组

可通过在tModLoader/Mods/install.txt文件中提供Steam Workshop ID安装模组。模组ID可在模组URL中找到，例如https://steamcommunity.com/sharedfiles/filedetails/?id=2824688072%E7%9A%84ID%E6%98%AF**2824688072**%E3%80%82

install.txt示例

2824688072
2824688266
2909886416
2619954303
2669644269
2570931073
2815540735
3044249615
2599842771
2802867430

要在服务器上启用或禁用模组，修改tModLoader/Mods/enabled.json文件中的模组名称列表。部分模组可能存在冲突（尤其是大型内容模组），详情参考模组 wiki。

enabled.json示例

json
[
  "CalamityMod",
  "CalamityModMusic",
  "BossChecklist",
  "RecipeBrowser"
]

注意：模组名称数组需满足以下条件：

• 模组名称与列表中显示的完全一致
• 模组名称用双引号括起
• 用逗号分隔
• 数组最后一项后无逗号

install.txt和enabled.json文件需在构建镜像前修改。

环境变量

注意：变量区分大小写！

重要注意事项

• 若WORLD变量为空或未包含，容器启动后需手动初始化服务器。需附加到容器并选择/创建世界，设置玩家数、端口和密码。创建的新世界将保存在worldpath环境变量定义的路径中：

  1. docker exec -it <容器名称> tmux a
  2. 按Enter键
  3. 按照提示选择选项
  4. 通过ctrl+b + d分离容器

• 若使用特定种子创建世界后服务器仍无法自动初始化，确保注释或删除docker-compose.yml中的seed=<yourseed>变量

服务器控制台命令

服务器运行后可执行以下命令（更多信息见Terraria Server Wiki）。可附加到容器或注入命令：

1. 附加到容器：docker exec -it <容器名称> tmux a
2. 注入命令：从命令行执行docker exec <容器名称> inject "命令"。例如向所有玩家发送消息：

   bash
   docker exec tml inject "say Hello everyone!"
   

help - 显示命令列表。
playing - 显示玩家列表，游戏内可输入/playing查看。
clear - 清除控制台窗口。
exit - 关闭服务器并保存。
exit-nosave - 关闭服务器不保存。
save - 保存游戏世界。
kick <玩家名称> - 将玩家踢出服务器。
ban <玩家名称> - 将玩家封禁。
password - 显示密码。
password <密码> - 修改密码。
version - 打印版本号。
time - 显示游戏时间。
port - 打印监听端口。
maxplayers - 打印最大玩家数。
say <消息> - 向所有玩家发送消息，玩家将在聊天中看到黄色前缀<server>的消息。
motd - 打印MOTD。
motd <消息> - 修改MOTD。
dawn - 将时间设为黎明（4:30 AM）。
noon - 将时间设为中午（12:00 PM）。
dusk - 将时间设为黄昏（7:30 PM）。
midnight - 将时间设为午夜（12:00 AM）。
settle - 平静所有水体。

注意：命令前无需加斜杠/。

封禁和解封

命令ban <玩家名称>将玩家封禁。被封禁玩家登录时会显示："You are banned for [duration]: [reason]- [modname]"。可通过编辑Terraria文件夹中的"banlist.txt"文件解封玩家，删除文件中的玩家名称和IP地址即可。