2021-11-24 10:22:34 +08:00
|
|
|
|
(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{582:function(s,t,n){"use strict";n.r(t);var a=n(8),e=Object(a.a)({},(function(){var s=this,t=s.$createElement,n=s._self._c||t;return n("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[n("h1",{attrs:{id:"真寻bot插件基本标准"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#真寻bot插件基本标准"}},[s._v("#")]),s._v(" 真寻Bot插件基本标准")]),s._v(" "),n("blockquote",[n("p",[s._v("更新于2021/10/13")])]),s._v(" "),n("h2",{attrs:{id:"简介"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#简介"}},[s._v("#")]),s._v(" 简介")]),s._v(" "),n("ul",[n("li",[n("p",[s._v("统一插件标准的好处:")]),s._v(" "),n("ul",[n("li",[s._v("自动生成帮助")]),s._v(" "),n("li",[s._v("自动生成配置项")]),s._v(" "),n("li",[s._v("自动生成插件开关")]),s._v(" "),n("li",[s._v("避免了修改插件单独配置文件的麻烦")])])]),s._v(" "),n("li",[n("p",[s._v("普通插件 应该包含:")]),s._v(" "),n("ul",[n("li",[n("code",[s._v("__zx_plugin_name__")]),s._v(":插件名")]),s._v(" "),n("li",[n("code",[s._v("__plugin_usage")]),s._v(":用法")]),s._v(" "),n("li",[n("code",[s._v("__plugin_des__")]),s._v(":简介")]),s._v(" "),n("li",[n("code",[s._v("__plugin_cmd__")]),s._v(":命令")]),s._v(" "),n("li",[n("code",[s._v("__plugin_settings__")]),s._v(" :插件通用设置")])])]),s._v(" "),n("li",[n("p",[s._v("有主动发送消息的被动插件(不需要命令调用的插件,如定时任务,hook等) 应该包含:")]),s._v(" "),n("ul",[n("li",[n("code",[s._v("__plugin_task__")]),s._v(":为你提供一个或多个开关")])])]),s._v(" "),n("li",[n("p",[s._v("以下作为额外添加选项:")]),s._v(" "),n("ul",[n("li",[n("code",[s._v("__plugin_type__")]),s._v(":插件帮助分类(被动类插件不需要)")]),s._v(" "),n("li",[n("code",[s._v("__plugin_version__")]),s._v(":插件版本")]),s._v(" "),n("li",[n("code",[s._v("__plugin_author__")]),s._v(":插件作者")]),s._v(" "),n("li",[n("code",[s._v("__plugin_cd_limit__")]),s._v(":插件cd限制")]),s._v(" "),n("li",[n("code",[s._v("__plugin_block_limit__")]),s._v(":插件阻塞限制")]),s._v(" "),n("li",[n("code",[s._v("__plugin_count_limit__")]),s._v(": 插件每日调用次数限制")]),s._v(" "),n("li",[n("code",[s._v("__plugin_resources__")]),s._v(": 资源管理")]),s._v(" "),n("li",[n("code",[s._v("__plugin_configs__")]),s._v(": 插件配置")])])])]),s._v(" "),n("h2",{attrs:{id:"zx-plugin-name"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#zx-plugin-name"}},[s._v("#")]),s._v(" __zx_plugin_name__")]),s._v(" "),n("ul",[n("li",[n("strong",[s._v("类型")]),s._v(":"),n("code",[s._v("str")])]),s._v(" "),n("li",[n("strong",[s._v("说明")]),s._v(":"),n("br"),s._v("\n插件名称,为插件普通帮助的展示内容,基本所有模块都必须有 "),n("code",[s._v("__zx_plugin_name__")]),n("br"),s._v("\n通过在__zx_plugin_name__中添加 [Admin] [Superuser] [Hidden] 控制初始化帮助时插件的分类"),n("br"),s._v("\n基本为以下四类:\n"),n("ul",[n("li",[n("code"),s._v(":默认,即没有以下三种分类,作为普通插件")]),s._v(" "),n("li",[n("code",[s._v("[Admin]")]),s._v(": 纯管理员插件")]),s._v(" "),n("li",[n("code",[s._v("[Superuser]")]),s._v(": 纯超级用户插件")]),s._v(" "),n("li",[n("code",[s._v("[Hidden]")]),s._v(": 隐藏的插件,一般是不需要命令调用的插件")])])])]),s._v(" "),n("div",{staticClass:"language-python line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-python"}},[n("code",[s._v("__zx_plugin_name__ "),n("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[s._v('"色图"')]),s._v("\n__zx_plugin_name__ "),n("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[s._v('"管理员操作 [Admin]"')]),s._v("\n__zx_plugin_name__ "),n("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),n("span"
|