diff --git a/README.md b/README.md index a384fd2e..a4b22ffc 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,18 @@ SFMC 希望通过模块化架构补充基岩版的原生开发体验。 ## 快速开始 +### 桌面版(Windows x64) + +[下载未签名预发布版](https://github.com/DogeLakeDev/ScriptsForMinecraftServer/releases/tag/desktop-preview-v0.1.0-preview.2) · [使用文档](./docs/zh/guide/desktop.md) + +SFMC Desktop 支持本机与 SSH 实例,提供服务启停、日志控制台、模块与资源包、配置编辑、玩家管理和运行指标。下载 `.exe` 安装,或完整解压 `.zip` 后启动;内置 Node.js、pnpm 与预览平台。 + +添加实例时选择 **SFMC 部署根目录**(例如 `D:\WorkPlace\SFMC`)。已有正式部署建议先选择“仅查看”,完整预览使用独立测试目录。当前安装包尚未签名,请核对发行页与校验值;预览版通过发行页手动更新。 + +![SFMC Desktop 概览](./docs/public/desktop/overview.jpg) + +*界面截图使用演示实例和演示数据;更多截图与接入步骤见使用文档。* + ### 使用 pnpm 安装 ```bash diff --git a/docs/public/desktop/config.jpg b/docs/public/desktop/config.jpg new file mode 100644 index 00000000..11b2ff59 Binary files /dev/null and b/docs/public/desktop/config.jpg differ diff --git a/docs/public/desktop/modules.jpg b/docs/public/desktop/modules.jpg new file mode 100644 index 00000000..3641520c Binary files /dev/null and b/docs/public/desktop/modules.jpg differ diff --git a/docs/public/desktop/overview.jpg b/docs/public/desktop/overview.jpg new file mode 100644 index 00000000..2d0977ff Binary files /dev/null and b/docs/public/desktop/overview.jpg differ diff --git a/docs/zh/guide/_meta.json b/docs/zh/guide/_meta.json index eae92c09..d6763194 100644 --- a/docs/zh/guide/_meta.json +++ b/docs/zh/guide/_meta.json @@ -1,5 +1,6 @@ [ "index", + "desktop", "services", "config", "modules", diff --git a/docs/zh/guide/desktop.md b/docs/zh/guide/desktop.md new file mode 100644 index 00000000..72d9289f --- /dev/null +++ b/docs/zh/guide/desktop.md @@ -0,0 +1,77 @@ +# SFMC 桌面版 + +SFMC Desktop 是 Windows x64 桌面客户端,可以管理本机 SFMC 部署,也可以通过 SSH 连接 Linux 或 Windows 服务器。服务启停、控制台、模块、资源包、配置、玩家与维护任务都集中在同一个工作区。 + +当前提供 **0.1.0-preview.2 未签名预发布版**。内置平台为 `0.2.9-preview.2`,独立于 npm 正式版;预览版通过发行页手动下载安装更新。 + +## 下载与启动 + +从 [桌面版预发布页](https://github.com/DogeLakeDev/ScriptsForMinecraftServer/releases/tag/desktop-preview-v0.1.0-preview.2) 下载: + +- `SFMC-Desktop-0.1.0-preview.2-x64.exe`:安装向导,可以选择安装目录。 +- `SFMC-Desktop-0.1.0-preview.2-x64.zip`:完整解压到一个目录,再运行 `SFMC Desktop.exe`。保留全部文件。 +- `SHA256SUMS.txt`:下载校验值;`release-manifest.json`:源代码提交与内置运行时版本。 + +客户端已经包含 Node.js、pnpm 和平台代码,本机无需额外安装这些工具。首次初始化、BDS 下载及联网更新仍需要网络。 + +签名申请正在审核,因此 Windows 可能显示“未知发布者”或 SmartScreen 提示。先确认下载来自上面的官方仓库,并核对校验值;是否继续运行由你决定,不需要关闭系统安全功能。 + +```powershell +Get-FileHash -LiteralPath '.\SFMC-Desktop-0.1.0-preview.2-x64.exe' -Algorithm SHA256 +``` + +## 添加本机实例 + +1. 在欢迎页选择 **本机**,填写便于辨认的实例名称。 +2. 选择 **SFMC 部署根目录**,例如 `D:\WorkPlace\SFMC`。不要选择源码仓库、`BDS` 子目录或世界目录。 +3. 保存后点击 **接入实例**。查看接入计划,再选择 **仅查看** 或完成接入。 + +已有部署保留自己的活动平台版本,客户端不会仅因为连接就替换它。旧平台可能只能查看,或者缺少新指标与管理接口。完整预览建议使用独立测试目录(例如 `D:\WorkPlace\SFMC-Desktop-Preview`),按引导确认 Minecraft EULA 并初始化;向导会下载 BDS 并尝试启动服务;不要直接把正式世界搬进去。 + +## 添加 SSH 实例 + +在欢迎页选择 **远程服务器**,填写下列信息: + +| 字段 | 填写方式 | +| --- | --- | +| 主机、端口 | SSH 的实际地址和端口 | +| 用户名 | 远程登录用户 | +| 操作系统 | 远程服务器的 Windows 或 Linux | +| 部署目录 | 远程 SFMC 的绝对根路径,例如 `/srv/sfmc` 或 `E:\SFMC` | +| 身份验证 | 选择私钥文件,或输入密码;加密私钥另填口令 | + +客户端不会自动解析 `~/.ssh/config` 中的别名。若平时使用 `ssh dogelake`,先在终端执行 `ssh -G dogelake`,把该连接的 HostName、Port、User 和 IdentityFile 对应值填入窗口。私钥文件位于运行桌面客户端的电脑上。 + +首次连接需要核实主机指纹,与可信终端或服务器管理者提供的指纹比较后确认。远程服务器需要已有 SSH 服务与相应目录权限。客户端通过 SSH 管理,不需要额外向公网开放管理端口。 + +## 工作区 + +以下截图来自开发预览,**实例、日志和指标均为演示数据**,用于展示布局。 + +![实例概览:服务状态、TPS 和资源指标](../../public/desktop/overview.jpg) + +**概览** 查看服务状态、TPS、在线人数与主机/服务资源。停止状态、零在线人数和缺少采样都可能是正常情况;指标是否新鲜需要结合采样状态判断。 + +![模块管理:模块列表和详情](../../public/desktop/modules.jpg) + +**模块** 查看来源、版本和启用状态。修改后根据任务提示重启 BDS,才会应用需要重新打包的变更。预览版不代表所有独立业务模块都已适配。 + +![配置编辑:配置列表与编辑器](../../public/desktop/config.jpg) + +**配置** 编辑服务和模块配置,保存后根据提示重载或重启相关服务。**控制台** 查看不同服务日志、发送 BDS 命令;**任务** 查看操作进度、失败原因与备份编号。 + +## 建议的首次验收 + +1. 先在独立测试目录完成接入;已有正式部署优先选择 **仅查看**。 +2. 在概览先启动数据服务,再启动 BDS。确认日志没有初始化错误,指标有新采样。 +3. 查看模块与配置,尝试一项可撤销的修改,并确认任务完成。 +4. 关闭客户端后重新打开,确认能连接原守护进程。关闭窗口不会停止服务器;需要停止时在概览明确停止 BDS 和数据服务。 + +预览版本暂不接入稳定版自动更新。后续版本从发行页下载,安装到原客户端目录即可;部署根目录和服务器数据独立于客户端安装目录。 + +## 当前边界 + +- 安装包尚未签名,正式签名版将在证书批准和工作流接入后另行发布。 +- 本机 Windows 与 SSH Windows 的数据服务/BDS、实际指标和断线重连已经验收;其他环境仍需自行验证。 +- 旧活动平台不会自动切换到预览平台。npm 的稳定版号也不能证明它已具备这次预览的全部接口。 +- 游戏内表单点击与独立模块的全部业务流程仍需要 Minecraft 客户端验收。 diff --git a/docs/zh/index.mdx b/docs/zh/index.mdx index c7a29353..263ffc4f 100644 --- a/docs/zh/index.mdx +++ b/docs/zh/index.mdx @@ -17,6 +17,9 @@ hero: link: https://github.com/Tanya7z/sfmc-modules features: + - title: 🖥️ 桌面管理客户端 + details: Windows 桌面管理本机与 SSH 实例,集中查看服务、日志、模块和运行指标。 + link: /guide/desktop - title: ⚡ 原生 SAPI 深度集成 details: 基于 Minecraft 官方 Script API 标准,无需魔改客户端或专用加载器,轻量、稳定且性能卓越。 link: /guide/