跳到主要内容

软件包清单 .hm.json

每个软件包根目录下都必须有一份 .hm.json 文件，用于描述软件包的元信息。 文件内容是一段 JSON（可以带 BOM/缩进，助手解析时会忽略）。

字段一览​

字段类型必填说明
名称string✅软件包名称，不能为空，界面与日志中展示的就是它
作者string作者名，会展示在任务列表中
类型string"任务" 或 "函数库"；只有 任务 会出现在任务列表
隐藏boolean为 true 时即使是任务也不在列表中显示
版本string版本号，例如 v1.0；建议与 Git tag 保持一致
简介string一句话描述
仓库地址stringGit 仓库地址，用于界面上「打开仓库」按钮
依赖软件包object依赖的软件包，键为全名，值为版本，例如 { "黑猫@基础库": "v1.0" }

任务示例​

apps/黑猫@挂机打怪/.hm.json
{
  "名称": "挂机打怪",
  "版本": "v1.0",
  "类型": "任务",
  "简介": "挂机打怪",
  "仓库地址": "https://gitee.com/zaijianlixiang1995/hm_kill_monster",
  "依赖软件包": {
    "黑猫@基础库": "v1.0"
  }
}

函数库示例​

apps/黑猫@基础库/.hm.json
{
  "名称": "基础库",
  "作者": "黑猫",
  "版本": "v1.0",
  "类型": "函数库",
  "简介": "基础库",
  "仓库地址": "https://gitee.com/zaijianlixiang1995/hm_basic_library",
  "依赖软件包": {}
}

字段详解​

名称 / 作者​

名称 必填。作者 与 名称 共同构成软件包的全名 作者@名称，也就是它在 apps/ 下的目录名。 建议三者保持一致，例如 作者 = "黑猫"、名称 = "基础库"、目录名 = 黑猫@基础库。

类型​

  • "任务"：可启动的功能，入口是 index.lua，可以带 ui/ 界面。
  • "函数库"：供他人 require 或注入，不单独启动。

未填写时，该软件包不会出现在任务列表中。

隐藏​

用于开发中的「半成品任务」或内部工具，不想让用户直接看到时设为 true。

版本​

仅作展示。真正用于安装的版本号来自 Git 仓库的 tag，因此发布新版本时请打 tag， 并把 .hm.json 的 版本 同步更新（详见 发布与安装）。

依赖软件包​

声明本软件包运行/安装所需的其他软件包。键是全名，值是版本（tag）。

声明依赖会带来两件事：

  1. 安装：安装本软件包时，助手会递归安装所有依赖。
  2. 注入：依赖（函数库）的 inject/ 脚本会被注入到游戏客户端。
提示

依赖的版本值是 Git tag 名，例如 "v1.0"。请确保依赖仓库上存在该 tag。

仓库地址​

会展示在任务列表对应任务的「打开仓库」按钮上。对外的软件包还必须在服务端 登记（发布） 一次，安装时才能根据全名解析到仓库地址。详见 发布与安装。

下一步：运行机制。