# 如何使用

## 前置操作

- 替换所有的`XFEstudio`为您的`主体`，其可以是您个人也可以是公司名称
- 替换所有的`XFE工具箱`为软件的`显示名称`
- 替换所有的`XFEToolBox`为软件的`exe可执行文件名称`
- 将安装包图标放置在`Resources\Icon`目录下，命名为`Icon.ico`
- 将软件本体图标放置在`Resources\Icon`目录下，命名为`Icon.png`

## 将安装器兼更新器放入软件的exe可执行文件目录下

- 执行完前置操作后，点击发布软件，在选择好发布配置（windows平台，独立的）后点击发布
- 将发布后的所有文件全部复制到待您软件的exe可执行文件的目录下，与软件本体共处同一个文件夹

## 将软件压缩包放入安装器

- 将完成上述操作后的软件打包为打包为`Source.zip`文件（请注意，压缩包内应为包含exe的直接目录，而非二级目录），并替换`Resources\Resource`目录下0KB的`Source.zip`文件

## 在线升级协议

- 客户端通过 `XFEExtension.NetCore.UpgradeHelper` 请求 `http://upgrade.api.xfe.studio/upgrade`，升级服务中的应用名固定为 `XFEToolBox`
- 检测到新版本并经用户确认后，客户端以管理员权限调用同目录的 `Installer.exe`
- 调用参数依次为：`Upgrade`、升级压缩包的 HTTP/HTTPS 地址、当前 XFEToolBox 安装目录
- 等价命令：`Installer.exe Upgrade <downloadUrl> <installDirectory>`
- Installer 会将压缩包下载为安装目录下的 `InstallPackage.zip`，解压覆盖完成后删除临时压缩包，并启动 `XFEToolBox.exe`
- 发布升级包时不要增加二级目录；压缩包根目录应直接包含 `XFEToolBox.exe` 及其依赖文件
- 在线升级包不要覆盖正在运行的 `Installer.exe`；Installer 自身需要更新时，应在后续安装包发布流程中单独替换

## 推荐发布流程

1. 先以 `-p:EmbedInstallationPackage=false` 发布一个不内嵌 `Source.zip` 的升级用 Installer。
2. 发布 XFEToolBox 客户端，并把上述 Installer 放入客户端发布目录。
3. 将客户端发布目录根内容压缩为 `Source.zip`，不要增加二级目录。
4. 恢复默认配置发布最终 Installer；默认会把新的 `Source.zip` 内嵌到单文件安装器中。

安装时若目标目录中的 `XFEToolBox.exe` 仍在运行，Installer 会先尝试正常关闭，超时后仅终止路径完全匹配的目标进程；不会按进程名结束其他目录中的同名程序。升级包中若包含正在运行的 Installer 本身，该文件会被跳过，其余应用文件继续安装。