MaiBot

<a id="-双语--bilingual"></a>

<div align="center"> <!-- Language Switcher -->

<a href="#-双语--bilingual">双语 / Bilingual</a> | <a href="docs/README_CN.md">中文</a> | <a href="#english">English</a>

<br> <br> <h1>麦麦 MaiBot _{<small>MaiSaka</small>}</h1> _{^{An interactive agent based on large language models.}} <!-- Badges Row --> <p> <img src="https://img.shields.io/badge/Python-3.10+-blue" alt="Python Version"> <img src="https://img.shields.io/github/license/Mai-with-u/MaiBot?label=License" alt="License"> <img src="https://img.shields.io/badge/Status-In%20Development-yellow" alt="Status"> <img src="https://img.shields.io/github/contributors/Mai-with-u/MaiBot.svg?style=flat&label=Contributors" alt="Contributors"> <img src="https://img.shields.io/github/forks/Mai-with-u/MaiBot.svg?style=flat&label=Forks" alt="Forks"> <img src="https://img.shields.io/github/stars/Mai-with-u/MaiBot?style=flat&label=Stars" alt="Stars"> <a href="https://deepwiki.com/DrSmoothl/MaiBot"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a> </p> </div> <br> <!-- Mascot on the Right (Float) --> <img src="depends-data/maimai-v2.png" align="right" width="40%" alt="MaiBot Character" style="margin-left: 20px; margin-bottom: 20px;">

<a id="english"></a>

介绍

_{^Introduction}

麦麦 MaiSaka 是一个基于大语言模型的可交互智能体。
_{^{MaiSaka is an interactive agent based on large language models.}}

MaiSaka 不仅仅是一个机器人，不仅仅是一个可以帮你完成任务的“有帮助的助手”，她还是一个致力于了解你，并以真实人类的风格进行交互的数字生命。她不追求完美，不追求高效，但追求亲切和真实。
_{^{MaiSaka is more than just a bot, and more than a "helpful assistant" that completes tasks. She is a digital life form that tries to understand you and interact in a genuinely human style. She does not pursue perfection or efficiency above all else. She pursues warmth and authenticity.}}

• 💭 没有人喜欢 GPT 的语言风格：麦麦使用了更加自然、贴合人类对话习惯的交互方式，不是长篇大论或者 markdown 格式的分点，而是或长或短的闲谈。
  _{^{<strong>No one likes GPT-sounding dialogue</strong>: MaiSaka uses a more natural conversational style. Instead of long-winded markdown-heavy replies, she chats in a way that feels casual, varied, and human.}}
• 🎭 不再是傻乎乎的一问一答：懂得在合适的时间说话，把握聊天中的气氛，在合适的时候开口，在合适的时候闭嘴。
  _{^{<strong>No longer stuck in rigid Q&A</strong>: She knows when to speak, how to read the room, when to join a conversation, and when to stay quiet.}}
• 🧠 麦麦·成为人类：在多人对话中，麦麦会模仿其他人的说话风格，还会自主理解新词或者小圈子里的黑话，不断进化。
  _{^{<strong>MaiSaka becoming human</strong>: In group conversations, MaiSaka imitates how people around her speak, learns new slang and in-group language, and keeps evolving.}}
• ❤️ 永远都在更加了解你：基于心理学中人格理论，麦麦会不断积累对于你的了解，不论是你的信息、喜恶或是行为风格，她都记在心里。
  _{^{<strong>Always learning more about you</strong>: Inspired by personality theory in psychology, MaiSaka gradually builds an understanding of your preferences, traits, habits, and behavior style.}}
• 🔌 插件系统：提供强大的 API 和事件系统，拥有无限扩展可能。
  _{^{<strong>Plugin system</strong>: Provides powerful APIs and an event system with virtually unlimited room for extension.}}

快速导航

_{^{Quick Navigation}}

<p> <a href="https://www.bilibili.com/video/BV1amAneGE3P">🌟 演示视频 _{Demo Video}</a> &nbsp;|&nbsp; <a href="#-更新和安装--updates-and-installation">📦 快速入门 _{Quick Start}</a> &nbsp;|&nbsp; <a href="#-部署教程--deployment-guide">📃 核心文档 _{Core Documentation}</a> &nbsp;|&nbsp; <a href="#-讨论与社区--discussion-and-community">💬 加入社区 _{Join Community}</a> </p> <!-- Clear float to ensure subsequent content starts below the image area if text is short --> <br clear="both"> <div align="center"> <br> <a href="https://www.bilibili.com/video/BV1amAneGE3P" target="_blank"> <picture> <source media="(max-width: 600px)" srcset="depends-data/video.png" width="100%"> <img src="depends-data/video.png" width="60%" alt="麦麦演示视频" style="border-radius: 10px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"> </picture> <br> <small>前往观看麦麦演示视频 / Watch the MaiSaka demo video</small> </a> </div>

---

<a id="-更新和安装--updates-and-installation"></a>

🔥 更新和安装

_{^{Updates and Installation}}

最新版本: v1.0.0 (📄 更新日志)
_{^{<strong>Latest Version: v1.0.0</strong> (<a href="changelogs/changelog.md">📄 Changelog</a>)}}

• 下载：前往 Release 页面下载最新版本。
  _{^{<strong>Download</strong>: Visit the <a href="https://github.com/MaiM-with-u/MaiBot/releases/">Release</a> page to get the latest version.}}
• 启动器：Mailauncher（仅支持 MacOS，早期开发中）。
  _{^{<strong>Launcher</strong>: <a href="https://github.com/MaiM-with-u/mailauncher/releases/">Mailauncher</a> (MacOS only, still in early development).}}

分支 / Branch	说明 / Description
main	✅ 稳定发布版本（推荐）<br><sub><sup>Stable release (recommended)</sup></sub>
dev	🚧 开发测试版本，包含新功能，可能不稳定<br><sub><sup>Development testing branch with new features, may be unstable</sup></sub>

<a id="-部署教程--deployment-guide"></a>

📚 部署教程

_{^{Deployment Guide}}

👉 🚀 最新版本部署教程
_{^{Latest Deployment Guide}}

---

<a id="-讨论与社区--discussion-and-community"></a>

💬 讨论与社区

_{^{Discussion and Community}}

我们欢迎所有对 MaiBot 感兴趣的朋友加入！
_{^{We welcome everyone interested in MaiBot to join us.}}

类别 / Category	群组 / Group	说明 / Description
技术交流<br><sub><sup>Technical</sup></sub>	麦麦脑电图<br><sub><sup>MaiBrain EEG</sup></sub>	技术交流 / 答疑<br><sub><sup>Technical discussion / Q&A</sup></sub>
技术交流<br><sub><sup>Technical</sup></sub>	麦麦大脑磁共振<br><sub><sup>MaiBrain MRI</sup></sub>	技术交流 / 答疑<br><sub><sup>Technical discussion / Q&A</sup></sub>
技术交流<br><sub><sup>Technical</sup></sub>	麦麦要当 VTB<br><sub><sup>Mai Wants to Be a VTuber</sup></sub>	技术交流 / 答疑<br><sub><sup>Technical discussion / Q&A</sup></sub>
闲聊吹水<br><sub><sup>Casual Chat</sup></sub>	麦麦之闲聊群<br><sub><sup>Mai Casual Chat Group</sup></sub>	仅限闲聊，不答疑<br><sub><sup>Casual chat only, no support</sup></sub>
插件开发<br><sub><sup>Plugin Development</sup></sub>	插件开发群<br><sub><sup>Plugin Dev Group</sup></sub>	进阶开发与测试<br><sub><sup>Advanced development and testing</sup></sub>

---

📚 文档

_{^{Documentation}}

[!NOTE] 部分内容可能更新不够及时，请注意版本对应。
_{^{Some content may not be updated promptly, so please pay attention to version compatibility.}}

• 📚 核心 Wiki 文档：最全面的文档中心，了解麦麦的一切。
  _{^{<strong><a href="https://docs.mai-mai.org">📚 Core Wiki Documentation</a></strong>: The most comprehensive documentation hub for everything about MaiSaka.}}

🧩 衍生项目

_{^{Related Projects}}

• Amaidesu：让麦麦在 B 站开播。
  _{^{Let MaiSaka stream on Bilibili.}}
• MoFox_Bot：基于 MaiCore 0.10.0 的增强型 Fork，更稳定更有趣。
  _{^{An enhanced fork based on MaiCore 0.10.0, with improved stability and more fun features.}}
• MaiCraft：让麦麦陪你玩 Minecraft（暂时停止维护中）。
  _{^{Let MaiSaka accompany you in Minecraft (currently paused).}}

---

💡 设计理念

_{^{Design Philosophy}}

千石可乐说：
_{^{<strong>SengokuCola says:</strong>}}

• 这个项目最初只是为了给牛牛 bot 添加一点额外的功能，但是功能越写越多，最后决定重写。其目的是为了创造一个活跃在 QQ 群聊的“生命体”。目的并不是为了写一个功能齐全的机器人，而是一个尽可能让人感知到真实的类人存在。
  _{^{This project originally started as a few extra features for the NiuNiu bot, but it kept growing until a full rewrite became inevitable. The goal was to create a "life form" active in QQ group chats, not a feature-complete bot, but something as human-like and real-feeling as possible.}}
• 程序的功能设计理念基于一个核心的原则：“最像而不是好”。
  _{^{The core design principle is: "more lifelike, not merely better."}}
• 如果人类真的需要一个 AI 来陪伴自己，并不是所有人都需要一个完美的，能解决所有问题的“helpful assistant”，而是一个会犯错的，拥有自己感知和想法的“生命形式”。
  _{^{If people truly want AI companionship, not everyone needs a perfect "helpful assistant" that solves every problem. Some people may want a life form that can make mistakes and has its own perceptions and thoughts.}}

xxxxx 说：
_{^{<strong>xxxxx says:</strong>}}
Code is open, but the soul is yours.

---

🙋 贡献和致谢

_{^{Contributing and Acknowledgments}}

欢迎参与贡献！请先阅读 贡献指南。
_{^{Contributions are welcome. Please read the <a href="docs-src/CONTRIBUTE.md">Contribution Guide</a> first.}}

🌟 贡献者

_{^Contributors}

<a href="https://github.com/MaiM-with-u/MaiBot/graphs/contributors"> <img alt="contributors" src="https://contrib.rocks/image?repo=MaiM-with-u/MaiBot" /> </a>

❤️ 特别致谢

_{^{Special Thanks}}

• 萨卡班甲鱼：千石可乐很喜欢的生物。
  _{^{<strong><a href="https://en.wikipedia.org/wiki/Sacabambaspis">Sacabambaspis</a></strong>: SengokuCola's favorite creature.}}
• 略nd：为麦麦绘制早期的精美人设。
  _{^{Drew MaiSaka's beautiful early character design.}}
• NapCat：现代化的基于 NTQQ 的 Bot 协议实现。
  _{^{A modern NTQQ-based bot protocol implementation.}}

---

📊 仓库状态

_{^{Repository Status}}

Star 趋势

_{^{Star History}}

---

📌 注意事项 & License

_{^{Notice & License}}

[!IMPORTANT] 使用前请阅读 用户协议 (EULA) 和 隐私协议。AI 生成内容请仔细甄别。
_{^{Please read the <a href="EULA.md">End User License Agreement (EULA)</a> and <a href="PRIVACY.md">Privacy Policy</a> before use. Please evaluate AI-generated content carefully.}}

License: GPL-3.0