https://github.com/he0119/nonebot-plugin-treehelp
NoneBot 树形帮助插件
https://github.com/he0119/nonebot-plugin-treehelp
nonebot2 plugin python
Last synced: over 1 year ago
JSON representation
NoneBot 树形帮助插件
- Host: GitHub
- URL: https://github.com/he0119/nonebot-plugin-treehelp
- Owner: he0119
- License: mit
- Created: 2022-07-02T12:57:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T22:43:37.000Z (over 1 year ago)
- Last Synced: 2025-03-16T07:51:08.910Z (over 1 year ago)
- Topics: nonebot2, plugin, python
- Language: Python
- Homepage:
- Size: 363 KB
- Stars: 19
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NoneBot Plugin TreeHelp
_✨ NoneBot 树形帮助插件 ✨_
## 简介
使用插件元数据获取插件信息，并通过插件与子插件的组织形式，来区分插件的多种功能。
树形帮助插件，最重要的功能当然是显示插件树！
发送 `/help --tree`，你将获得如下帮助：
```text
插件：
帮助 # 获取插件帮助信息
测试 # 一个测试插件
├── 复杂功能 # 测试插件复杂子插件
│ └── 二级功能 # 测试插件二级插件
└── 简单功能 # 测试插件简单子插件
```
## 使用方式
加载插件后发送 `/help help` 或 `/help --help` 获取具体用法。
## 插件适配
插件与子插件写法可参考 [示例插件](./tests/plugins/tree/)。
### 声明适配器
通过设置 adapters 属性来指定支持的适配器。如果不设置或留空则默认支持全部适配器。如果插件不支持该适配器，则不会在帮助列表上显示。
```python
__plugin_meta__ = PluginMetadata(
name="OneBot",
description="测试 OneBot 适配器",
usage="/onebot",
type="application",
supported_adapters={"~onebot.v11", "~onebot.v12"},
)
```
## 配置项
配置方式：直接在 `NoneBot` 全局配置文件中添加以下配置项即可。
### treehelp_ignored_plugins
- 类型: `list[str]`
- 默认: `[]`
- 说明: 需要忽略的插件名称列表
## 计划
- [ ] 支持输出插件版本
- [x] 支持输出插件树
- [ ] 支持输出插件内的命令名称