换位置
This commit is contained in:
@@ -41,7 +41,7 @@
|
||||
1. `scripts\package\pack_local_test.bat` 或 `python scripts/package/pack_local_test.py` → 产出 `build\output_local\ServerManager_Setup_LOCAL.exe`(不覆盖正式 `build\output\`)。
|
||||
2. 本地安装测试通过后,再按 **[RELEASE.md](RELEASE.md)** 执行版本号与 `scripts\package\pack_all.bat` / `scripts\package\release.bat` 发版。
|
||||
|
||||
**`rg.exe`(可选但推荐)**:将 [ripgrep](https://github.com/BurntSushi/ripgrep/releases) 的 `rg.exe` 放在 `resources\bin\rg.exe`,执行 `scripts\package\build.bat` 时会自动复制进 `src\dist\main\`,安装后与 `main.exe` 同目录,日志检索与文件搜索可直接调用。
|
||||
**`rg.exe`(可选但推荐)**:将 [ripgrep](https://github.com/BurntSushi/ripgrep/releases) 的 `rg.exe` 放在 `resources\bin\rg.exe`,执行 `scripts\package\build.bat` 时会自动复制进 `src\dist\ServerManager\`,安装后与 `ServerManager.exe` 同目录,日志检索与文件搜索可直接调用。
|
||||
|
||||
## 软件安装说明
|
||||
|
||||
@@ -79,8 +79,10 @@
|
||||
|
||||
Windows 下推荐直接使用图形界面,第一次使用按下面流程即可:
|
||||
|
||||
完整使用教程见 [docs/USER_GUIDE.md](docs/USER_GUIDE.md)。
|
||||
|
||||
1. 启动工具:
|
||||
- 安装版:从开始菜单、桌面快捷方式,或安装目录下的 `main.exe` 启动。
|
||||
- 安装版:从开始菜单、桌面快捷方式,或安装目录下的 `ServerManager.exe` 启动。
|
||||
- 源码版:在项目根目录执行 `scripts\run\run.bat gui`,或设置 `PYTHONPATH=src` 后执行 `python -m entrypoints`。
|
||||
2. 打开项目:
|
||||
- 在欢迎页点击“打开项目”,或在菜单 `文件 -> 打开项目` 中选择目录。
|
||||
@@ -136,17 +138,17 @@ pip install PyQt6
|
||||
|
||||
### 打包后主程序直接命令行(Windows / Linux,推荐)
|
||||
|
||||
安装或本地打包后的 **`main.exe`(Windows)**、**`main`(Linux)** 与源码里的 `entrypoints` 统一入口一致:**无参数启动 GUI;带任意参数则走命令行**(`list`、`create`、`start`、`--help` 等)。
|
||||
安装或本地打包后的 **`ServerManager.exe`(Windows)**、**`ServerManager`(Linux)** 与源码里的 `entrypoints` 统一入口一致:**无参数启动 GUI;带任意参数则走命令行**(`list`、`create`、`start`、`--help` 等)。
|
||||
|
||||
| 场景 | Windows | Linux |
|
||||
|------|---------|--------|
|
||||
| 图形界面 | `main.exe` | `./main` |
|
||||
| 命令行 | `main.exe list` | `./main list` |
|
||||
| 帮助 | `main.exe --help` | `./main --help` |
|
||||
| 图形界面 | `ServerManager.exe` | `./ServerManager` |
|
||||
| 命令行 | `ServerManager.exe list` | `./ServerManager list` |
|
||||
| 帮助 | `ServerManager.exe --help` | `./ServerManager --help` |
|
||||
|
||||
- **Windows**:安装目录下的 `main.exe`,或执行 `scripts\package\build.bat` 后使用 `src\dist\main\main.exe`。
|
||||
- **Linux**:执行 `scripts/package/build_linux.sh` 后使用 `src/dist/main/main`;可将该路径加入 `PATH`,或设置环境变量 **`SERVER_MANAGER_MAIN`** 指向该可执行文件。
|
||||
- **`scripts\run\run.bat` / `scripts/run/run.sh`**:若检测到同目录或 `src/dist/main/` 下的打包主程序,会自动用它执行(并附带脚本中的 `--root` 服务器根目录),与上面「直接调用」等价、只是多了根目录约定。
|
||||
- **Windows**:安装目录下的 `ServerManager.exe`,或执行 `scripts\package\build.bat` 后使用 `src\dist\ServerManager\ServerManager.exe`。
|
||||
- **Linux**:执行 `scripts/package/build_linux.sh` 后使用 `src/dist/ServerManager/ServerManager`;可将该路径加入 `PATH`,或设置环境变量 **`SERVER_MANAGER_MAIN`** 指向该可执行文件。
|
||||
- **`scripts\run\run.bat` / `scripts/run/run.sh`**:若检测到同目录或 `src/dist/ServerManager/` 下的打包主程序,会自动用它执行(并附带脚本中的 `--root` 服务器根目录),与上面「直接调用」等价、只是多了根目录约定。
|
||||
|
||||
### Linux 命令行(推荐)
|
||||
|
||||
@@ -259,7 +261,7 @@ python -m entrypoints.cli --root E:\game\server_root mcp
|
||||
**Windows:**
|
||||
|
||||
```batch
|
||||
scripts\package\build.bat # 标准打包,产出 src\dist\main\main.exe
|
||||
scripts\package\build.bat # 标准打包,产出 src\dist\ServerManager\ServerManager.exe
|
||||
scripts\package\build_portable.bat # 便携版打包
|
||||
```
|
||||
|
||||
@@ -267,7 +269,7 @@ scripts\package\build_portable.bat # 便携版打包
|
||||
|
||||
```bash
|
||||
chmod +x scripts/package/build_linux.sh
|
||||
./scripts/package/build_linux.sh # 产出 src/dist/main/main
|
||||
./scripts/package/build_linux.sh # 产出 src/dist/ServerManager/ServerManager
|
||||
```
|
||||
|
||||
## 命令行工具参数
|
||||
@@ -362,22 +364,23 @@ compile 参数:
|
||||
结构调整后的发布要求:
|
||||
|
||||
- 正式发布统一使用 `server_manager/build/output/version.json` 和 `server_manager/build/output/ServerManager_Setup.exe`。
|
||||
- 本次目录结构和文件名变化较大,必须走完整安装包更新;不要给旧版本生成只替换 `main.exe` 的增量补丁,否则旧安装目录里的依赖文件不会一起更新。
|
||||
- 本次目录结构和文件名变化较大,必须走完整安装包更新;不要给旧版本生成只替换 `ServerManager.exe` 的增量补丁,否则旧安装目录里的依赖文件不会一起更新。
|
||||
- `scripts\package\release.bat` 默认生成全量更新 manifest,产物只输出到 `build/output`。
|
||||
|
||||
## 配置说明
|
||||
|
||||
- **打开项目时选择的目录**:应当是服务器项目根目录,不是 `run`、`config` 或 `.server_manager\config` 子目录。
|
||||
- **项目级工具配置目录**:`<项目根目录>\.server_manager\config\`
|
||||
- `default.kv`:默认配置模板,首次打开项目时自动复制到这里
|
||||
- `tool.config`:工具保存的路径、数据库、节点、Erlang 等配置
|
||||
- `default.config`:默认配置模板,首次打开项目时自动复制到这里
|
||||
- `user.config`:工具保存的路径、数据库、节点、Erlang 等用户覆盖配置
|
||||
- `<项目根>\config\project.config`:项目共享配置,优先级低于 `user.config`、高于 `default.config`
|
||||
- **运行目录**:通常为 `<项目根目录>\run`,里面是各个服务器实例目录。
|
||||
- **单服配置文件**:通常位于 `<运行目录>\<服务器目录>\config\kv.config`。
|
||||
- **模板来源**:
|
||||
- 安装版运行时:读取 `main.exe` 同级的 `config\`
|
||||
- 安装版运行时:读取 `ServerManager.exe` 同级的 `config\`
|
||||
- 源码运行时:读取仓库根目录的 `resources\config\`
|
||||
|
||||
首次运行时,程序会自动在当前项目下准备 `.server_manager\config`;如果自动创建失败,请先检查安装目录或仓库 `resources\config` 下是否存在完整模板,至少要包含 `default.kv`。
|
||||
首次运行时,程序会自动在当前项目下准备 `.server_manager\config`;如果自动创建失败,请先检查安装目录或仓库 `resources\config` 下是否存在完整模板,至少要包含 `default.config`。
|
||||
|
||||
## 文件结构
|
||||
|
||||
|
||||
Reference in New Issue
Block a user