黄兆尉andCursor
3686abdc78
配置段/环境变量、Launcher、健康检查 API、OpenAPI 与前后端文案同步；兼容探测旧 SimpleLite 进程名。 Co-authored-by: Cursor <cursoragent@cursor.com>
71 lines
4.1 KiB
C#
71 lines
4.1 KiB
C#
namespace MiGu.Server.Launcher;
|
||
|
||
/// <summary>
|
||
/// MiGu.Server 启动后由「平台登录」按 LaunchMode 拉起的 Simple3 子进程配置。
|
||
///
|
||
/// 会话 N+1（启动反转）：原架构是 Simple3 启动 → 拉 MiGu.Server；现在反过来：
|
||
/// MiGu.Server 作为主入口启动 → 登录页选 LaunchMode → 后端拉起 Simple3.exe，
|
||
/// 通过 <c>--display-mode</c> 参数把 web / web+local 透传给 Simple3 的 Configuration。
|
||
///
|
||
/// 绑定 <c>appsettings.json:Simple3</c>。
|
||
/// </summary>
|
||
public sealed class Simple3Options
|
||
{
|
||
/// <summary>主开关。false = 永不拉起；登录无论选什么 LaunchMode 都不会启动子进程，用于「只跑 Platform 调试」场景。</summary>
|
||
public bool Enabled { get; set; } = true;
|
||
|
||
/// <summary>
|
||
/// Simple3 可执行文件绝对/相对路径（相对 MiGu.Server 工作目录）。留空则按以下顺序自动探测：
|
||
/// 1) <c>./Simple3.exe</c>（合并发布布局；仍兼容探测旧名 <c>./SimpleLite.exe</c>）
|
||
/// 2) <c>./Simple3/Simple3.exe</c>
|
||
/// 3) 开发态：兄弟仓库 <c>../Simple/Simple3/</c> 产出目录或 <c>bin/Debug|Release</c>
|
||
/// 4) 发布目录常见布局：<c>D:\MDCS\Release\Simple\Simple3\Simple3.exe</c>（仅当该绝对路径存在）
|
||
/// 5) 沿父目录上行寻找 Simple3 产出
|
||
/// </summary>
|
||
public string ExecutablePath { get; set; } = "";
|
||
|
||
/// <summary>留空时取 <see cref="ExecutablePath"/> 所在目录。内核在 CWD 读写 simple.json / imgui.ini，CWD 选错会出意外。</summary>
|
||
public string WorkingDirectory { get; set; } = "";
|
||
|
||
/// <summary>附加命令行参数（拼在 <c>--display-mode=xxx</c> 之后）。常用于本地调试时强制 autoload 某场景。</summary>
|
||
public string Arguments { get; set; } = "";
|
||
|
||
/// <summary>
|
||
/// 子进程启动后阻塞等待 Projection (:8222) 端口就绪的最长毫秒数。
|
||
/// 0 = 不等待（登录立即返回，前端可能还连不上 Simple3 WebApi）；
|
||
/// 负值 = 无限等待（直到子进程退出或就绪）。
|
||
/// </summary>
|
||
public int ReadinessTimeoutMs { get; set; } = 8000;
|
||
|
||
/// <summary>每隔多少毫秒 poll 一次 Projection 端口可达性。</summary>
|
||
public int ReadinessPollIntervalMs { get; set; } = 250;
|
||
|
||
/// <summary>Simple3 Projection WebApi 监听端口。默认与 Simple3 Configuration 的 `port` 一致。用于就绪检测。</summary>
|
||
public int ProjectionPort { get; set; } = 8222;
|
||
|
||
/// <summary>
|
||
/// 是否把 Simple3 绑定到 MiGu.Server 生命周期，默认 <b>false</b>（会话 N+2 用户反馈）。
|
||
///
|
||
/// 设计原则：Simple3 与 MiGu.Server 是「两个独立程序」，Platform 只是登录后顺手拉起 Simple3；
|
||
/// MiGu.Server 关闭不应该带走 Simple3，反之亦然。所以 FollowParent 默认 false：
|
||
/// - 子进程走 <c>UseShellExecute=true</c> 创建独立进程组 + 独立控制台窗口；
|
||
/// - 不挂 JobObject，不在 ApplicationStopping / ProcessExit 时 kill 子进程；
|
||
/// - Simple3 退出由用户自己负责（关窗口 / 任务管理器 / 调度内核异常退出）。
|
||
///
|
||
/// true 仍可用：会启动 Windows JobObject 父子绑定（仅 Windows 有效）+ 注册 ApplicationStopping 软关闭。
|
||
/// 一般只在临时联调期 / CI 流水线想自动清理时打开。
|
||
/// </summary>
|
||
public bool FollowParent { get; set; } = false;
|
||
|
||
/// <summary>
|
||
/// 平台拉起 Simple3 时是否以「迷榖嵌入画布」模式运行（透传命令行 <c>--migu</c>），默认 <b>true</b>。
|
||
///
|
||
/// true：平台 iframe 嵌入场景，Simple3 WebTerminal 默认只显示 3D 画布、隐藏所有 ImGui panel，
|
||
/// 业务 UI 全部由 Vue 平台前端接管；declare 时序失败时也安全回退到纯画布。
|
||
/// false：平台拉起的 Simple3 web 端默认显示完整 panel（便于把平台拉起的实例直连 :8223 调试）。
|
||
///
|
||
/// 与 LaunchMode（web / web+local，是否保留本地调试窗口）正交，可任意组合。
|
||
/// </summary>
|
||
public bool EmbeddedCanvas { get; set; } = true;
|
||
}
|