melobot 文档¶

重要提示

melobot 的文档仍在补充中，请及时关注文档更新。

🎉 特色¶

melobot v3 是跨平台、跨协议、支持多路 IO 及其他高级特性的 bot 开发框架。为什么选择 melobot？因为 melobot 更自由、优雅和强大：

特性	描述
实用接口	封装高频使用的异步逻辑，使业务开发更简洁
插件管理	低耦合度、无序的插件加载与通信
处理流设计	可自由组合“处理中间件”为处理流，提升了各组件的复用率
热插拔/重启	处理流支持动态热插拔，支持 bot 级别的重启
会话支持	可在处理流中自动传递的、可自定义的会话上下文
协议支持	所有协议被描述为 IO 过程，因此支持各类协议
跨平台	更简洁的跨平台接口，便捷实现跨平台插件开发
跨协议 IO	支持多个协议实现端同时输入，自由输出到指定协议实现端
日志支持	日志记录兼容标准库和绝大多数日志框架，可自行选择

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

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

项目文档：melobot 文档

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

Python 版本需求：>= 3.10

如果您对 melobot 完全不熟悉，建议配合文档开始学习。文档以 OneBot v11 协议为例，通过以下命令安装文档教程中必需的组件：

pip install melobot[onebot]

如果您对 melobot 已经十分了解，请自由地安装核心 + 任何可选依赖。

也可以通过源码构建：（对于普通用户不推荐）

本项目使用 pdm 管理，你首先需要安装 pdm。

pdm install
pdm build

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