Skip to content

Commit

Permalink
Update README.md for v2.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
aicorein committed Mar 3, 2024
1 parent d0ca2f7 commit e5a4656
Showing 1 changed file with 16 additions and 23 deletions.
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,33 @@
<p>郑重承诺和提示:<strong>本项目一切开发旨在学习,请勿用于商业用途和非法用途。任何使用本项目的用户群体,有义务遵守其所在国家或地区的相关法律规定。</strong></p>
</div>

## 🎉 关于 MeloBot
## 🎉 关于

MeloBot 是一个基于 Python 的 qbot 开发框架。其以**实现了 Onebot 标准的适配器**作为前端,通过对来自适配器的各种“事件”的处理,再产生“行为”,最后提交给适配器与 qq 服务器进行通信,实现各类复杂的功能。

v1 版本([main](https://github.com/AiCorein/Qbot-MeloBot/tree/main) 分支)已经完成。它本质上不是一个开发框架,只是一个可用的 qq 机器人项目。只支持 windows 平台,且需要 go-cq 作为适配器,现已经停止更新和维护
使用示例:你可以参考使用本框架的项目 [MeloInf](https://github.com/AiCorein/meloinf),这里有详细的接口调用示范

目前正开发 v2 版本([v2-dev](https://github.com/AiCorein/Qbot-MeloBot/tree/v2-dev) 分支)。v2 版本已经实现完毕,目前正在进行验证工作,验证完成后会发布 release。你可以参考用于本项目验证的具体机器人项目([MeloInf](https://github.com/AiCorein/meloinf)),这里有详细的使用示例。
## ✨ 特色

此外,你可以在 pypi.org 预先获得 MeloBot 的 pre-release 版本:
- 基于 asyncio 的高性能异步
- 插件化管理
- 异步的自动上下文(会话)
- 可高度自定义的中间件功能
- 权限检查、规则校验、解析组件等
- 支持生命周期 hook
- 人性化、丰富的接口设计

```bash
pip install --pre melobot
```

## 🚧 MeloBot v2 的开发工作

- ✅ 封装建立内部数据结构,与底层数据解耦
- ✅ 取消线程池设计,全部使用协程设计
- ✅ 事件接口、事件分发与事件回送
- ✅ 权限检查、规则校验、解析组件等中间件设计
- ✅ 完整的会话控制机制
- ✅ 插件化管理
- ✅ 插件交互
- ✅ 生命周期 hook 设计
- ⬜ 后期验证
## 📦️ 安装使用

## 📦️ 版本支持
```python
pip install melobot
```

版本支持:
- python >= 3.8
- platform == All(mac 平台未测试)
- OneBot 标准 >= 11

## 💬 更多

请参阅文档(v1 版本):[MeloBot 文档](https://aicorein.github.io/Qbot-MeloBot-docs/)

文档开源(v1 版本):[MeloBot-docs](https://github.com/AiCorein/Qbot-MeloBot-docs)
项目文档正在构建中,敬请期待...

0 comments on commit e5a4656

Please sign in to comment.