Skip to main content

A qq bot development framework with friendly APIs, session control and plugin-supported.

Project description

MeloBot

插件化管理、基于异步会话机制的 qq 机器人开发框架

license MeloBot docs GitHub Repo stars cqhttp

Made with Python PDM - Managed PyPI Code style: black Checked with mypy

郑重承诺和提示: 本项目一切开发旨在学习,请勿用于商业用途和非法用途。任何使用本项目的用户群体,有义务遵守其所在国家或地区的相关法律规定。

🎉 简介

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

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

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

✨ 特色

  • 基于 asyncio 的高性能异步
  • 支持插件交互的插件化管理
  • 异步会话控制、自动的会话上下文
  • 事件预检查、预匹配和预解析
  • 支持 bot 生命周期 hook
  • 支持多 bot 协同工作
  • 丰富的接口设计

📦️ 安装使用

通过 pip 命令安装:

pip install melobot

或从源码构建:

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

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

之后可在 .pdm-build 目录获取本地构建,pip 本地安装即可。

提示:首次运行 pdm 需要初始化虚拟环境,可参照 pdm 文档操作。

🪄 版本支持

  • python >= 3.10
  • platform == All
  • OneBot 标准 == 11

❤️ 致谢

MeloBot 的很多设计也是从别处借鉴而来的。虽然 MeloBot 并未直接引用这些项目的代码。

但感谢这些优秀的开源项目,它们间接启发了 MeloBot 的架构设计:

💬 更多

项目文档:MeloBot 文档

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

melobot-2.5.8.tar.gz (855.2 kB view hashes)

Uploaded Source

Built Distribution

melobot-2.5.8-py3-none-any.whl (92.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page