配置 info.json

info.json 文件是一个 json 文件,用于描述插件的元信息,由以下字段组成。

字段类型是否必须说明
identifierstring插件的唯一标识符,必须由数字、小写字母和 . 组成。
versionstring插件版本号,必须由数字、小写字母和 . 组成。
categorystring插件类别,值只可以是 translateocrtts,分别对应文本翻译、文本识别和语音合成。
namestring插件名称,无限制,建议别太长。
summarystring-插件描述信息。
iconstring-插件图标标识符,如果插件根目录有 icon.png 文件,则会将其作为插件图标,不会读取该字段;如果没有,会读取该字段,值可以为 这个图标列表 中所包含的任意一个ID。
authorstring-插件作者。
homepagestring-插件主页网址。
appcaststring-插件发布信息 URL。详情见 发布插件
minBobVersionstring-最低支持本插件的 Bob 版本,建议填写你开发插件时候的 Bob 版本,目前应该是 0.5.0
optionsarray-插件选项数组,该字段用于提供一些选项供用户选择或填写,详情见 option object

option object

字段类型是否必须说明
identifierstring选项唯一标识符,取值时使用。
typestring选项类型,值只可以是 textmenu,分别对应输入框和菜单。
titlestring选项名称,用于展示。
defaultValuestring-默认值。
menuValuesarraytype 为 menu 时必须有菜单选项数组,详情见 menu object
descstring-用于详细描述这个选项的作用。
字段类型是否必须说明
titlestring菜单选项名称,用于展示。
valuestring当前菜单被选中时的值。

示例

{
    "identifier": "com.ripperhe.translate.test",
    "version": "0.1.0",
    "category": "translate",
    "name": "测试插件",
    "summary": "这是一个用于测试的插件。",
    "icon": "001",
    "author": "ripperhe",
    "homepage": "https://github.com",
    "appcast": "https://raw.githubusercontent.com/xxxx/xxxx/master/appcast.json",
    "minBobVersion": "0.5.0",
    "options": [
        {
            "identifier": "option1",
            "type": "text",
            "title": "测试输入框"
        },
        {
            "identifier": "option2",
            "type": "menu",
            "title": "测试菜单",
            "defaultValue": "1",
            "menuValues": [
                {
                    "title": "菜单1",
                    "value": "1"
                },
                {
                    "title": "菜单2",
                    "value": "2"
                }
            ]
        }
    ]
}

由于以上 json 设置了 options 字段,所以使用该插件时可以看到设置项,如下所示:

plugin-option-1

menu 类型的展开效果如下:

plugin-option-2

用户在这里设置之后,插件内部可以根据相应 option objectidentifier 取值,具体请查看 $option 相关文章。

上次更新: