手写 README 以指引如何开启服务器

This commit is contained in:
2026-04-27 01:56:21 +08:00
parent 894f1dda36
commit 1b8bdc60ce

194
README.md
View File

@ -50,192 +50,40 @@ docker run --pull=always \
或者,需要从 [https://github.com/packwiz/packwiz-installer/releases](这里) 下载最新最热的 Installer以安装需要的文件。
## 面板服一键启动方案
### 部署到 Simpfun
仓库根目录提供了:
在 Simpfun 申请一个服务器实例,选择多 JDK 版本的镜像。`B+.I.2XL.L` 规格的服务器是个不错的选择。因为我每次只开一天,所以天天签到拿到的积分会很够。
- `start.sh`:仓库内真正负责安装与启动服务端的主脚本
- `panel-start.sh`:专门给面板服上传使用的薄入口脚本
`管理 - 实例端口` 处花 100 积分申请一个新的端口用于 Simple Voice Chat 模组。
推荐你在面板服里这样用:
下载 [panel-start.sh](https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack/raw/branch/main/panel-start.sh) 到本地,编辑 `PT_SERVER="${PT_SERVER:-server-02-skygrid}"` 一行为你需要的服务器配置文件文件夹名。
1. 直接下载仓库里的 `panel-start.sh`
2. 上传到面板
3. 如果面板要求固定入口文件名是 `start.sh`,就把它重命名成 `start.sh`
4. 按需要修改里面的变量
5. 点击运行
有可能会出现 packwiz 的各种包下不下来的情况(因为国内网络问题)所以,你可能需要手动下载 [packwiz-installer.jar](https://github.com/packwiz/packwiz-installer/releases/latest/download/packwiz-installer.jar) 和 [packwiz-installer-bootstrap.jar](https://github.com/packwiz/packwiz-installer-bootstrap/releases/latest/download/packwiz-installer-bootstrap.jar),并放置到 `/pt-minecraft-modpack/.pt-panel-runtime/downloads` 文件夹下。
`start.sh` 现在**直接复用官方 `packwiz-installer-bootstrap` / `packwiz-installer`**,而不是自己手动管理模组列表。
#### 配置一些文件
它会自动完成这些事情
`server.properties` 编辑 `server-port` 为主端口。编辑
1. 选择一个具体服务端 pack例如 `server-01-random-block`
2. 读取该 pack 的 `pack.toml` 中的 Minecraft / Fabric 版本
3. 下载并执行 Fabric 官方 installer生成服务端启动 jar
4. 下载并执行 `packwiz-installer-bootstrap`
5.`packwiz-installer --side server` 根据远程或本地 `pack.toml` 自动同步当前服务端需要的模组
6. 自动写入 `eula.txt`
7. 最后启动服务端
## 方案一:上传整个仓库后直接运行
如果你的面板允许你上传整个仓库,那么直接运行:
```bash
PT_SERVER="server-01-random-block" bash start.sh
```env
online-mode=true
spawn-protection=0
```
因为这时 `start.sh` 会直接使用仓库里的本地 `server-01-random-block/pack.toml`
`/pt-minecraft-modpack/config/voicechat/voicechat-server.properties` 编辑 `port` 为附端口。编辑:
如果仓库里只有一个 `server-*` 目录,不传 `PT_SERVER` 也可以自动选择;但只要有多个,建议明确传。
### 常用示例
```bash
PT_SERVER="server-01-random-block" PT_JAVA_ARGS="-Xms1G -Xmx1G" bash start.sh
```env
# The distance to which the voice can be heard
max_voice_distance=64.0
# The distance to which the voice can be heard when whispering
whisper_distance=32.0
```
```bash
PT_SERVER="server-02-xxx" bash start.sh
```
#### 运营时注意
## 方案二:只下载并上传 `panel-start.sh`
`管理 - 当前实例信息` 右边的小问号可以使用积分兑换上行流量。10 积分兑换 1G。
如果你只想下载一个脚本文件再上传到面板,那么请直接使用:
这里的上行流量值,要时常刷新以了解流量消耗。
- 仓库文件:`panel-start.sh`
如果积分不足以兑换流量,可以在控制台的 `积分` 值右边的加号充值。12CNY 兑换 600 积分。
你上传后:
- 如果面板固定执行文件名就是 `start.sh`,请把 `panel-start.sh` 重命名为 `start.sh`
- 然后编辑这几个变量:
```sh
REPO_URL="https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack"
REPO_REF="main"
PT_SERVER="server-01-random-block"
PT_JAVA_ARGS="-Xms1G -Xmx1G"
```
`panel-start.sh` 默认会额外下载 `packwiz-installer.jar`,并通过本地文件方式交给 bootstrap 使用,适合 GitHub API 受限(例如 403的面板环境。
另外,它不会在每次启动时删除整个 `INSTALL_DIR`;如果目录已存在,只会覆盖仓库脚本与 pack 文件,尽量保留你已经配置好的文件。
这个脚本会:
1. 从 Gitea 下载整个仓库归档
2. 解压到当前目录下的 `pt-minecraft-modpack/`
3. 额外下载 `packwiz-installer.jar`
4. 自动调用仓库里的 `start.sh`
### 直接下载链接
你可以直接下载这个文件:
- `panel-start.sh`
`https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack/raw/branch/main/panel-start.sh`
## 方案三:直接复制 `panel-start.sh` 内容到面板里
如果你的面板不能单独下载文件,但允许你粘贴脚本内容,也可以把下面这段直接保存成面板入口脚本:
> 注意:请确保保存为 **LF 换行**,不要是 Windows 的 CRLF。
```sh
#!/bin/sh
set -eu
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"
ARCHIVE_PATH="$(pwd)/pt-minecraft-modpack.tar.gz"
TMP_DIR="$(pwd)/pt-minecraft-modpack.__tmp"
PT_JAVA_ARGS="-Xms1G -Xmx1G"
rm -rf "$TMP_DIR"
mkdir -p "$TMP_DIR"
if command -v curl >/dev/null 2>&1; then
curl -fL --retry 3 --retry-delay 2 -o "$ARCHIVE_PATH" "$REPO_URL/archive/$REPO_REF.tar.gz"
elif command -v wget >/dev/null 2>&1; then
wget -O "$ARCHIVE_PATH" "$REPO_URL/archive/$REPO_REF.tar.gz"
else
echo "缺少 curl 或 wget" >&2
exit 1
fi
tar -xzf "$ARCHIVE_PATH" -C "$TMP_DIR"
EXTRACTED_DIR="$(find "$TMP_DIR" -mindepth 1 -maxdepth 1 -type d | head -n 1)"
if [ -z "$EXTRACTED_DIR" ]; then
echo "解压失败" >&2
exit 1
fi
rm -rf "$INSTALL_DIR"
mv "$EXTRACTED_DIR" "$INSTALL_DIR"
rm -rf "$TMP_DIR" "$ARCHIVE_PATH"
cd "$INSTALL_DIR"
PT_REPO_URL="$REPO_URL" \
PT_REPO_REF="$REPO_REF" \
PT_SERVER="$PT_SERVER" \
PT_JAVA_ARGS="$PT_JAVA_ARGS" \
bash ./start.sh
```
## 环境兼容性说明
有些面板不是用 `bash start.sh`,而是直接用 `sh start.sh`。因此:
- 面板入口脚本建议使用 `panel-start.sh` 这种 `sh` 兼容的薄脚本
- 仓库内真正运行 Minecraft 的脚本继续使用 `bash`
- 如果你是从 Windows 编辑/复制脚本,请务必使用 **LF** 换行,不要用 **CRLF**
## 环境要求
- 面板入口脚本需要:`sh`
- 仓库主脚本 `start.sh` 需要:`bash`
- 必须有 `java`
- 必须有 `curl``wget`
- 远程拉取方案还需要 `tar`
- 建议有常见基础命令:`grep``sed``awk``find`
- 服务器需要能联网下载:
- 你的 Gitea 仓库归档
- Fabric installer
- `packwiz-installer-bootstrap`
- Modrinth 模组文件
## `start.sh` 可选环境变量
- `PT_SERVER`:选择要安装/启动的服务端目录名,例如 `server-01-random-block`
- `PT_REPO_URL`:仓库地址,例如 `https://gitea.service.jazzwhom.top/Passthem/pt-minecraft-modpack`
- `PT_REPO_REF`:仓库分支或 tag例如 `main`
- `PT_PACK_URL`:如果你想完全手动指定远程 `pack.toml` 地址,也可以直接传这个
- `PT_INSTALL_ROOT`:实际运行目录,默认是脚本所在目录
- `PT_JAVA_ARGS`Java 内存等参数,默认 `-Xms1G -Xmx1G`
- `PT_AUTO_EULA`:默认 `TRUE`,自动写入 `eula=true`
- `PT_FORCE_UPDATE=1`:强制重新下载 Fabric installer / bootstrap并重新执行安装
- `PT_SERVER_JAR`:手动指定启动的服务端 jar 路径
- `PT_RUNTIME_DIR`:缓存下载内容与状态文件的目录,默认 `.pt-panel-runtime/`
- `PT_PACKWIZ_BOOTSTRAP_NO_UPDATE=1`:禁用 bootstrap 自更新
- `PT_PACKWIZ_BOOTSTRAP_MAIN_JAR`:手动指定本地 `packwiz-installer.jar` 路径(适合 GitHub API 受限环境)
- `PT_FABRIC_INSTALLER_VERSION`:手动指定 Fabric installer 版本
- `PT_PACKWIZ_BOOTSTRAP_URL`:手动指定 bootstrap 下载地址
## 验证思路
本脚本已按真实链路验证过以下关键步骤:
```bash
bash -n start.sh
PT_DRY_RUN=1 PT_SERVER=server-01-random-block bash start.sh
```
并且另外在独立测试目录里实际完成了端到端验证:
- `packwiz-installer-bootstrap` 可以直接读取该仓库的 `server-01-random-block/pack.toml`
- `--side server` 会正确安装服务端所需模组
- Fabric 官方 installer 能正确安装 `Minecraft 1.21.10 + Loader 0.18.5`
- 使用 Java 21、`-Xms1G -Xmx1G` 成功启动服务器
- 服务器日志已出现:`Done (...)! For help, type "help"`
在 [这里](https://simp.host/status/simpfun) 可以查看 Simpfun 站点的 Uptime。