部署指南

本文档说明如何部署 EnderRealm 开发服务器。

前置准备

环境要求

组件	版本
JDK	21（必须）
JDK 17	17（必须，构建 Floodgate 用）
Python	3.12+
Git	最新版（需支持子模块）

获取开发资源

联系管理员获取以下信息：

• 数据库连接信息：地址、端口、用户名、密码
• API Key：用于插件认证后端服务
• 确认 i18n 数据：数据库中需已导入多语言文本（i18n_texts 表），否则游戏内所有文本将显示为 key

---

部署步骤

1. 克隆仓库并初始化子模块

git clone --recurse-submodules https://github.com/EnderRealmMC/EnderRealmServerCore.git

已克隆但未初始化子模块：

git submodule update --init --recursive

2. 配置环境变量

# Windows PowerShell（永久生效，需重启终端）
[System.Environment]::SetEnvironmentVariable("JAVA_HOME_17", "你的JDK17路径", "User")

# macOS / Linux（添加到 ~/.bashrc 或 ~/.zshrc）
export JAVA_HOME_17=/path/to/jdk-17

验证：

echo $env:JAVA_HOME_17

3. 配置并启动后端 API

cd EnderRealmServerApi
cp .env.example .env

编辑 .env，填入获取的数据库信息：

ENVIRONMENT=development
DB_HOST=获取的数据库地址
DB_PORT=5432
DB_NAME=enderrealm
DB_USER=获取的用户名
DB_PASSWORD=获取的密码
DB_MIN_CONNECTIONS=1
DB_MAX_CONNECTIONS=10

安装依赖并启动：

uv sync
uv run uvicorn app.main:app --reload

4. 构建并部署 MC 服务器

在项目根目录执行：

./gradlew setupDevServer

5. 首次启动 MC 服务器

./gradlew runDevServer

首次启动后，服务器会自动生成配置文件，等待服务器完全启动后关闭。

6. 配置插件连接后端

编辑 _server/plugins/EnderRealmServerCore/config.yml：

backend:
  url: "http://localhost:8000"
  api-key: "获取的API Key"

7. 重启服务器

./gradlew runDevServer

---

常用命令

命令	说明
./gradlew setupDevServer	构建并部署到 _server/
./gradlew setupDevServer -Pforce	强制覆盖所有文件
./gradlew runDevServer	启动开发服务器
./gradlew cleanDevServer	清理 _server/ 目录