# 轻雪插件开发 | LiteyukiBot 轻雪机器人
简介 轻雪插件是轻雪内置的一部分功能，运行在主进程中，可以很高程度地扩展轻雪的功能 开始 创建插件 在标准项目中，位于liteyuki/plugins和src/liteyuki_plugins下的Python modules均会被当作插件加载，你可自行添加配置文件以指定插件的加载路径 一个.py文件或一个包含__init__.py的文件夹即可被识别为插...

跳至主要內容

- 首页

- 安装及部署

  - 安装
  - 配置
  - 答疑

- 使用及功能

  - 基础命令
  - 功能命令
  - 用户协议
  - 轻雪API

- 资源及插件

  - 资源商店
  - 插件商店

- 开发及贡献

  - 资源包开发
  - 轻雪函数
  - 轻雪插件开发
  - 进程通信

# 轻雪插件开发

远野千束
大约 1 分钟
开发

此页内容

- 简介
- 开始
- - 创建插件
  - 编写逻辑部分
  - 加载插件

## 简介

轻雪插件是轻雪内置的一部分功能，运行在主进程中，可以很高程度地扩展轻雪的功能

## 开始

### 创建插件

在标准项目中，位于liteyuki/plugins和src/liteyuki_plugins下的Python modules均会被当作插件加载，你可自行添加配置文件以指定插件的加载路径 一个`.py`文件或一个包含`__init__.py`的文件夹即可被识别为插件 创建一个文件夹，例如`my_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件

    from liteyuki.plugin import PluginMetadata

    __plugin_meta__ = PluginMetadata(
        name="My Plugin",
        version="1.0.0",
        description="A simple plugin"
    )

    # 你的插件代码

### 编写逻辑部分

轻雪主进程不涉及聊天部分，因此插件主要是一些后台任务或者与聊天机器人的通信 以下我们会编写一个简单的插件，用于开发NoneBot时进行文件系统变更重载

    from liteyuki.dev import observer
    from liteyuki import get_bot, logger
    from watchdog.events import FileSystemEvent

    liteyuki = get_bot()

    exclude_extensions = (".pyc", ".pyo")

    # 用observer的on_file_system_event装饰器监听文件系统事件
    @observer.on_file_system_event(
        directories=("src/nonebot_plugins",),
        event_filter=lambda event: not event.src_path.endswith(exclude_extensions) and ("__pycache__" not in event.src_path) and os.path.isfile(event.src_path)
    )
    def restart_nonebot_process(event: FileSystemEvent):
        logger.debug(f"File {event.src_path} changed, reloading nonebot...")
        liteyuki.restart_process("nonebot")

### 加载插件

在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`my_plugin`，重启轻雪即可加载插件。然后我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程