Skip to content

Commit

Permalink
📝 文档添加开发模式说明
Browse files Browse the repository at this point in the history
  • Loading branch information
snowykami authored Aug 18, 2024
1 parent 34cf55f commit ac076a8
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ _✨ 为轻雪机器人提供NoneBot支持 ✨_

## 📖 介绍

一个简单的 liteyukibot 插件,可以为你的机器人提供 NoneBot 支持
一个简单的 liteyukibot 插件,可以为你的机器人提供 NoneBot 支持,有一定NoneBot基础即可从原有的NoneBot迁移到轻雪

## 💿 安装

Expand Down Expand Up @@ -76,7 +76,7 @@ _✨ 为轻雪机器人提供NoneBot支持 ✨_
python main.py
```

> 或运行开发工具直接启动
> 或自行通过开发工具运行
```python
from liteyuki.dev.plugin import run_plugins
Expand All @@ -85,18 +85,18 @@ if __name__ == "__main__":
run_plugins("liteyukibot_plugin_nonebot")
```

### 装载到轻雪机器人程式运行(生产环境)
### 装载到机器人程式运行(生产环境)

在轻雪配置文件中添加以下结构配置,使轻雪知道该加载此插件
在轻雪配置文件中添加如下结构配置其一,使轻雪知晓应加载此插件

> 扁平化配置项(推荐在少量配置时使用)
> 扁平配置项
```yaml
liteyuki.plugins: [ ..., "liteyukibot_plugin_nonebot" ]

```
或是
> 普通配置项
> 普通配置项(在主要配置文件中使用)
```yaml
liteyuki:
Expand All @@ -105,7 +105,7 @@ liteyuki:
- liteyukibot_plugin_nonebot
```
默认装载`nonebot-adapter-onebot`适配器和`fastapi`,`httpx`及`websockets`几个常用驱动器,可根据需求进行配置
此插件默认装载`nonebot-adapter-onebot`适配器和`fastapi`,`httpx`及`websockets`三个常用驱动器,可根据需求进行配置或二次分发使用

安装其他NoneBot商店推荐使用轻雪的NoneBot插件`npm`

Expand All @@ -120,8 +120,17 @@ nonebot:
command_start: [ "", "/" ] # 命令前缀
superusers: [ "0000" ] # 你的用户id
nickname: [ "liteyuki" ] # 你的机器人昵称
liteyuki:
reload: true # 轻雪开发模式 运行时重载 启用后修改nonebot插件后可重载插件
```

目前该插件已内置在[轻雪机器人应用](https://bot.liteyuki.icu)中,无需单独安装
## ℹ️ 其他

- 目前该插件已内置在[轻雪机器人应用](https://bot.liteyuki.icu)中,无需单独安装

- 如果你是基于[轻雪框架](https://pypi.org/project/liteyukibot/)二次开发,需要手动安装

- 该插件仍然有许多内容需要完善,欢迎各位的建议及贡献

如果你是基于[轻雪框架](https://pypi.org/project/liteyukibot/)二次开发,需要手动安装
- 感谢[NoneBot](https://nonebot.dev/)提供的框架支持

0 comments on commit ac076a8

Please sign in to comment.