diff --git a/README.md b/README.md index 3f3851b7..57130a5b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ + +
- 简体中文 | English + 双语 / Bilingual | 中文 | English

-

MaiBot MaiSaka

+

麦麦 MaiBot MaiSaka

+ An interactive agent based on large language models.

@@ -25,24 +28,36 @@ MaiBot Character -## Introduction + -MaiSaka is an interactive agent based on large language models. +## 介绍 +Introduction -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. +麦麦 MaiSaka 是一个基于大语言模型的可交互智能体。 +MaiSaka is an interactive agent based on large language models. -- 💭 **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. -- 🔌 **Plugin system**: Provides powerful APIs and an event system with virtually unlimited room for extension. +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 格式的分点,而是或长或短的闲谈。 + 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. + +### 快速导航 +Quick Navigation -### Quick Navigation

- 🌟 Demo Video  |  - 📦 Quick Start  |  - 📃 Core Documentation  |  - 💬 Join Community + 🌟 演示视频 Demo Video  |  + 📦 快速入门 Quick Start  |  + 📃 核心文档 Core Documentation  |  + 💬 加入社区 Join Community

@@ -53,103 +68,143 @@ MaiSaka is more than just a bot, and more than a "helpful assistant" that comple - MaiSaka Demo Video + 麦麦演示视频
- Watch the MaiSaka demo video + 前往观看麦麦演示视频 / Watch the MaiSaka demo video
--- -## 🔥 Updates and Installation + -> **Latest Version: v1.0.0** ([📄 Changelog](changelogs/changelog.md)) +## 🔥 更新和安装 +Updates and Installation -- **Download**: Visit the [Release](https://github.com/MaiM-with-u/MaiBot/releases/) page to get the latest version. -- **Launcher**: [Mailauncher](https://github.com/MaiM-with-u/mailauncher/releases/) (MacOS only, still in early development). +> **最新版本: v1.0.0** ([📄 更新日志](changelogs/changelog.md)) +> Latest Version: v1.0.0 (📄 Changelog) -| Branch | Description | +- **下载**:前往 [Release](https://github.com/MaiM-with-u/MaiBot/releases/) 页面下载最新版本。 + Download: Visit the Release page to get the latest version. +- **启动器**:[Mailauncher](https://github.com/MaiM-with-u/mailauncher/releases/)(仅支持 MacOS,早期开发中)。 + Launcher: Mailauncher (MacOS only, still in early development). + +| 分支 / Branch | 说明 / Description | | :--- | :--- | -| `main` | ✅ **Stable release (recommended)** | -| `dev` | 🚧 Development testing branch with new features, may be unstable | +| `main` | ✅ **稳定发布版本(推荐)**
Stable release (recommended) | +| `dev` | 🚧 开发测试版本,包含新功能,可能不稳定
Development testing branch with new features, may be unstable | -### 📚 Deployment Guide -👉 **[🚀 Latest Deployment Guide](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html)** + + +### 📚 部署教程 +Deployment Guide + +👉 **[🚀 最新版本部署教程](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html)** +Latest Deployment Guide --- -## 💬 Discussion and Community + -We welcome everyone interested in MaiBot to join us. +## 💬 讨论与社区 +Discussion and Community -| Category | Group | Description | +我们欢迎所有对 MaiBot 感兴趣的朋友加入! +We welcome everyone interested in MaiBot to join us. + +| 类别 / Category | 群组 / Group | 说明 / Description | | :--- | :--- | :--- | -| **Technical** | [MaiBrain EEG](https://qm.qq.com/q/RzmCiRtHEW) | Technical discussion / Q&A | -| **Technical** | [MaiBrain MRI](https://qm.qq.com/q/VQ3XZrWgMs) | Technical discussion / Q&A | -| **Technical** | [Mai Wants to Be a VTuber](https://qm.qq.com/q/wGePTl1UyY) | Technical discussion / Q&A | -| **Casual Chat** | [Mai Casual Chat Group](https://qm.qq.com/q/JxvHZnxyec) | Casual chat only, no support | -| **Plugin Development** | [Plugin Dev Group](https://qm.qq.com/q/1036092828) | Advanced development and testing | +| **技术交流**
Technical | [麦麦脑电图](https://qm.qq.com/q/RzmCiRtHEW)
MaiBrain EEG | 技术交流 / 答疑
Technical discussion / Q&A | +| **技术交流**
Technical | [麦麦大脑磁共振](https://qm.qq.com/q/VQ3XZrWgMs)
MaiBrain MRI | 技术交流 / 答疑
Technical discussion / Q&A | +| **技术交流**
Technical | [麦麦要当 VTB](https://qm.qq.com/q/wGePTl1UyY)
Mai Wants to Be a VTuber | 技术交流 / 答疑
Technical discussion / Q&A | +| **闲聊吹水**
Casual Chat | [麦麦之闲聊群](https://qm.qq.com/q/JxvHZnxyec)
Mai Casual Chat Group | 仅限闲聊,不答疑
Casual chat only, no support | +| **插件开发**
Plugin Development | [插件开发群](https://qm.qq.com/q/1036092828)
Plugin Dev Group | 进阶开发与测试
Advanced development and testing | --- -## 📚 Documentation +## 📚 文档 +Documentation > [!NOTE] -> Some content may not be updated promptly, so please pay attention to version compatibility. +> 部分内容可能更新不够及时,请注意版本对应。 +> Some content may not be updated promptly, so please pay attention to version compatibility. -- **[📚 Core Wiki Documentation](https://docs.mai-mai.org)**: The most comprehensive documentation hub for everything about MaiSaka. +- **[📚 核心 Wiki 文档](https://docs.mai-mai.org)**:最全面的文档中心,了解麦麦的一切。 + 📚 Core Wiki Documentation: The most comprehensive documentation hub for everything about MaiSaka. -### 🧩 Related Projects +### 🧩 衍生项目 +Related Projects -- **[Amaidesu](https://github.com/MaiM-with-u/Amaidesu)**: Let MaiSaka stream on Bilibili. -- **[MoFox_Bot](https://github.com/MoFox-Studio/MoFox-Core)**: An enhanced fork based on MaiCore 0.10.0, with improved stability and more fun features. -- **[MaiCraft](https://github.com/MaiM-with-u/Maicraft)**: Let MaiSaka accompany you in Minecraft (currently paused). +- **[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, with improved stability and more fun features. +- **[MaiCraft](https://github.com/MaiM-with-u/Maicraft)**:让麦麦陪你玩 Minecraft(暂时停止维护中)。 + Let MaiSaka accompany you in Minecraft (currently paused). --- -## 💡 Design Philosophy +## 💡 设计理念 +Design Philosophy -> **SengokuCola says:** -> - 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." -> - 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. +> **千石可乐说:** +> SengokuCola says: +> - 这个项目最初只是为了给牛牛 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 says:** +> **xxxxx 说:** +> xxxxx says: > *Code is open, but the soul is yours.* --- -## 🙋 Contributing and Acknowledgments +## 🙋 贡献和致谢 +Contributing and Acknowledgments -Contributions are welcome. Please read the [Contribution Guide](docs-src/CONTRIBUTE.md) first. +欢迎参与贡献!请先阅读 [贡献指南](docs-src/CONTRIBUTE.md)。 +Contributions are welcome. Please read the Contribution Guide first. -### 🌟 Contributors +### 🌟 贡献者 +Contributors contributors -### ❤️ Special Thanks +### ❤️ 特别致谢 +Special Thanks -- **[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)**: A modern NTQQ-based bot protocol implementation. +- **[萨卡班甲鱼](https://en.wikipedia.org/wiki/Sacabambaspis)**:千石可乐很喜欢的生物。 + 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 +## 📊 仓库状态 +Repository Status -![Alt](https://repobeats.axiom.co/api/embed/9faca9fccfc467931b87dd357b60c6362b5cfae0.svg "MaiBot Repository Status") +![Alt](https://repobeats.axiom.co/api/embed/9faca9fccfc467931b87dd357b60c6362b5cfae0.svg "麦麦仓库状态") -### Star History -[![Star History](https://starchart.cc/MaiM-with-u/MaiBot.svg?variant=adaptive)](https://starchart.cc/MaiM-with-u/MaiBot) +### Star 趋势 +Star History + +[![Star 趋势](https://starchart.cc/MaiM-with-u/MaiBot.svg?variant=adaptive)](https://starchart.cc/MaiM-with-u/MaiBot) --- -## 📌 Notice & License +## 📌 注意事项 & License +Notice & License > [!IMPORTANT] -> Please read the [End User License Agreement (EULA)](EULA.md) and [Privacy Policy](PRIVACY.md) before use. Please evaluate AI-generated content carefully. +> 使用前请阅读 [用户协议 (EULA)](EULA.md) 和 [隐私协议](PRIVACY.md)。AI 生成内容请仔细甄别。 +> Please read the End User License Agreement (EULA) and Privacy Policy before use. Please evaluate AI-generated content carefully. **License**: GPL-3.0