适用于 Nonebot2 的树形帮助插件
Project description
NoneBot Plugin TreeHelp
✨ NoneBot 树形帮助插件 ✨
简介
使用插件元数据获取插件信息,并通过插件与子插件的组织形式,来区分插件的多种功能。
树形帮助插件,最重要的功能当然是显示插件树!
发送 /help --tree
,你将获得如下帮助:
插件:
帮助 # 获取插件帮助信息
测试 # 一个测试插件
├── 复杂功能 # 测试插件复杂子插件
│ └── 二级功能 # 测试插件二级插件
└── 简单功能 # 测试插件简单子插件
使用方式
加载插件后发送 /help help
或 /help --help
获取具体用法。
插件适配
插件与子插件写法可参考 示例插件。
声明适配器
通过设置 adapters 属性来指定支持的适配器。如果不设置或留空则默认支持全部适配器。如果插件不支持该适配器,则不会在帮助列表上显示。
__plugin_meta__ = PluginMetadata(
name="OneBot",
description="测试 OneBot 适配器",
usage="/onebot",
type="application",
supported_adapters={"~onebot.v11", "~onebot.v12"},
)
配置项
配置方式:直接在 NoneBot
全局配置文件中添加以下配置项即可。
treehelp_ignored_plugins
- 类型:
list[str]
- 默认:
[]
- 说明: 需要忽略的插件名称列表
计划
- 支持输出插件版本
- 支持输出插件树
- 支持输出插件内的命令名称
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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a60713fc9a0ffb5fa547fdf4b3b634faef7242e3b4a7af435118d676ca7de723 |
|
MD5 | ada885f7f4ecd83b7a45475c4e3ef362 |
|
BLAKE2b-256 | 3e7e370eef7aa5d354a3e4000f8189461d8f5aac282b2115269f04b3c0121ecb |
Close
Hashes for nonebot_plugin_treehelp-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfa3f2464fcd02cd654a5e4d03c42699b4794aa20907b9414104e88e985870e4 |
|
MD5 | bb876a44bfac945e90b8fbc6ebbcb3b4 |
|
BLAKE2b-256 | 8b84c98f9eec118920ab2d2d598174d11c19733fc9ff3f94c4a63431d3bdf791 |