适用于 Nonebot2 的树形帮助插件
Project description
NoneBot Plugin TreeHelp
✨ NoneBot 树形帮助插件 ✨
简介
使用插件元数据获取插件信息,并通过插件与子插件的组织形式,来区分插件的多种功能。
树形帮助插件,最重要的功能当然是显示插件树!
发送 /help --tree
,你将获得如下帮助:
插件:
帮助 # 获取插件帮助信息
测试 # 一个测试插件
├── 复杂功能 # 测试插件复杂子插件
│ └── 二级功能 # 测试插件二级插件
└── 简单功能 # 测试插件简单子插件
使用方式
加载插件后发送 /help help
或 /help --help
获取具体用法。
插件适配
插件与子插件写法可参考 示例插件。
声明适配器
通过设置 adapters 属性来指定支持的适配器。如果不设置或留空则默认支持全部适配器。如果插件不支持该适配器,则不会在帮助列表上显示。
__plugin_meta__ = PluginMetadata(
name="OneBot",
description="测试 OneBot 适配器",
usage="/onebot",
extra={
"adapters": ["OneBot V11"],
},
)
配置项
配置方式:直接在 NoneBot
全局配置文件中添加以下配置项即可。
暂时还没有可配置的东西。
计划
- 支持输出插件版本
- 支持输出插件树
- 支持输出插件内的命令名称
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for nonebot_plugin_treehelp-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3da4841cc5d12971413c5fd53f119535debaaa5837057f3e40f1c8770edbdb17 |
|
MD5 | 350a60eef63d76a5bd657e17e6a9289b |
|
BLAKE2b-256 | aaf80744d3a06ec7b00aa0680c2d27530f0bff067578e94d4ccb10424e8c2679 |
Close
Hashes for nonebot_plugin_treehelp-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd8e29f12ea26507079b93cfa7f9d0ec8b179ed905aaacbf97d972a4bb4b17fa |
|
MD5 | 76bcc769f99962c42fc4d3944432713f |
|
BLAKE2b-256 | d6a535c1c1764b82d47716859e22e29a4af3d69c051298751e275e1b18e18215 |