diff --git a/README.md b/README.md index 04b6810..9dce6b9 100644 --- a/README.md +++ b/README.md @@ -1,104 +1,184 @@ -# PT's Basic Modpack - -一些最基础的功能的模组包,包括录制、光影、基本优化等。主打原版味道。 - -## 开发 - -分为服务端和客户端两部分。服务端会在不同时间,安装不同的娱乐性质的模组。客户端则会努力保持不变。 - -使用 [packwiz](https://packwiz.infra.link) 进行模组包管理。 - -首先你要安装 packwiz。建议的是用 Golang 技术栈来直接安装: - -```bash -go install github.com/packwiz/packwiz@latest -``` - -然后,进入对应的目录开始工作。例如要更改客户端相关: - -```bash -cd client -``` - -### 添加模组 - -```bash -packwiz add https://modrinth.com/mod/create -``` - -### 构建 .mrpack 文件 - -```bash -packwiz modrinth export -``` - -## 服务端部署 - -参见 [该文档](https://packwiz.infra.link/tutorials/installing/packwiz-installer/)。 - -可以直接使用 Docker 来测试运行: - -```bash -docker run --pull=always \ - -e TYPE=FABRIC \ - -e "PACKWIZ_URL=https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack/raw/branch/main/server-01-random-block/pack.toml" \ - -e "EULA=TRUE" \ - -e "VERSION=1.21.10" \ - -p 25565:25565 \ - itzg/minecraft-server -``` - -或者,需要从 [https://github.com/packwiz/packwiz-installer/releases](这里) 下载最新最热的 Installer,以安装需要的文件。 - -## 面板服一键启动脚本 - -仓库根目录新增了 `start.sh`,适合“只能上传文件、编辑文件,然后点一个固定 shell 脚本启动”的面板服环境。 - -它会自动完成这些事情: - -1. 读取 `server-01-random-block/pack.toml` 中的 Minecraft / Fabric 版本 -2. 下载并执行 Fabric 官方 installer,生成服务端启动 jar -3. 读取 `server-01-random-block/mods/*.pw.toml` -4. 自动下载服务端需要的模组到根目录 `mods/` -5. 自动写入 `eula.txt` -6. 最后启动服务端 - -### 最简单的用法 - -把整个仓库内容上传到服务器根目录后,直接让面板运行: - -```bash -bash start.sh -``` - -### 环境要求 - -- 必须有 `bash` -- 必须有 `java` -- 必须有 `curl` 或 `wget` -- 建议有常见基础命令:`grep`、`sed`、`awk`、`find` -- 服务器需要能联网下载 Fabric installer 和 Modrinth 模组文件 - -### 可选环境变量 - -- `PT_JAVA_ARGS`:Java 内存等参数,默认 `-Xms1G -Xmx2G` -- `PT_AUTO_EULA`:默认 `TRUE`,自动写入 `eula=true` -- `PT_FORCE_UPDATE=1`:强制重新安装 Fabric / 重新下载模组 -- `PT_SERVER_JAR`:手动指定启动的服务端 jar 路径 -- `PT_PACK_DIR`:手动指定 pack 目录,默认 `server-01-random-block` -- `PT_MODS_DIR`:手动指定模组目录,默认根目录下的 `mods/` -- `PT_RUNTIME_DIR`:缓存下载内容的目录,默认 `.pt-panel-runtime/` -- `PT_SKIP_HASH_CHECK=1`:跳过模组 hash 校验(不建议) - -### 示例 - -```bash -PT_JAVA_ARGS="-Xms2G -Xmx4G" bash start.sh -``` - -如果面板要求固定脚本名,你也可以直接把 `start.sh` 重命名成面板要求的名字,或者让那个固定入口脚本只写一行: - -```bash -bash start.sh -``` - +# PT's Basic Modpack + +一些最基础的功能的模组包,包括录制、光影、基本优化等。主打原版味道。 + +## 开发 + +分为服务端和客户端两部分。服务端会在不同时间,安装不同的娱乐性质的模组。客户端则会努力保持不变。 + +使用 [packwiz](https://packwiz.infra.link) 进行模组包管理。 + +首先你要安装 packwiz。建议的是用 Golang 技术栈来直接安装: + +```bash +go install github.com/packwiz/packwiz@latest +``` + +然后,进入对应的目录开始工作。例如要更改客户端相关: + +```bash +cd client +``` + +### 添加模组 + +```bash +packwiz add https://modrinth.com/mod/create +``` + +### 构建 .mrpack 文件 + +```bash +packwiz modrinth export +``` + +## 服务端部署 + +参见 [该文档](https://packwiz.infra.link/tutorials/installing/packwiz-installer/)。 + +可以直接使用 Docker 来测试运行: + +```bash +docker run --pull=always \ + -e TYPE=FABRIC \ + -e "PACKWIZ_URL=https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack/raw/branch/main/server-01-random-block/pack.toml" \ + -e "EULA=TRUE" \ + -e "VERSION=1.21.10" \ + -p 25565:25565 \ + itzg/minecraft-server +``` + +或者,需要从 [https://github.com/packwiz/packwiz-installer/releases](这里) 下载最新最热的 Installer,以安装需要的文件。 + +## 面板服一键启动方案 + +仓库根目录提供了 `start.sh`,适合“只能上传文件、编辑文件,然后点一个固定 shell 脚本启动”的面板服环境。 + +它会自动完成这些事情: + +1. 选择一个具体服务端 pack(例如 `server-01-random-block`) +2. 读取该 pack 的 `pack.toml` 中的 Minecraft / Fabric 版本 +3. 下载并执行 Fabric 官方 installer,生成服务端启动 jar +4. 读取对应 `mods/*.pw.toml` +5. 自动下载当前服务端需要的模组到运行目录 `mods/` +6. 自动删除上一个服务端残留、但当前服务端不再需要的旧模组 +7. 自动写入 `eula.txt` +8. 最后启动服务端 + +这意味着以后仓库里新增更多目录,例如: + +- `server-01-random-block` +- `server-02-xxx` +- `server-03-yyy` + +都可以继续复用同一个启动脚本,只需要切换 `PT_SERVER` 即可。 + +## 方案一:你把整个仓库上传到面板服 + +上传后,让面板执行: + +```bash +PT_SERVER=server-01-random-block bash start.sh +``` + +如果仓库里只有一个 `server-*` 目录,不传 `PT_SERVER` 也可以自动选择;但只要有多个,建议明确传。 + +### 常用示例 + +```bash +PT_SERVER=server-01-random-block PT_JAVA_ARGS="-Xms2G -Xmx4G" bash start.sh +``` + +```bash +PT_SERVER=server-02-xxx bash start.sh +``` + +## 方案二:面板服里只粘贴一个“远程拉取并运行”的脚本 + +如果你的面板服不方便手动上传整个仓库,而是允许你在固定 `.sh` 入口里粘贴脚本,那么可以直接粘贴下面这段: + +```bash +#!/usr/bin/env bash +set -Eeuo pipefail + +REPO_URL="https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack" +REPO_REF="main" +PT_SERVER="server-01-random-block" +INSTALL_DIR="$(pwd)/pt-minecraft-modpack" + +if command -v curl >/dev/null 2>&1; then + DOWNLOAD() { curl -fL --retry 3 --retry-delay 2 -o "$1" "$2"; } +elif command -v wget >/dev/null 2>&1; then + DOWNLOAD() { wget -O "$1" "$2"; } +else + echo "缺少 curl 或 wget" >&2 + exit 1 +fi + +ARCHIVE_PATH="$INSTALL_DIR.tar.gz" +TMP_DIR="$INSTALL_DIR.__tmp" +rm -rf "$TMP_DIR" +mkdir -p "$TMP_DIR" + +DOWNLOAD "$ARCHIVE_PATH" "$REPO_URL/archive/$REPO_REF.tar.gz" +tar -xzf "$ARCHIVE_PATH" -C "$TMP_DIR" + +EXTRACTED_DIR="$(find "$TMP_DIR" -mindepth 1 -maxdepth 1 -type d | head -n 1)" +[ -n "$EXTRACTED_DIR" ] || { echo "解压失败" >&2; exit 1; } + +rm -rf "$INSTALL_DIR" +mv "$EXTRACTED_DIR" "$INSTALL_DIR" +rm -rf "$TMP_DIR" "$ARCHIVE_PATH" + +cd "$INSTALL_DIR" +PT_SERVER="$PT_SERVER" bash start.sh +``` + +### 这个远程脚本怎么改 + +你通常只需要改这几个变量: + +- `REPO_REF`:默认 `main`,也可以改成某个分支或 tag +- `PT_SERVER`:你这次要开的服务端目录名 +- `INSTALL_DIR`:解压后的安装目录 + +例如切换到另一个服务端: + +```bash +PT_SERVER="server-02-xxx" +``` + +## 环境要求 + +- 必须有 `bash` +- 必须有 `java` +- 必须有 `curl` 或 `wget` +- 远程拉取方案还需要 `tar` +- 建议有常见基础命令:`grep`、`sed`、`awk`、`find` +- 服务器需要能联网下载: + - 你的 Gitea 仓库归档 + - Fabric installer + - Modrinth 模组文件 + +## `start.sh` 可选环境变量 + +- `PT_SERVER`:选择要安装/启动的服务端目录名,例如 `server-01-random-block` +- `PT_INSTALL_ROOT`:实际运行目录,默认是脚本所在目录 +- `PT_JAVA_ARGS`:Java 内存等参数,默认 `-Xms1G -Xmx2G` +- `PT_AUTO_EULA`:默认 `TRUE`,自动写入 `eula=true` +- `PT_FORCE_UPDATE=1`:强制重新安装 Fabric / 重新下载模组 +- `PT_SERVER_JAR`:手动指定启动的服务端 jar 路径 +- `PT_MODS_DIR`:手动指定模组目录,默认运行目录下的 `mods/` +- `PT_RUNTIME_DIR`:缓存下载内容与状态文件的目录,默认 `.pt-panel-runtime/` +- `PT_SKIP_HASH_CHECK=1`:跳过模组 hash 校验(不建议) + +## 验证思路 + +本脚本在本地已做过: + +```bash +bash -n start.sh +PT_DRY_RUN=1 JAVA_BIN=true PT_SERVER=server-01-random-block bash start.sh +``` + +当前 agent 环境里没有 `java`,所以这里只做了 dry-run 验证;真实运行依赖目标面板服具备 Java 与联网下载能力。 diff --git a/start.sh b/start.sh index 40a5a9f..5c6c0d6 100755 --- a/start.sh +++ b/start.sh @@ -1,12 +1,11 @@ #!/usr/bin/env bash set -Eeuo pipefail -ROOT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)" -PACK_DIR="${PT_PACK_DIR:-$ROOT_DIR/server-01-random-block}" -RUNTIME_DIR="${PT_RUNTIME_DIR:-$ROOT_DIR/.pt-panel-runtime}" -MODS_DIR="${PT_MODS_DIR:-$ROOT_DIR/mods}" -DOWNLOAD_DIR="$RUNTIME_DIR/downloads" -STAMP_FILE="$RUNTIME_DIR/fabric-install.stamp" +SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)" +INSTALL_ROOT="${PT_INSTALL_ROOT:-$SCRIPT_DIR}" +SERVER_NAME="${PT_SERVER:-${1:-}}" +RUNTIME_BASE_DIR="${PT_RUNTIME_DIR:-$INSTALL_ROOT/.pt-panel-runtime}" +DOWNLOAD_DIR="$RUNTIME_BASE_DIR/downloads" JAVA_BIN="${JAVA_BIN:-java}" JAVA_ARGS="${PT_JAVA_ARGS:--Xms1G -Xmx2G}" @@ -16,6 +15,11 @@ DRY_RUN="${PT_DRY_RUN:-0}" SKIP_HASH_CHECK="${PT_SKIP_HASH_CHECK:-0}" AUTO_EULA="${PT_AUTO_EULA:-TRUE}" +PACK_DIR="" +MODS_DIR="" +STAMP_FILE="" +MOD_STATE_FILE="" + log() { printf '[pt-panel] %s\n' "$*" } @@ -99,12 +103,52 @@ verify_hash() { [ "$actual" = "$expected" ] } +list_available_servers() { + find "$SCRIPT_DIR" -mindepth 1 -maxdepth 1 -type d -name 'server-*' -exec basename {} \; | sort +} + +select_server() { + local available count first + + if [ -n "$SERVER_NAME" ]; then + PACK_DIR="$SCRIPT_DIR/$SERVER_NAME" + [ -f "$PACK_DIR/pack.toml" ] || fail "指定的服务端不存在: $SERVER_NAME" + return 0 + fi + + available="$(list_available_servers || true)" + count="$(printf '%s\n' "$available" | sed '/^$/d' | wc -l | awk '{print $1}')" + + if [ "$count" = "1" ]; then + first="$(printf '%s\n' "$available" | sed -n '1p')" + SERVER_NAME="$first" + PACK_DIR="$SCRIPT_DIR/$SERVER_NAME" + return 0 + fi + + if [ "$count" = "0" ]; then + fail "仓库中没有找到任何 server-* 服务端目录" + fi + + printf '[pt-panel] 可选服务端:\n%s\n' "$(printf '%s\n' "$available" | sed 's/^/ - /')" >&2 + fail "检测到多个服务端,请通过 PT_SERVER=<目录名> 或第一个参数指定,例如:PT_SERVER=server-01-random-block bash start.sh" +} + ensure_dirs() { - mkdir -p "$RUNTIME_DIR" "$DOWNLOAD_DIR" "$MODS_DIR" + mkdir -p "$INSTALL_ROOT" "$RUNTIME_BASE_DIR" "$DOWNLOAD_DIR" + MODS_DIR="${PT_MODS_DIR:-$INSTALL_ROOT/mods}" + mkdir -p "$MODS_DIR" +} + +prepare_server_paths() { + local safe_server_name + safe_server_name="$(printf '%s' "$SERVER_NAME" | tr '/' '_')" + STAMP_FILE="$RUNTIME_BASE_DIR/fabric-install-${safe_server_name}.stamp" + MOD_STATE_FILE="$RUNTIME_BASE_DIR/mods-${safe_server_name}.txt" } load_pack_versions() { - [ -f "$PACK_DIR/pack.toml" ] || fail "找不到 $PACK_DIR/pack.toml,请确认已上传服务端 pack 文件" + [ -f "$PACK_DIR/pack.toml" ] || fail "找不到 $PACK_DIR/pack.toml,请确认服务端 pack 存在" MINECRAFT_VERSION="$(toml_value 'minecraft' "$PACK_DIR/pack.toml")" FABRIC_LOADER_VERSION="$(toml_value 'fabric' "$PACK_DIR/pack.toml")" @@ -126,15 +170,15 @@ install_fabric_server() { installer_version="$(load_latest_fabric_installer_version)" installer_jar="$DOWNLOAD_DIR/fabric-installer-${installer_version}.jar" - wanted_stamp="mc=$MINECRAFT_VERSION loader=$FABRIC_LOADER_VERSION installer=$installer_version" + wanted_stamp="server=$SERVER_NAME mc=$MINECRAFT_VERSION loader=$FABRIC_LOADER_VERSION installer=$installer_version" current_stamp="$(cat "$STAMP_FILE" 2>/dev/null || true)" - if [ "$FORCE_UPDATE" != "1" ] && [ -f "$ROOT_DIR/fabric-server-launch.jar" ] && [ "$wanted_stamp" = "$current_stamp" ]; then + if [ "$FORCE_UPDATE" != "1" ] && [ -f "$INSTALL_ROOT/fabric-server-launch.jar" ] && [ "$wanted_stamp" = "$current_stamp" ]; then log "Fabric 服务端已就绪,跳过重复安装" return 0 fi - log "准备安装 Fabric 服务端 (Minecraft $MINECRAFT_VERSION / Loader $FABRIC_LOADER_VERSION)" + log "准备安装 Fabric 服务端:$SERVER_NAME (Minecraft $MINECRAFT_VERSION / Loader $FABRIC_LOADER_VERSION)" fetch "https://maven.fabricmc.net/net/fabricmc/fabric-installer/${installer_version}/fabric-installer-${installer_version}.jar" "$installer_jar" if [ "$DRY_RUN" = "1" ]; then @@ -142,12 +186,35 @@ install_fabric_server() { return 0 fi - "$JAVA_BIN" -jar "$installer_jar" server -mcversion "$MINECRAFT_VERSION" -loader "$FABRIC_LOADER_VERSION" -downloadMinecraft + ( + cd "$INSTALL_ROOT" + "$JAVA_BIN" -jar "$installer_jar" server -mcversion "$MINECRAFT_VERSION" -loader "$FABRIC_LOADER_VERSION" -downloadMinecraft + ) printf '%s\n' "$wanted_stamp" > "$STAMP_FILE" } +cleanup_stale_mods() { + local current_file stale_name + + [ -f "$MOD_STATE_FILE" ] || return 0 + + while IFS= read -r stale_name; do + [ -n "$stale_name" ] || continue + current_file="$MODS_DIR/$stale_name" + if [ ! -f "$RUNTIME_BASE_DIR/current-mods.txt" ] || ! grep -Fxq "$stale_name" "$RUNTIME_BASE_DIR/current-mods.txt"; then + if [ -f "$current_file" ]; then + log "移除旧模组: $stale_name" + [ "$DRY_RUN" = "1" ] || rm -f "$current_file" + fi + fi + done < "$MOD_STATE_FILE" +} + sync_mods() { local meta file_name url hash_format hash dest tmp + local tmp_state_file="$RUNTIME_BASE_DIR/current-mods.txt" + + : > "$tmp_state_file" shopt -s nullglob local files=("$PACK_DIR"/mods/*.pw.toml) @@ -164,6 +231,7 @@ sync_mods() { [ -n "$file_name" ] || fail "无法读取 $meta 中的 filename" [ -n "$url" ] || fail "无法读取 $meta 中的 download.url" + printf '%s\n' "$file_name" >> "$tmp_state_file" dest="$MODS_DIR/$file_name" if [ "$FORCE_UPDATE" != "1" ] && [ -f "$dest" ]; then @@ -196,11 +264,14 @@ sync_mods() { mv "$tmp" "$dest" done + + cleanup_stale_mods + [ "$DRY_RUN" = "1" ] || mv "$tmp_state_file" "$MOD_STATE_FILE" } write_eula() { if [ "$AUTO_EULA" = "TRUE" ] || [ "$AUTO_EULA" = "true" ] || [ "$AUTO_EULA" = "1" ]; then - printf 'eula=true\n' > "$ROOT_DIR/eula.txt" + printf 'eula=true\n' > "$INSTALL_ROOT/eula.txt" log "已写入 eula.txt" else log "已跳过自动写入 EULA(PT_AUTO_EULA=$AUTO_EULA)" @@ -213,13 +284,13 @@ find_server_jar() { return 0 fi - if [ -f "$ROOT_DIR/fabric-server-launch.jar" ]; then - printf '%s' "$ROOT_DIR/fabric-server-launch.jar" + if [ -f "$INSTALL_ROOT/fabric-server-launch.jar" ]; then + printf '%s' "$INSTALL_ROOT/fabric-server-launch.jar" return 0 fi local candidate - candidate="$(find "$ROOT_DIR" -maxdepth 1 -type f \( -name 'fabric-server-launch.jar' -o -name 'fabric-server-*.jar' -o -name 'server.jar' \) | sort | head -n 1 || true)" + candidate="$(find "$INSTALL_ROOT" -maxdepth 1 -type f \( -name 'fabric-server-launch.jar' -o -name 'fabric-server-*.jar' -o -name 'server.jar' \) | sort | head -n 1 || true)" [ -n "$candidate" ] || return 1 printf '%s' "$candidate" } @@ -234,6 +305,7 @@ start_server() { else log "DRY RUN: 当前尚未生成服务端 jar;正式运行时会先执行 Fabric installer" fi + log "安装目录: $INSTALL_ROOT" log "启动参数: $JAVA_ARGS" log "DRY RUN: 跳过实际启动" return 0 @@ -241,10 +313,12 @@ start_server() { [ -n "$server_jar" ] || fail "找不到可启动的服务端 jar,请检查 Fabric 安装是否成功" + log "使用服务端: $SERVER_NAME" log "使用服务端文件: $server_jar" + log "安装目录: $INSTALL_ROOT" log "启动参数: $JAVA_ARGS" - cd "$ROOT_DIR" + cd "$INSTALL_ROOT" exec "$JAVA_BIN" $JAVA_ARGS -jar "$server_jar" nogui } @@ -255,10 +329,14 @@ main() { need_cmd awk need_cmd find + select_server ensure_dirs + prepare_server_paths load_pack_versions - log "根目录: $ROOT_DIR" + log "脚本目录: $SCRIPT_DIR" + log "安装目录: $INSTALL_ROOT" + log "选择服务端: $SERVER_NAME" log "Pack 目录: $PACK_DIR" log "Minecraft 版本: $MINECRAFT_VERSION" log "Fabric Loader 版本: $FABRIC_LOADER_VERSION"