跳到主要内容

发布与安装

软件包要在他人机器上被搜索、安装,需要先在服务端登记(发布) 一次。本页说明发布、 安装、更新与本地调试的完整流程。

发布(登记)​

发布就是把「软件包全名」与「Git 仓库地址」登记到服务端,供其他人安装时解析。

  1. 登录账号,并在「个人信息」中设置昵称。
  2. 打开用户中心的「发布软件包」,填写:
    • 软件包名称:不能包含 @;
    • 仓库地址:你的 Git 仓库地址,例如 github.com/user/repo;
    • 描述:一句话简介。
  3. 点击「发布」。

发布成功后,全名自动生成为 昵称@软件包名称。例如昵称为 黑猫、名称为 装备打造, 全名就是 黑猫@装备打造。

注意

全名必须与你仓库内 .hm.json 的 作者@名称 以及安装后的目录名一致, 否则依赖注入和 require 会找不到模块。详见 仓库与版本约定。

安装​

其他用户在你的软件包发布后,即可通过客户端安装:

  1. 在客户端点击「添加软件包」,搜索软件包名称。
  2. 选择要安装的版本(来自仓库的 tag)。
  3. 点击「安装」。

安装过程会:

  • 根据全名从服务端解析仓库地址;
  • 拉取所选 tag 的代码;
  • 将内容复制到 apps/<全名>/;
  • 递归安装 依赖软件包 中声明的依赖。

安装完成后,任务即可在列表中出现(类型 为 任务 时)。

备注

若任务列表中的版本按钮出现红色小箭头,说明远端有比你当前更新的 tag,可以点开切换版本。

更新版本​

发布新版本不需要重新「发布」登记信息,只要在仓库打新的 tag 并推送即可:

git commit -am "feat: 优化逻辑"
git push
git tag v1.2
git push origin v1.2

用户回到任务面板,点击版本按钮选择新版本安装即可。

本地开发与调试​

开发阶段不需要发布,直接在助手的 apps/ 目录下创建文件夹即可:

apps/黑猫@我的任务/

调试技巧:

  • 修改 Lua 后,点击任务面板上的「重载」重新加载 UI 服务,无需重启助手。
  • 修改了任务运行逻辑(index.lua)后,停止并重新启动任务即可生效。
  • 运行日志可用 GoPrint(...) 输出,服务器日志与前端日志面板都能看到。

确认功能稳定、准备好分享时,再按照 仓库与版本约定 打 tag 并发布。

删除发布​

在用户中心的已发布列表中,可以删除自己的软件包登记。删除后其他人将无法再通过搜索安装, 但已经安装到本地的副本不受影响。