插件标准

真宵机器人使用 nonebot 自带的 PluginMetadata 传递插件信息

name

• 类型: str
• 说明: 插件名,默认为插件文件夹名

description

• 类型: str
• 说明: 插件简介,默认为空

usage

• 类型: str
• 说明: 插件使用方法,默认为空

extra

• 类型: dict
• 说明: 附加属性,默认值见下

generate_type

• 类型: str
• 说明: 配置生成类型
• 可选项:
  • group: 配置分群
  • single: 配置不分群
  • general: 只生成通用配置
  • none: 不生成配置,默认为此项

permission_common

• 类型: str
• 说明: 插件正常模式权限,默认 member,有关权限说明请前往权限系统,私聊插件该项无效

unset

• 类型: bool
• 说明: 插件是否为不可控制插件,即无法通过插件控制开关,默认为 False,私聊插件该项无效

total_unable

• 类型: bool
• 说明: 插件是否为不统计插件,即不被统计使用次数,默认为False,私聊插件该项无效

version

• 类型: str
• 说明: 插件版本,默认为空

author

• 类型: str
• 说明: 插件作者,默认为空

translate

• 类型: str
• 说明: 插件中文名,默认为插件名

permission_special

• 类型: dict
• 说明: 插件特殊权限,插件名:matcher名称作为键,权限作为值,插件名:matcher名称并不是硬性要求,这么写只是为了防止不同插件冲突,可以根据特殊权限控制的写法自定,需注册Matcher控制,详见Matcher级别控制,私聊插件该项无效
• 示例:

"permission_special": {
    "matcher名称": "权限",
    ...
} 

cd

• 类型: dict
• 说明: cd配置项,支持Plugin级别和Matcher级别控制,Matcher级别控制需注册Matcher控制,详见Matcher控制,有两种写法,私聊插件该项无效
  • 完整写法
    完整写法允许进行Matcher级别的控制

    "cd": {
      # Plugin级别
      "plugin": {
        "count": 次数,
        "time": 时间,
        "ban_time": 禁言时间
      },
      # Matcher级别
      "matcher": {
        "插件名:matcher名称": {
          "count": 次数,
          "time": 时间,
          "ban_time": 禁言时间
        },...
      }
    }
    

  • 缩略写法
    缩略写法中的配置全部识别为Plugin级别

    # Plugin级别
    {
      "count": 次数,
      "time": 时间,
      "ban_time": 禁言时间
    }
    

• 补充:
  • 时间单位均为秒
  • 当 count time ban_time 任意一项小于等于0时, 视为关闭cd
  • count time ban_time 任意一项都可为空, 默认值分别为 5 10 300

configs

• 类型: dict
• 说明: 插件的配置信息,使用json存储配置文件,有两种写法,两种写法可以混用
  • "配置项": "配置值"
  • "配置文件路径": { "配置项": "配置值", ... }
• 补充:
  • 配置文件路径不需要绝对路径,配置文件根路径是在 config/插件名 下的,只需相对配置文件根路径即可
  • group类型的插件在配置文件路径中可以使用 {{gid}} 代替群号,当然也可以在调用时自己拼接

configs_general

• 类型: 类型
• 说明: 插件的调用配置信息,键为配置项,值为配置值

"configs_general": {
    "key1": "value1"
}

配置示例

from nonebot.plugin import PluginMetadata

__plugin_meta__ = PluginMetadata(
    name="example",
    description="This is a example",
    usage="/example",
    extra={
        "generate_type": "group",
        "permission_common": "member",
        "unset": False,
        "total_unable": True,
        "version": "0.0.1",
        "author": "Shine_Light",
        "translate": "示例",
        "permission_special": {
            "matcher_1": "admin",
            "matcher_2": "Van"
        },
        "configs": {
            "/{{gid}}/template/config.json": {
              "key1": "value1"
            },
            "key2": "value2"
        },
        "configs_general": {
          "key_G": "value_G"
        }
    }
)