## 1. Project Overview & Quickstart (Mai-with-u/MaiBot) ## INTRO 麦麦 MaiSaka 是一个基于大语言模型的可交互智能体。 MaiSaka 不仅仅是一个机器人，不仅仅是一个可以帮你完成任务的“有帮助的助手”，她还是一个致力于了解你，并以真实人类的风格进行交互的数字生命。她不追求完美，不追求高效，但追求亲切和真实。 _{^{MaiSaka is an interactive agent based on large language models. 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 格式的分点，而是或长或短的闲谈。 _{^{**No one likes GPT-sounding dialogue**: 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.}} - 🎭 **不再是傻乎乎的一问一答**：懂得在合适的时间说话，把握聊天中的气氛，在合适的时候开口，在合适的时候闭嘴。 _{^{**No longer stuck in rigid Q&A**: She knows when to speak, how to read the room, when to join a conversation, and when to stay quiet.}} - 🧠 **麦麦·成为人类**：在多人对话中，麦麦会模仿其他人的说话风格，还会自主理解新词或者小圈子里的黑话，不断进化。 _{^{**MaiSaka becoming human**: In group conversations, MaiSaka imitates how people around her speak, learns new slang and in-group language, and keeps evolving.}} - ❤️ **永远都在更加了解你**：基于心理学中人格理论，麦麦会不断积累对于你的了解，不论是你的信息、喜恶或是行为风格，她都记在心里。 _{^{**Always learning more about you**: Inspired by personality theory in psychology, MaiSaka gradually builds an understanding of your preferences, traits, habits, and behavior style.}} - 🔌 **插件系统**：提供强大的 API 和事件系统，拥有无限扩展可能。 _{^{**Plugin system**: Provides powerful APIs and an event system with virtually unlimited room for extension.}} --- ## 安装 · INSTALL **最新版本: v1.2.1** _{^{**Latest Version: v1.2.1**}} - **发布**：[Release](https://github.com/Mai-with-u/MaiBot/releases/) 页面展示了最新发布的正式版。 _{^{**Download**: Visit the [Release](https://github.com/Mai-with-u/MaiBot/releases/) page to get the latest version.}} - **[部署教程](https://docs.mai-mai.org/manual/deployment/)** _{^{Deployment Guide}} - **方便使用的麦麦启动器下载 (Windows/MAC)**：[Maibot-OK](https://github.com/Mai-with-u/MaiBotOneKey/releases/) _{^{**Launcher**: [Maibot OneKey](https://github.com/Mai-with-u/MaiBotOneKey/releases/)}} | 分支 / Branch || | :--- | :--- | | `main` | **稳定版 · STABLE** | | `dev` | 开发版，包含开发中的新功能 · DEV| --- ## 📚 文档 · DOC - **[📚 麦麦文档](https://docs.mai-mai.org)**：最全面的文档中心，了解麦麦的一切。 _{^{**[📚 Documentation](https://docs.mai-mai.org)**: The most comprehensive documentation hub for everything about MaiSaka.}} - **[演示视频]** 前往麦麦演示视频 / Watch the MaiSaka video --- ## 💬 讨论与社区 · Discussion/Community | 群组 / Group | 说明 / Description | | :--- | :--- | | 麦麦脑电图:571780722_{^{MaiBrain EEG}} | 技术交流 / 答疑_{^{Technical discussion / Q&A}} | | 麦麦大脑磁共振:766798517_{^{MaiBrain MRI}} | 技术交流 / 答疑_{^{Technical discussion / Q&A}} | | [麦麦要当 VTB](https://qm.qq.com/q/wGePTl1UyY)_{^{Mai Wants to Be a VTuber}} | 技术交流 / 答疑_{^{Technical discussion / Q&A}} | | [麦麦闲聊群](https://qm.qq.com/q/JxvHZnxyec)_{^{Mai Casual Chat Group}} | 以闲聊为主_{^{Casual chat only, no support}} | | 插件开发群:1036092828_{^{Plugin Dev Group}} | 插件、进阶开发与测试_{^{Advanced development and testing}} | --- ## 🧩 衍生项目 · Related Projects - **[Amaidesu](https://github.com/MaiM-with-u/Amaidesu)**：让麦麦在 B 站开播。 _{^{Let MaiSaka stream on Bilibili.}} - **[MoFox_Bot](https://github.com/MoFox-Studio/MoFox-Core)**：基于 MaiCore 0.10.0 的 Fork。 _{^{An enhanced fork based on MaiCore 0.10.0.}} - **[MaiCraft](https://github.com/MaiM-with-u/Maicraft)**：让麦麦陪你玩 Minecraft（暂时停止维护中）。 _{^{Let MaiSaka accompany you in Minecraft (currently paused).}} --- ## 💡 设计理念 · IDEA > **千石可乐说：** > _{^{**SengokuCola:**}} > - 这个项目最初只是为了给牛牛 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.}} --- ## 🌟 贡献和致谢 · Contributors 欢迎参与贡献！请先阅读 [贡献指南](docs/CONTRIBUTE.md)。 _{^{Contributions are welcome. Please read the [Contribution Guide](docs/CONTRIBUTE.md) first.}} ### 🌟 贡献者 _{^Contributors} ### 🤝 开源项目友链 _{^{Open Source Friends}} - **[AstrBot](https://github.com/AstrBotDevs/AstrBot)**: 优秀的LLM Agent项目 _{^{An excellent LLM Agent project.}} ### ❤️ 特别致谢 _{^{Special Thanks}} - **[萨卡班甲鱼](https://en.wikipedia.org/wiki/Sacabambaspis)**：千石可乐很喜欢的生物。 _{^{**[Sacabambaspis](https://en.wikipedia.org/wiki/Sacabambaspis)**: SengokuCola's favorite creature.}} - **[略nd](https://space.bilibili.com/1344099355)**：为麦麦绘制早期的精美人设。 _{^{Drew MaiSaka's beautiful early character design.}} - **[NapCat](https://github.com/NapNeko/NapCatQQ)**：现代化的基于 NTQQ 的 Bot 协议实现。 _{^{A modern NTQQ-based bot protocol implementation.}} --- ## 📊 仓库状态 _{^{Repository Status}} ### Star History --- ## 📌 注意事项 & License _{^{Notice & License}} > [!IMPORTANT] > 使用前请阅读 [用户协议 (EULA)](EULA.md) 和 [隐私协议](PRIVACY.md)。AI 生成内容请仔细甄别。 > _{^{Please read the [End User License Agreement (EULA)](EULA.md) and [Privacy Policy](PRIVACY.md) before use. Please evaluate AI-generated content carefully.}} **License**: GPL-3.0 ## 2. Official Technical Reference & Guides (Mai-with-u/docs) # MaiBot 文档本仓库为 MaiBot 的官方文档。MaiBot 是一个智能聊天机器人，专为 QQ 群设计，具有基于 LLM 的对话能力、记忆系统和情感表达功能。 ## 关于文档此文档站点使用 [VitePress](https://vitepress.dev/) 构建，涵盖了安装、部署、配置以及开发（未完成） MaiBot 所需的所有内容。 ## 文档部分 ### 文档目录 - **安装指南** 提供标准版和新手友好版的安装步骤，帮助用户快速上手。 - **API 参考（未完成）** 详细介绍 MaiBot 提供的 API 接口及其使用方法。 - **部署方法** 涵盖多种部署方式，包括 Docker、Linux、Windows 和群晖 NAS。 - **常见问题解答和故障排除** 收录常见问题及其解决方案，帮助用户排查和解决问题。 - **文件结构和配置** 说明项目的文件结构及配置方法，便于用户自定义和扩展。 ## 本地开发 ### 本地部署要求使用Nodejs安装对应依赖 ```bash # 安装依赖 pnpm install # 启动开发服务器 pnpm docs:dev # 构建生产版本 pnpm docs:build # 预览生产版本 pnpm docs:preview ``` ## 贡献 ### 完整方式如果你想要修改文档，首先fork在修改后提出PR即可。如果你想要添加文件，在fork后添加你写的文档并放入对应目录（或者新建目录），修改各级的index.md使其包含您的文档。然后找到`.vitepress`下的`config.mts`文件，修改其中的导航使其能正确导航到你的文件。随后发起PR即可 ### 懒人方式如果你想要修改文档，首先fork在修改后提出PR即可。如果你想要添加文件，在fork后添加你写的文档并放入根目录，随后发起PR，说明你想放置的目录位置。若PR通过，我们会手动帮你配置各类目录