qumine/minecraft-server

QuMine - Server - Java

!GitHub Release !GitHub Workflow https://godoc.org/github.com/qumine/minecraft-server?status.svg](https://godoc.org/github.com/qumine/minecraft-server) https://goreportcard.com/badge/github.com/qumine/minecraft-server](https://goreportcard.com/report/github.com/qumine/minecraft-server)

用于运行Minecraft服务器的Docker镜像，支持多种服务器类型、插件自动下载、配置管理及远程控制功能，简化Minecraft服务器的部署与运维。

功能状态

• 服务器JAR基础下载
• 服务器JAR基础更新
• JVM进程基础包装
• API健康检查端点
• 服务器插件基础下载
• 服务器插件基础更新
• GRPC API远程控制服务器（启动、停止等）
• GRPC API日志流
• GRPC API控制台流（输入、输出）
• Cryo功能（无客户端连接时停止服务器）

使用方法

快速启动

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=VANILLA qumine/minecraft-server:latest

访问服务器控制台

可通过在容器内执行console命令访问服务器控制台，该命令会流式输出日志并允许发送命令到服务器。

配置说明

eula.txt

使用服务器前需接受Mojang的最终用户许可协议：

bash
EULA=true

server.properties

服务器属性可通过前缀为SERVER_PROPERTIES_*的环境变量进行设置。

例如，配置最大玩家数：

bash
SERVER_PROPERTIES_MAX_PLAYERS=10

whitelist.json

whitelist.json仅在首次启动时生成

若通过SERVER_PROPERTIES_WHITE_LIST=true启用白名单，可通过SERVER_WHITE_LIST环境变量添加初始白名单玩家。

例如，添加玩家Notch和Herobrine到初始白名单：

bash
SERVER_WHITE_LIST=Notch,Herobrine

可通过设置SERVER_WHITE_LIST_OVERRIDE环境变量强制在每次容器启动时覆盖whitelist.json：

bash
SERVER_WHITE_LIST_OVERRIDE=true

ops.json

ops.json仅在首次启动时生成

可通过SERVER_OPS环境变量添加初始操作员。

例如，添加玩家Notch和Herobrine到初始操作员列表：

bash
SERVER_OPS=Notch,Herobrine

可通过设置SERVER_OPS_OVERRIDE环境变量强制在每次容器启动时覆盖ops.json：

bash
SERVER_OPS_OVERRIDE=true

服务器类型

自定义（Custom）

自定义模式下，默认会下载指定URL的文件，然后通过java -jar命令执行：

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=CUSTOM -e SERVER_CUSTOM_URL=https://papermc.io/api/v1/paper/1.16.4/296/download qumine/minecraft-server:latest

如需自定义服务器启动命令，可使用SERVER_CUSTOM_COMMAND和SERVER_CUSTOM_ARGS环境变量：

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=CUSTOM -e SERVER_CUSTOM_URL=https://papermc.io/api/v1/paper/1.16.4/296/download -e SERVER_CUSTOM_COMMAND=java -e SERVER_CUSTOM_ARGS="-XX:+UseG1GC,-jar,download,nogui" qumine/minecraft-server:latest

PaperMC

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=PAPERMC -e SERVER_VERSION=latest qumine/minecraft-server:latest

ServerStarter

此类型使用https://github.com/Yoosk/ServerStarter%E9%85%8D%E7%BD%AE%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%9A

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=PAPERMC -e SERVER_VERSION=latest qumine/minecraft-server:latest

注意：内存大小必须符合server-setup-config.yaml中的minRam和maxRam选项。

Travertine

bash
docker run -it --rm -p 8080:8080 -p 25565:25577 -e SERVER_TYPE=TRAVERTINE -e SERVER_VERSION=latest qumine/minecraft-server:latest

Vanilla

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=VANILLA -e SERVER_VERSION=1.16.4 qumine/minecraft-server:latest

Waterfall

bash
docker run -it --rm -p 8080:8080 -p 25565:25577 -e SERVER_TYPE=WATERFALL -e SERVER_VERSION=latest qumine/minecraft-server:latest

Yatopia

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=YATOPIA -e SERVER_VERSION=latest qumine/minecraft-server:latest

插件管理

通过SERVER_PLUGINS环境变量可自动下载插件并保持更新。

当前仅支持HTTP和HTTPS协议的插件源

bash
docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=PAPERMC -e SERVER_VERSION=latest -e SERVER_PLUGINS="https://github.com/BlueMap-Minecraft/BlueMap/releases/download/v1.3.0-snap/BlueMap-1.3.0-snap-spigot.jar,https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/lastSuccessfulBuild/artifact/bukkit/target/floodgate-bukkit.jar" qumine/minecraft-server:latest

部署方式

Operator

TODO

Docker

TODO

Kubernetes

TODO

Helm

HELM Charts可在以下地址获取：https://github.com/qumine/charts

开发指南

本地执行快照发布

bash
docker run -it --rm \
  -v ${PWD}:/build -w /build \
  -v /var/run/docker.sock:/var/run/docker.sock \
  goreleaser/goreleaser \
  release --snapshot --rm-dist