2 |
3 | # Archived
4 | No further development in this repo.
5 |
6 | # nonebot-plugin-help
7 |
8 | ### Nonebot2 轻量级帮助插件
9 |
10 |
11 | 
12 |
13 |
14 | 
15 |
16 |
17 | 
18 |
19 | 
20 |
21 |
22 | 
23 | 
24 |
25 |
26 | ## Bot可对本插件进行的配置
27 |
28 | ### 配置 help 插件是否at发送者（重要，可选） 
29 |
30 | 0.6.1 版本起，新增是否at发送者配置，适用于adapter不支持at_sender的用户，如KOOK
31 |
32 | 可在.env配置文件内通过配置项`help_at_sender`配置，例如：
33 | ```
34 | help_at_sender = false
35 | ```
36 |
37 | ### 配置 help 插件优先级与阻塞（可选） 
38 |
39 | 0.4.0 版本起，新增插件优先级与阻塞设置（可选），默认为`priority=1, block=False`
40 |
41 | 用户可在.env 配置文件内通过配置项`help_block`与`help_priority`进行配置，例如，以下配置可将 help 命令配置为`priority=100, block=True`
42 |
43 | ```
44 | help_block = true
45 | help_priority = 100
46 | ```
47 |
48 | ### 配置 help 插件忽略列表与`to_me`规则（可选） 
49 |
50 | 0.6.0 版本起，新增忽略插件与`to_me`规则（可选），`help_ignore_plugins`默认不忽略任何插件，`to_me`默认值为`False`。
51 |
52 | `help_ignore_plugins`：可配置不希望 help 插件列出的插件包名列表，例如，以下配置可忽略`nonebot_plugin_localstore`与`nonebot_plugin_apscheduler`插件。
53 | `help_to_me`：可配置是否只有私聊或提及Bot时才响应 help 命令。
54 |
55 | ```
56 | help_ignore_plugins=["nonebot_plugin_localstore", "nonebot_plugin_apscheduler"]
57 | help_to_me=true
58 | ```
59 |
60 | ## 开发者接入此插件列表方法
61 |
62 | 您可以直接参考本插件的接入方式，阅读源代码即可！
63 |
64 | ### 插件级别元数据接入 
65 |
66 | 使用自 **Nonebot 2.0.0-beta.4** 版本起新增的插件元数据进行插件级统一接入（不包含 Matcher 级别接入）
67 |
68 | ```python
69 | # New way of self registering (use PluginMetadata)
70 | __plugin_meta__ = nonebot.plugin.PluginMetadata(
71 | name='您的插件名称（有别于nonebot-plugin-xxx的包名）',
72 | description='您的简单插件描述',
73 | usage='''您想在使用命令/help
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 | 21 |
22 |
23 |
24 |