melobot 文档

🎉 简介

melobot 是基于 Python 的机器人开发框架。目前开发版本号为 v2,只适用于搭建 qq 机器人,v3 仍在开发中。

melobot v2 以Onebot 标准的实现程序作为前端,通过对来自“前端”的各种“事件”的处理,产生“行为”提交给“前端”,让“前端”与 qq 服务器交互,从而实现各种复杂的功能。

✨ 特色

为什么选择 melobot?因为 melobot 更自由、优雅和强大

  • 异步性能:基于 asyncio,但使用性能更优秀的事件循环策略:uvloop/winloop

  • 插件管理:更低耦合度的插件加载与通信

  • 会话控制:自动传递的、可自定义的会话

  • 预处理流程:可传播会话信息的、灵活的、可自定义的事件预处理

  • 生命周期控制:支持 bot 生命周期 hook

  • 多实例协同:多 bot 实例运行,跨实例通信

  • 异步接口:常用异步逻辑的封装,使各种业务逻辑更简洁

  • 日志支持:日志记录兼容标准库和绝大多数日志框架

使用本框架的机器人项目如下:

你可以将这些项目作为 melobot 使用的实例参考。欢迎你基于 melobot 实现完整的机器人项目后,向本文档提出 PR,在此处展示。

💬 文档

项目文档:melobot 文档

对于文档可能出现的纰漏,恳请各位包涵。欢迎提出修正和优化文档的 PR:文档源文件

📦️ 安装使用

通过 pip 命令安装:

pip install melobot

或从源码构建:

本项目通过 pdm 管理,你首先需要安装 pdm

# 随后在本项目根目录:
pdm install
pdm build

之后可在 .pdm-build 目录获取本地构建,pip 本地安装即可。提示:首次运行 pdm 需要初始化虚拟环境,请参照 pdm 文档操作。

🪄 版本特性

  • python 版本需要 >=3.10

  • 可跨平台使用

  • 通信标准:OneBot v11