Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Resource_Mod

Shirasawa edited this page Nov 2, 2019 · 7 revisions

资源对象 - 模组

建议 json 文件的命名为: 模组名字-模组版本.json (如 mod1-1.0.0.json)

{
  "type": "mod",
  "id": "<id>",
  "version": "<version>",
  "urls": [...<urls>],
  "title": "<title>",
  "author": "<author>",
  "source": "<source>",
  "website": "<website>",
  "mcVersion": "<mcVersion>",
  "api": <api>,
  "hashes": [...<hashes>],
  "extends": <extends>,
  "updateUrl": "<updateUrl>"
}

参数

id (模组的唯一ID)

类型: 字符串

由作者填写的, 保证不会发生重复的模组ID, 建议为模组的包名

version (模组版本)

类型: 字符串

模组的当前版本号, 一定要符合 语义化版本 规则

urls (模组的下载地址)

类型: 字符串数组

必须填写直链!

mcVersion (支持的MC版本) - 可选, 建议填写

类型: 符合 语义化版本 规则的MC版本

title (标题) - 可选

类型: 字符串

模组的名字

author (作者名) - 可选

类型: 字符串

作者的ID

source (当前json的绝对网络地址) - 可选

类型: 字符串

能访问到当前json的地址, 请不要填写动态生成的地址以便第二次可以访问到

website (作者填写的模组官网) - 可选

类型: 字符串

用于模组分享和推广

api (需要的API) - 可选

类型: 对象

{
  "forge": false,
  "fabric": "https://fabricmc.org",
  ...
}

如果需要某个API支持, 请填写 "API名字": "API的安装页面 (官网)

hashes (文件的哈希值) - 可选

类型: 字符串数组

如果需要校验下载到的文件是否完整请填写文件的 md5

extends (前置模组) - 可选

类型: 对象

{
  "mod1": "https://example.com/mod1-0.1.0.json",
  ...
}

如果依赖了前置模组, 请填写 "前置模组ID": "前置模组的网络对象(json)访问地址"

当然, 也可以直接填写模组对象

updateUrl (检查更新的地址) - 可选

类型: 字符串

填写的地址指向的json文件格式与本文件格式一致, 只是模组版本, 下载地址和哈希值*(如果有)*不同

建议json文件命名为: 模组ID-支持的MC版本-latest.json (如mod1-1.14.x-latest.json)

每次启动之前都会对模组进行更新检查, 如果发现了版本有新的就进行下载和安装

Clone this wiki locally