Skip to content

Latest commit

 

History

History
111 lines (66 loc) · 3.03 KB

meta.md

File metadata and controls

111 lines (66 loc) · 3.03 KB

元信息

元信息决定了 MCBBS Loader 如何显示你的模块。

元信息支持任何键值对,键不能有空格。

如果需要跨行书写元信息,需要在行末添加反斜杠\

<键>=<值> 即可定义元信息。 等号前后可以有空格。

元信息的第一行必须是 /* MCBBS Module,最后一行必须是 */,其它信息一行一个夹在中间。

目前 MCBBS Loader 只识别如下元信息(所有其它的信息仍旧被存储,但不使用):

id

必填项,模块唯一识别 ID,建议用包名命名,参考杂项篇目。

示例:

id=com.example.examplemodule

icon

指定图标,填写 URL 。

示例:

icon=https://github.com/favicon.ico
icon=data:image/png;base64,/9j/4AAQSk(后略)

description

一段简短的描述,可以使用 HTML。[1]

示例:

description=一个<b>加粗</b>的模块。

name

模块的名字,可以使用 HTML。[1]

author

作者的名字,可以使用 HTML。[1]

version

版本号,更新时使用,只能使用数字表示。

示例:

version=12
version=5.9.23
version=233.344.455.566.677

updateURL

更新 URL,每次脚本加载时会检查一次更新,该 URL 应该指向新的脚本的位置。你可以每次固定将脚本发布到同一个位置。

现在不需要这个元数据了,因为loader会从gid检索更新。

示例:

updateURL=https://cdn.jsdelivr.net/gh/MCBBS-Loader/MCBBS-RunJS@main/main.js
不要使用 jsDelivr 的压缩服务,它会移除元信息!

depend

检查依赖关系,可以指定多个依赖项,中间用英文逗号分割,如果依赖项未安装或者未启用,则部分模块不能加载。

指定依赖项的时候,使用模块的ID。当有gid时,可以自动补全依赖的脚本。

格式为 <依赖项>[ -> <下载地址/GID>]

before

拥有此属性的脚本会在所有指定的脚本之前运行,如果指定的脚本未安装将被忽略,如果没有任何符合要求的加载顺序解法,只能保证部分模块[2]能够加载。

after

和before基本一样,但是脚本会在指定项之后加载。

permissions

特殊权限列表 loader:core用于加载需要高权限的脚本。 loader:earlyload用于需要在加载早期运行的脚本,比Extender的所有逻辑、MCBBS自身的脚本和LoaderCore的大部分逻辑都要早。 loader:settop在所在的软件源中置顶,它在软件源构建阶段被处理完毕,在运行期间不会被解析。

gid

当脚本不是用gid安装时的备用gid

目前只有这些元信息被识别,未来可能会有更多的信息。


  1. 禁止使用JavaScript、JavaApplet、Flash,LoaderCore会视情况移除这些可执行内容。
  2. 如果一个模块不能加载,则所有要求在这个模块加载后加载的模块都不能加载。