hashicraft/minecraft

HashiCraft Minecraft Server

https://github.com/HashiCraft/Docker-Minecraft-Server-Fabric

!HashiCraft Logo

镜像概述和主要用途

本Docker镜像包含安装了Fabric模组工具的Minecraft服务器，旨在提供便捷的模组化Minecraft服务器部署和管理方案。由于Docker容器为不可变实例，服务器状态和配置需通过卷映射实现持久化。镜像自动将关键配置文件链接至持久化目录，确保重启后配置不丢失，同时支持通过环境变量自定义服务器参数。

核心功能和特性

• 数据持久化：需映射/minecraft/world（世界存档）和/minecraft/config（配置文件夹）至本地目录，确保服务器状态和配置在容器重启后保留。
• 配置文件管理：自动将banned-ips.json、banned-players.json、usercache.json、whitelist.json、ops.json链接至/minecraft/config，避免配置丢失。
• 环境变量自定义：支持通过环境变量配置世界备份、模组、资源包、内存分配、端口、游戏模式等关键参数。
• 自动备份恢复：可从指定URL自动下载并恢复世界存档和模组（仅当目标目录为空时执行）。

使用场景和适用范围

适用于需要快速部署模组化Minecraft服务器的场景，包括：

• 个人或小型团队搭建私用Minecraft服务器
• 开发和测试模组化服务器配置
• 教学或演示环境中的Minecraft服务器部署
• 需要自定义游戏规则、资源包和访问控制的服务器需求

详细使用方法和配置说明

配置参数（环境变量）

WORLD_BACKUP

启动时从指定URL下载tar.gz格式的世界备份存档，并解压到/minecraft/world（仅当该文件夹为空时执行）。要求存档压缩包根目录直接包含世界数据。

示例：

WORLD_BACKUP=https://github.com/nicholasjackson/hashicraft/releases/download/v0.0.0/world2.tar.gz

默认值：null

MODS_BACKUP

启动时从指定URL下载tar.gz格式的模组压缩包，并解压到/minecraft/mods（仅当该文件夹为空时执行）。要求压缩包根目录直接包含模组文件。

示例：

MODS_BACKUP=https://github.com/nicholasjackson/hashicraft/releases/download/v0.0.0/mods.tar.gz

默认值：null

RESOURCE_PACK

下载zip格式的资源包压缩包，启用资源包的客户端连接服务器时将自动下载并应用该资源包。

示例：

RESOURCE_PACK=https://github.com/HashiCraft/terraform_minecraft_azure_containers/releases/download/files/KawaiiWorld1.12.zip

默认值：null

JAVA_MEMORY

配置Java虚拟机的内存分配量。

示例：

JAVA_MEMORY=4G

默认值：1G

MINECRAFT_PORT

Minecraft服务器监听端口。

示例：

MINECRAFT_PORT=25565

默认值：25565

ALLOW_NETHER

是否启用下界维度。

示例：

ALLOW_NETHER=true

默认值：false

MINECRAFT_MOTD

玩家登录时显示的服务器欢迎消息。

示例：

MINECRAFT_MOTD="欢迎来到Minecraft服务器"

默认值：null

RCON_PORT

RCON远程管理服务器监听端口。

示例：

RCON_PORT=27015

默认值：27015

RCON_ENABLED

是否启用RCON远程管理服务器。

示例：

RCON_ENABLED=true

默认值：false

RCON_PASSWORD

访问RCON远程管理服务器的密码。注意：服务器连接公网时应使用强密码。

示例：

RCON_PASSWORD=3fdf32dss29$#c1

默认值：null

WHITELIST_ENABLED

是否启用玩家白名单。注意：服务器连接公网时建议启用白名单。可通过服务器或RCON终端执行whitelist add <用户名>添加玩家。

示例：

WHITELIST_ENABLED=true

默认值：true

GAME_MODE

新玩家的游戏模式。允许值："survival"（生存）、"creative"（创造）、"adventure"（冒险）。

示例：

GAME_MODE=creative

默认值：creative

ENABLE_QUERY

是否启用GameSpy4协议监听器（用于获取服务器信息）。

示例：

ENABLE_QUERY=false

默认值：false

PLAYER_IDLE_TIMEOUT

玩家闲置超时踢除时间（分钟，0表示禁用）。

示例：

PLAYER_IDLE_TIMEOUT=30

默认值：0

DIFFICULTY

服务器难度。允许值："peaceful"（和平）、"easy"（简单）、"normal"（普通）、"hard"（困难）。

示例：

DIFFICULTY=peaceful

默认值：easy

SPAWN_MONSTERS

是否允许怪物生成。true=启用（怪物在夜晚和黑暗处生成），false=禁用。

示例：

SPAWN_MONSTERS=false

默认值：false

SPAWN_ANIMALS

是否允许动物生成。true=正常生成，false=动物立即消失。

示例：

SPAWN_ANIMALS=false

默认值：false

SPAWN_NPCS

是否允许村民生成。true=正常生成，false=村民立即消失。

示例：

SPAWN_NPCS=false

默认值：false

本地运行

使用以下命令在本地启动容器，映射必要的端口和卷：

shell
docker run \
  --rm \
  -it \
  -p 25565:25565 \
  -p 27015:27015 \
  -v ${PWD}/mods:/minecraft/mods \
  -v ${PWD}/world:/minecraft/world \
  -v ${PWD}/config:/minecraft/config \
  -e "MINECRAFT_MOTD=Hello World" \
  -e "RCON_ENABLED=true" \
  -e "RCON_PASSWORD=password" \
  -e "WORLD_BACKUP=https://github.com/HashiCraft/digital-ocean-deploy/releases/download/v0.0.0/world.tar.gz" \
  hashicraft/minecraft:v1.16.3

使用Shipyard运行

1. 安装Shipyard：[***]
2. 执行以下命令运行配置：

shipyard run ./blueprint

容器初始化时会自动下载世界和模组，并保存到本地目录：

• ./mods：Minecraft模组
• ./world：Minecraft世界数据
• ./config：Minecraft配置文件

重置世界至初始状态可删除./world目录内容。

构建Docker镜像

修改Dockerfile或entrypoint.sh后，可通过以下命令构建新镜像：

shell
docker build -t hashicraft/minecraft:latest .

暴露服务器到公网

使用工具（[]

1. 安装***并执行以下命令映射Minecraft端口：

shell
ngrok tcp 25565

2. 根据输出的转发地址（如tcp://0.tcp.ngrok.io:17144），玩家可通过该地址连接服务器。

部署演示

查看Azure容器镜像部署演示：HashiCraft第1集