添加热重载,优化readme
This commit is contained in:
13
README.md
13
README.md
@@ -7,6 +7,7 @@
|
||||
* **OneBot 11 标准支持**:完整支持 OneBot 11 的消息、通知、请求和元事件。
|
||||
* **类型安全**:基于 `dataclasses` 的强类型事件模型,开发体验更佳。
|
||||
* **插件系统**:轻量级的装饰器风格插件系统,支持指令 (`@matcher.command`) 和事件监听 (`@matcher.on_notice`, `@matcher.on_request`)。
|
||||
* **🔥 热重载支持**:内置文件监控,修改 `base_plugins` 下的代码自动重载,无需重启,极大提升调试效率。
|
||||
* **异步核心**:基于 `asyncio` 和 `websockets` 的高性能异步核心。
|
||||
* **自动重连**:内置 WebSocket 断线重连机制。
|
||||
|
||||
@@ -14,7 +15,7 @@
|
||||
|
||||
```
|
||||
NEO/
|
||||
├── base_plugins/ # 基础插件目录,新建插件文件即可自动加载
|
||||
├── base_plugins/ # 基础插件目录,新建插件文件即可自动加载(支持热重载)
|
||||
│ └── echo.py # 示例插件:实现 /echo 指令
|
||||
├── core/ # 核心框架代码
|
||||
│ ├── bot.py # Bot API 封装,提供 send_group_msg 等方法
|
||||
@@ -26,7 +27,7 @@ NEO/
|
||||
│ ├── message.py # 消息段定义 (MessageSegment)
|
||||
│ └── sender.py # 发送者定义 (Sender)
|
||||
├── config.toml # 配置文件
|
||||
├── main.py # 启动入口
|
||||
├── main.py # 启动入口(包含热重载监控)
|
||||
└── requirements.txt # 项目依赖
|
||||
```
|
||||
|
||||
@@ -65,6 +66,14 @@ python main.py
|
||||
|
||||
## 🛠️ 开发指南
|
||||
|
||||
### 🔥 热重载调试
|
||||
|
||||
项目集成了 `watchdog` 文件监控。在开发过程中,你只需要:
|
||||
1. 保持 `main.py` 运行。
|
||||
2. 修改或新建 `base_plugins` 目录下的 `.py` 插件文件。
|
||||
3. 保存文件。
|
||||
4. 控制台会自动提示 `[HotReload] 插件重载完成`,新的逻辑立即生效。
|
||||
|
||||
### 创建新插件
|
||||
|
||||
在 `base_plugins` 目录下创建一个新的 `.py` 文件(例如 `my_plugin.py`),框架会自动加载它。
|
||||
|
||||
Reference in New Issue
Block a user