Manifest 声明文件
声明文件 manifest.json 是多文件插件的必要文件, 用于描述插件的元信息。
语法
声明文件的语法遵循 JSON 规范,其内容如下:
{
"name": "测试插件",
"version": "1.0.0",
"plugin_id": "easybot_test_plugin",
"author": "MiuxuE",
"description": "这是一个测试插件,用来测试EasyBotV8插件功能",
"tags": ["开发模板"],
"entry": "script.js",
"contents": "# 示例插件\n 这里的内容会被展示到插件详情页,你可以在这里写Markdown文本 。",
"icon": "icon.jpeg",
"links": [
{
"name": "开源地址",
"url": "https://github.com/MiuxuE/EasyBotV8"
},
{
"name": "插件主页",
"url": "https://github.com/MiuxuE/EasyBotV8"
}
]
}
字段说明
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 插件名称 |
version | string | 是 | 版本号 |
plugin_id | string | 是 | 插件ID、不可重复、唯一、只能由a-z小写英文字母和下划线组成 |
author | string | 是 | 作者 |
description | string | 否 | 插件描述、显示在卡片中 |
tags | string[] | 否 | 标签 |
entry | string | 是 | 入口文件路径、必须是相对路径且文件后缀为.js |
contents | string | 否 | 插件主要内容,会显示在插件详情页,支持Markdown |
icon | string | 否 | 插件图标路径,支持本地图片文件(如 .jpeg, .png) |
links | Link[] | 否 | 链接、会显示在插件详情页 |
Link 对象
| 字段名 | 类型 | 说明 |
|---|---|---|
name | string | 名称 |
url | string | 地址 |
示例
基础插件
{
"name": "动态表单测试插件",
"version": "1.0.0",
"plugin_id": "easybot_test_forms",
"author": "MiuxuE",
"description": "这是一个测试插件,用来测试Forms功能",
"tags": ["开发模板"],
"entry": "script.js"
}
带图标和自定义渲染的插件
{
"name": "自定义网页渲染",
"version": "1.0.0",
"plugin_id": "my_puppeteer_renderer",
"author": "MiuxuE",
"description": "指定一个地址 可以查看网页内容",
"tags": ["消息修改"],
"entry": "script.js",
"contents": "# 插件说明",
"icon": "icon.jpeg"
}
遇到麻烦了?
我们提供有偿代安装服务,解决您的环境配置烦恼。