Files
msime-windows/installer
fanlusky a7779d2b05 refactor(engine): 将 engine 从 submodule 内嵌为仓内一等组件
`vendor/MetasequoiaImeEngine` submodule 改为 `engine/` 目录,导入的是
product-lock.json 原本钉住的提交 c810d201,逐文件核对过 blob,因此这是一次
搬迁而不是引擎升级。引擎自己的嵌套 submodule(googlepinyinime-rev、utfcpp、
miniaudio)按各自 gitlink 一并展开,来源与提交见 engine/UPSTREAM.md。

Windows 专门化裁掉了不属于本产品的部分:whisper.cpp 与本地推理 provider、
macOS 示例宿主、整个 dictionary/ 建库流水线、上游 CI 与 release-please 配置。
词库仍按 product-lock.json 在构建时取发布产物。

引擎不再进 product-lock.json:没有 gitlink 就没有可比对的东西,锁里写一个上游
commit 等于宣称这棵树仍等于上游,而第一个 Windows 专门化改动落地时这句话就假了。
verify-contracts / verify-checkout 随之移除,verify-published 保留。

CI 与工具链:引擎源码并入根 scripts/format.sh(删掉引擎自己的那份,避免两套排除
列表分叉);引擎 voice.yml 里的 silero_vad.onnx 摘要校验移到本仓 lock job;
engine-bump-triage 工作流与其测试删除;gitsubmodule 的 dependabot 频率由 daily
改为 monthly。

README、README.en、AGENTS.md、CONTRIBUTING、docs/product-release.md 及各子目录
文档同步说明新的位置与边界。
2026-09-12 03:40:48 +08:00
..

Metasequoia IME Installer

本目录的脚本从 Windows 合仓目录收集产物、签名、用 Inno Setup 打成安装包。它服务两条流程:

  • 正式发布:由 MSIME-Windows 的 release workflow 驱动,用真实证书签名 MetasequoiaImeServer.exe(保证 uiAccess 生效)和最终安装包;产物是挂在 Release 上的 MetasequoiaIME_Setup_v<版本>.exe,并携带与 Release 二进制匹配的 PDB 符号文件。见下面「CI 契约」
  • 本地测试:手工跑,用本机自签名证书,用来在自己机器上验证安装流程。本文其余部分讲的是这条

版本号不是固定的,由 Prepare-PackageFiles.ps1 的 -TargetVersion 决定,默认 0.0.1;正式发布时 CI 传入真实版本。

本仓库 不包含 正式代码签名证书、私钥、指纹,也不包含编译好的 EXE/DLL、词库或安装包。

签名脚本会在你自己的机器上生成并复用一张自签名测试证书。

CI 契约

根 .github/workflows/release.yml 不加修改地调用本目录的 Prepare-PackageFiles.ps1 和 Compile-Installer.ps1。源目录名是 Prepare-PackageFiles.ps1 的参数,不是写死在脚本里的字面量:默认值为 windows/、server/、ui-html/ 和仓根授权文件;旧目录或自定义布局通过参数覆盖。回归检查同时执行默认路径和显式参数的打包。辅助码默认读取 engine/helpcode/,词库缓存位于 MetasequoiaImeDict/out/。

合仓后 release workflow 传的是本仓的目录名,辅助码随固定 Engine gitlink 检出,词库按产品锁下载到仓根缓存:

pwsh -File ./Prepare-PackageFiles.ps1 -TargetVersion 1.2.3 -RepoRoot .. `
    -TsfDirectory windows -ServerDirectory server `
    -UiHtmlDirectory ui-html -NoticesDirectory .

由此产生几条约束:

  • 改动 Prepare-PackageFiles.ps1 里那些 Assert-PathExists 的源路径,会直接弄坏发布流水线。 它断言的源路径由 workflow 逐一准备,改了要同步改 .github/workflows/release.yml。目录名本身可以由调用方指定,但每个目录内部的相对路径(如 build-release\bin\Release)仍是硬契约
  • THIRD_PARTY_NOTICES.txt 从 -NoticesDirectory 指向的目录取,随安装包装到程序目录。 合仓后这份声明覆盖整个产品、放在仓根,所以它和 -TsfDirectory 分成了两个参数。词库主体含 rime-ice(GPL-3.0)内容,其许可要求保留署名,所以这份文件缺失会让打包直接失败,而不是静默跳过
  • Sign-PackageBinaries-Local.ps1 和 Sign-Installer-Local.ps1 只用于本地验证,CI 不会调用它们。 它们创建本机自签名证书并尝试写入受信任存储,正式发布走 workflow 里用仓库 secret 中真实证书的签名步骤
  • 词库不再从相邻的 MetasequoiaImeDict 工作目录取,CI 从产品锁指定的 dict-* release 下载并校验 SHA256,再放到脚本期望的位置
  • windows-2025 runner 自带 Inno Setup 6.7.1,Compile-Installer.ps1 能自己找到 ISCC.exe。但它不带 ChineseSimplified.isl,msime_setup.iss 的 [Languages] 段依赖那个文件,所以 workflow 会在编译前按固定 revision 和校验和把它装进去

依赖

  • Windows 10/11,PowerShell 7(pwsh)
  • Inno Setup 6.6 或更高版本
  • Windows SDK(提供 signtool.exe)
  • 先初始化本仓 submodule,并完成 windows/、server/ 的 Release 编译以及 ui-html/ 设置页构建。Release 构建必须生成同目录 PDB;打包脚本会拒绝缺少匹配符号的产物。
  • 在仓库根目录运行 python scripts/product_lock.py fetch-dictionaries --staging-root .,下载并验证产品锁中的词库。
  • engine/helpcode/helpcodes/ 是本仓的目录,普通检出即有,无需旧 HelpCode 仓库,也无需初始化 submodule。

本地打包路径

从 installer/ 运行上面的带参数打包命令即可。-RepoRoot 指向 MSIME-Windows 根目录;目录不同时通过参数指定,无需编辑脚本中的复制路径。

一键测试

先准备上述构建依赖与锁定词库。然后在管理员 PowerShell 中(把本机测试证书写入受信任存储需要提升权限):

cd path\to\MSIME-Windows\installer
pwsh -File .\test.ps1

test.ps1 会按顺序做这些事:

  1. 编译本仓 TSF、Server,并构建设置页;缺少组件入口则失败
  2. Prepare-PackageFiles.ps1 — 收集 server_exe\、tsf_dll\、app_data\ 及匹配的 PDB,并把 msime_setup.iss 的版本写成 0.0.1
  3. Sign-PackageBinaries-Local.ps1 — 本机自签名包内 EXE/DLL
  4. Compile-Installer.ps1 — 编译出 Output\MetasequoiaIME_Setup_v0.0.1.exe
  5. Sign-Installer-Local.ps1 — 本机自签名安装包
  6. Install.ps1 — 启动安装程序

也可以按上面的顺序逐步运行。

本机测试证书

第一次运行签名脚本时,会在当前用户证书存储里创建:

CN=Metasequoia IME Local Test Code Signing

之后复用同一张证书。产物只适合本机或已导入该证书公钥的测试机,不要当作正式分发包。

想让另一台测试机信任这张证书,把公钥导出成 .cer 后在那台机器上执行:

certutil -addstore Root MetasequoiaImeLocalTest.cer
certutil -addstore TrustedPublisher MetasequoiaImeLocalTest.cer

不要把 .cer / .pfx 提交进本仓库。