bot/app
3
6.9k
Fork 1
mirror of https://github.com/LiteyukiStudio/LiteyukiBot.git synced 2024-11-22 22:37:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 添加快速启动说明

Browse Source
This commit is contained in:
远野千束 2024-08-18 23:52:26 +08:00
parent af37e61d05
commit cd8d631348
1 changed files with 35 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/dev/dev_lyplugin.md
View File

@ -5,7 +5,6 @@ order: 3
category: 开发 category: 开发
--- ---
## 简介 ## 简介
轻雪插件是轻雪内置的一部分功能，运行在主进程中，可以很高程度地扩展轻雪的功能 轻雪插件是轻雪内置的一部分功能，运行在主进程中，可以很高程度地扩展轻雪的功能
@ -14,18 +13,21 @@ category: 开发
### 创建插件 ### 创建插件
在标准项目中，位于liteyuki/plugins和src/liteyuki_plugins下的Python modules均会被当作插件加载，你可自行添加配置文件以指定插件的加载路径
一个`.py`文件或一个包含`__init__.py`的文件夹即可被识别为插件 一个`.py`文件或一个包含`__init__.py`的文件夹即可被识别为插件
创建一个文件夹，例如`watchdog_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件
首先创建一个文件夹，例如`watchdog_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件
`__init__.py`
```python ```python
from liteyuki.plugin import PluginMetadata from liteyuki.plugin import PluginMetadata, PluginType
from .watch_dog import * # 导入逻辑部分
# 定义插件元数据，推荐填写 # 定义插件元数据
__plugin_meta__ = PluginMetadata( __plugin_meta__ = PluginMetadata(
name="NoneDog", # 插件名称 name="NoneDog", # 插件名称
version="1.0.0", # 插件版本 version="1.0.0", # 插件版本
description="A simple plugin for nonebot developer" # 插件描述 description="A simple plugin for nonebot developer", # 插件描述
type=PluginType.SERVICE # 插件类型
) )
# 你的插件代码 # 你的插件代码
@ -36,16 +38,16 @@ __plugin_meta__ = PluginMetadata(
轻雪主进程不涉及聊天部分，因此插件主要是一些后台任务或者与聊天机器人的通信 轻雪主进程不涉及聊天部分，因此插件主要是一些后台任务或者与聊天机器人的通信
以下我们会编写一个简单的插件，用于开发NoneBot时进行文件系统变更重载 以下我们会编写一个简单的插件，用于开发NoneBot时进行文件系统变更重载
`watch_dog.py`
```python ```python
import os import os
from liteyuki.dev import observer # 导入文件系统观察器 from liteyuki.dev import observer # 导入文件系统观察器
from liteyuki import get_bot, logger # 导入轻雪Bot和日志 from liteyuki import get_bot, logger # 导入轻雪Bot和日志
from watchdog.events import FileSystemEvent # 导入文件系统事件 from watchdog.events import FileSystemEvent # 导入文件系统事件
liteyuki = get_bot() # 获取唯一的轻雪Bot实例 liteyuki = get_bot() # 获取唯一的轻雪Bot实例
exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名 exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名
# 用observer的on_file_system_event装饰器监听文件系统事件 # 用observer的on_file_system_event装饰器监听文件系统事件
@ -55,9 +57,26 @@ exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名
) )
def restart_nonebot_process(event: FileSystemEvent): def restart_nonebot_process(event: FileSystemEvent):
logger.debug(f"File {event.src_path} changed, reloading nonebot...") logger.debug(f"File {event.src_path} changed, reloading nonebot...")
liteyuki.restart_process("nonebot") # 调用重启进程方法 liteyuki.restart_process("nonebot") # 调用重启进程方法
``` ```
### 加载插件 ### 加载插件
在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`watchdog_plugin`，重启轻雪即可加载插件。然后我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程 #### 方法1
- 在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`watchdog_plugin`，重启轻雪即可加载插件。
#### 方法2
- 使用开发工具快速运行插件，无需手动创建实例
- 创建入口文件，例如`main.py`，并在其中写入以下代码
```python
from liteyuki.dev.plugin import run_plugins
run_plugins("watchdog_plugin")
```
然后运行`python main.py`即可启动插件
启用插件后，我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程