A general help lister for nonebot2 plugins
Project description
开发者接入此插件列表方法
您可以直接参考本插件的接入方式,阅读源代码即可!
插件级别元数据接入
使用自 Nonebot 2.0.0-beta.4 版本起新增的插件元数据进行插件级统一接入(不包含Matcher级别接入)
# New way of self registering (use PluginMetadata)
__plugin_meta__ = nonebot.plugin.PluginMetadata(
name='您的插件名称(有别于nonebot-plugin-xxx的包名)',
description='您的简单插件描述',
usage='''您想在使用命令/help <your plugin package name>时提供的帮助文本''',
extra={'version': '0.3.1'}
)
插件级别传统接入
使用python包形态的插件(已发布/自行开发皆可),并在插件包的__init__.py文件内增加如下代码:
# 您的插件版本号,将在/help list中显示
# Deprecated for nonebot-plugin-help 0.3.1+, prefer PluginMetadata.extra['version']
__help_version__ = '0.3.1'
# 此名称有助于美化您的插件在/help list中的显示
# 但使用/help xxx查询插件用途时仍必须使用包名
# Deprecated for nonebot-plugin-help 0.3.0+, prefer PluginMetadata.name
__help_plugin_name__ = "您的插件名称(有别于nonebot-plugin-xxx的包名)"
# Deprecated for nonebot-plugin-help 0.3.0+, prefer PluginMetadata.usage
# 若此文本不存在,将显示包的__doc__
__usage__ = '您想在使用命令/help <your plugin package name>时提供的帮助文本'
Matcher级别接入
Matcher级别帮助请为Matcher添加如下代码:
default_start = list(nonebot.get_driver().config.command_start)[0]
helper = on_command("help", priority=1, aliases={"帮助"})
helper.__help_name__ = '您的命令触发指令名'
helper.__help_info__ = '您为此命令提供的帮助文本'
helper.__doc__ = '您为此命令提供的帮助文本, 当您不希望使用__help_info__提供时,可以使用__doc__提供'
请注意:当您未提供__help_name__
或__help_info__
与__doc__
中的一个时,此Matcher不会列入Matcher级别帮助!
实际使用
此部分介绍以使用'/'作为command_start为例。
获取本插件帮助
指令: /help
返回示例:
@<user_who_send_command> 欢迎使用Nonebot2 Help Menu
支持使用的前缀:/
/help # 获取本插件帮助
/help list # 展示已加载插件列表
/help <plugin_name> # 调取目标插件帮助信息
查看已加载插件列表
指令:/help list
返回示例:
@<user_who_send_command> 已加载插件:
nonebot_plugin_cloverdata | 四叶草魔物娘属性计算插件 | 0.1.0
nonebot_plugin_guild_patch
nonebot_plugin_help | Nonebot2 Help Menu | 0.3.1
查看已加载某一插件用途
指令:/help <plugin_package_name | plugin_help_name> 示例:
/help nonebot_plugin_help
@<user_who_send_command> Nonebot2 Help Menu: Nonebot2轻量级帮助插件
欢迎使用Nonebot2 Help Menu // 这里是插件元数据提供的帮助
本插件提供公共帮助菜单能力
此Bot配置的命令前缀:/
/help # 获取本插件帮助
/help list # 展示已加载插件列表
/help <插件名> # 调取目标插件帮助信息
序号. 命令名: 命令用途 // 这里是Matcher级别接入提供的帮助
1. help: /help # 获取本插件帮助
/help list # 展示已加载插件列表
/help <plugin_name> # 调取目标插件帮助信息
或使用提供的插件美化名示例:
/help Nonebot2 Help Menu
@<user_who_send_command> Nonebot2 Help Menu: Nonebot2轻量级帮助插件
欢迎使用Nonebot2 Help Menu // 这里是插件元数据提供的帮助
本插件提供公共帮助菜单能力
此Bot配置的命令前缀:/
/help # 获取本插件帮助
/help list # 展示已加载插件列表
/help <插件名> # 调取目标插件帮助信息
序号. 命令名: 命令用途 // 这里是Matcher级别接入提供的帮助
1. help: /help # 获取本插件帮助
/help list # 展示已加载插件列表
/help <plugin_name> # 调取目标插件帮助信息
若插件未提供__usage__,则会显示__doc__,示例:
/help nonebot_plugin_help
@<user_who_send_command>
Nonebot 2 Help Menu
Author: XZhouQD
Since: 16 May 2021
序号. 命令名: 命令用途
1. help: /help # 获取本插件帮助
/help list # 展示已加载插件列表
/help <plugin_name> # 调取目标插件帮助信息
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
nonebot-plugin-help-0.3.1.tar.gz
(17.7 kB
view hashes)
Built Distribution
Close
Hashes for nonebot-plugin-help-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cd19fd1f46588f72c8adf7cd0c5f8c553b9639567a5a41f249e12e5d42f6ed8 |
|
MD5 | cfa26393a171f8250ae279f8e1ec488c |
|
BLAKE2b-256 | 34a60fe742dfa64efa57e496825245a477b6e88c8b9935c7b3f07144106a2381 |
Close
Hashes for nonebot_plugin_help-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3656d0f0bd86fd377ba3f00a2affca549d3ec130c8d5022d2c46d9bd81f1fed |
|
MD5 | f5c66c479345fe2e2659f3a457ee6cbf |
|
BLAKE2b-256 | f1bd68f8cd791bc35e9e3dff6de4b1d5ef6ae86845cf328088d96f1fc5482a6b |