- 📂 致所有为麦麦提交过贡献，以及想要为麦麦提交贡献的朋友们！
📢 关于项目分支调整与贡献指南的重要通知
致所有关注MaiMBot的开发者与贡献者：
首先，我们由衷感谢大家近期的热情参与！感谢大家对MaiMBot的喜欢，项目突然受到广泛关注让我们倍感惊喜，也深深感受到开源社区的温暖力量。为了保障项目长期健康发展，我们不得不对开发流程做出重要调整，恳请理解与支持。
-
维护团队精力有限
核心成员（包括我本人）均为在校学生/在职开发者，近期涌入的大量PR和意见已远超我们的处理能力。为确保本职工作与项目质量，我们必须优化协作流程。 -
重构核心架构的紧迫性
当前我们正与核心团队全力重构项目底层逻辑，这是为未来扩展性、性能提升打下的必要基础，需要高度专注。 -
保障现有用户的稳定性
我们深知许多用户已依赖当前版本，因此必须划分清晰的维护边界，确保生产环境可用性。
为平衡上述目标，即日起启用以下分支结构：
| 分支 | 定位 | 接受PR类型 | 提交对象 |
|---|---|---|---|
main |
稳定版（供下载使用） | 仅接受来自main-fix的合并 |
维护团队直接管理 |
main-fix |
生产环境紧急修复 | 明确的功能缺陷修复（需附带复现步骤/测试用例） | 所有开发者 |
refactor |
重构版（不兼容当前main） | 仅重构与相关Bug修复 | 重构小组维护 |
由于分支结构调整，GitHub已自动关闭所有未合并的PR，这并非否定您的贡献价值！如果您认为自己的PR符合以下条件：
- 属于
main-fix明确的功能性缺陷修复（非功能增强） ，包括非预期行为和严重报错，需要发布issue讨论确定。 - 属于
refactor分支的重构适配性修复
欢迎您重新提交到对应分支，并在PR描述中标注[Re-submit from closed PR]，我们将优先审查。其他类型PR暂缓受理，但您的创意我们已记录在案，未来重构完成后将重新评估。
- 感谢每一位提交Issue、PR、参与讨论的开发者！您的每一行代码都是maim吃的
- 特别致敬在交流群中积极答疑的社区成员，你们自发维护的氛围令人感动❤️ ，maim哭了
- 重构期间的非代码贡献同样珍贵：文档改进、测试用例补充、用户反馈整理等，欢迎通过Issue认领任务！
- 提交前请先讨论：创建Issue描述问题，确认是否符合
main-fix修复范围 - 对重构提出您的想法：如果您对重构版有自己的想法，欢迎提交讨论issue亟需测试伙伴，欢迎邮件联系
[email protected]报名 - 部分main-fix的功能在issue讨论后，经过严格讨论，一致决定可以添加功能改动或修复的，可以提交pr
谢谢大家谢谢大家谢谢大家谢谢大家谢谢大家谢谢大家！
虽然此刻不得不放缓脚步，但这一切都是为了跳得更高。期待在重构完成后与各位共建更强大的版本！
千石可乐 敬上
2025年3月14日
🍔麦麦是一个基于大语言模型的智能QQ群聊机器人
- 基于 nonebot2 框架开发
- LLM 提供对话能力
- MongoDB 提供数据持久化支持
- NapCat 作为QQ协议端支持
最新版本: v0.5.13
Warning
注意，3月12日的v0.5.13, 该版本更新较大，建议单独开文件夹部署，然后转移/data文件 和数据库，数据库可能需要删除messages下的内容（不需要删除记忆）
Warning
- 项目处于活跃开发阶段，代码可能随时更改
- 文档未完善，有问题可以提交 Issue 或者 Discussion
- QQ机器人存在被限制风险，请自行了解，谨慎使用
- 由于持续迭代，可能存在一些已知或未知的bug
- 由于开发中，可能消耗较多token
- 一群 766798517 ，建议加下面的（开发和建议相关讨论）不一定有空回复，会优先写文档和代码
- 二群 571780722 （开发和建议相关讨论）不一定有空回复，会优先写文档和代码
- 三群 1035228475（开发和建议相关讨论）不一定有空回复，会优先写文档和代码
📚 有热心网友创作的wiki: https://maimbot.pages.dev/
😊 其他平台版本
- (由 CabLate 贡献) Telegram 与其他平台(未来可能会有)的版本 - 集中讨论串
-
📦 Windows 一键傻瓜式部署：请运行项目根目录中的
run.bat，部署完成后请参照后续配置指南进行配置
如果你不知道Docker是什么，建议寻找相关教程或使用手动部署 （现在不建议使用docker，更新慢，可能不适配）
- 项目架构说明 - 项目结构和核心功能实现细节
- 支持关键词检索主动发言：对消息的话题topic进行识别，如果检测到麦麦存储过的话题就会主动进行发言
- 支持bot名字呼唤发言：检测到"麦麦"会主动发言，可配置
- 支持多模型，多厂商自定义配置
- 动态的prompt构建器，更拟人
- 支持图片，转发消息，回复消息的识别
- 错别字和多条回复功能：麦麦可以随机生成错别字，会多条发送回复以及对消息进行reply
- 支持根据发言内容发送对应情绪的表情包
- 会自动偷群友的表情包
- 麦麦会自动生成一天的日程，实现更拟人的回复
- 对聊天记录进行概括存储，在需要时调用，待完善
- 基于embedding模型的知识库，手动放入txt会自动识别，写完了，暂时禁用
- 针对每个用户创建"关系"，可以对不同用户进行个性化回复，目前只有极其简单的好感度（WIP）
- 针对每个群创建"群印象"，可以对不同群进行个性化回复（WIP）
规划主线 0.6.0：记忆系统更新 0.7.0: 麦麦RunTime
- 人格功能：WIP
- 群氛围功能：WIP
- 图片发送，转发功能：WIP
- 幽默和meme功能：WIP的WIP
- 让麦麦玩mc：WIP的WIP的WIP
- 兼容gif的解析和保存
- 小程序转发链接解析
- 对思考链长度限制
- 修复已知bug
完善文档- 修复转发
config自动生成和检测log别用print给发送消息写专门的类- 改进表情包发送逻辑
- 自动生成的回复逻辑，例如自生成的回复方向，回复风格
- 采用截断生成加快麦麦的反应速度
- 改进发送消息的触发
- 千石可乐说：
- 这个项目最初只是为了给牛牛bot添加一点额外的功能，但是功能越写越多，最后决定重写。其目的是为了创造一个活跃在QQ群聊的"生命体"。可以目的并不是为了写一个功能齐全的机器人，而是一个尽可能让人感知到真实的类人存在.
- 程序的功能设计理念基于一个核心的原则："最像而不是好"
- 主打一个陪伴
- 如果人类真的需要一个AI来陪伴自己，并不是所有人都需要一个完美的，能解决所有问题的helpful assistant，而是一个会犯错的，拥有自己感知和想法的"生命形式"。
- 代码会保持开源和开放，但个人希望MaiMbot的运行时数据保持封闭，尽量避免以显式命令来对其进行控制和调试.我认为一个你无法完全掌控的个体才更能让你感觉到它的自主性，而视其成为一个对话机器.
SengokuCola纯编程外行，面向cursor编程，很多代码写得不好多多包涵已得到大脑升级
Warning
本应用生成内容来自人工智能模型，由 AI 生成，请仔细甄别，请勿用于违反法律的用途，AI生成内容不代表本人观点和立场。
nonebot2: 跨平台 Python 异步聊天机器人框架
NapCat: 现代化的基于 NTQQ 的 Bot 协议端实现
感谢各位大佬！
