ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-09-18 01:46:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 add plugin load doc

Browse Source
This commit is contained in:
yanyongyu
2020-11-07 12:36:47 +08:00
parent 2a5cfe712f
commit 9d7da873c4
5 changed files with 111 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/guide/writing-a-plugin.md
View File

@ -2,38 +2,6 @@
本章将以一个天气查询插件为例，教学如何编写自己的命令。
## 加载插件
在 [创建一个完整的项目](creating-a-project) 一章节中，我们已经创建了插件目录 `awesome_bot/plugins`，现在我们在机器人入口文件中加载它。当然，你也可以单独加载一个插件。
:::tip 提示
加载插件目录时，目录下以 `_` 下划线开头的插件将不会被加载！
:::
在 `bot.py` 文件中添加以下行：
```python{5,7}
import nonebot
nonebot.init()
# 加载单独的一个插件，参数为合法的python包名
nonebot.load_plugin("nonebot.plugins.base")
# 加载插件目录，该目录下为各插件，以下划线开头的插件将不会被加载
nonebot.load_plugins("awesome_bot/plugins")
app = nonebot.get_asgi()
if __name__ == "__main__":
nonebot.run()
```
尝试运行 `nb run` 或者 `python bot.py`，可以看到日志输出了类似如下内容：
```plain
09-19 21:51:59 [INFO] nonebot | Succeeded to import "nonebot.plugins.base"
09-19 21:51:59 [INFO] nonebot | Succeeded to import "plugin_in_folder"
```
## 创建插件
现在我们已经有了一个空的插件目录，我们可以开始创建插件了！插件有两种形式