doc：新增英文doc作为默认，修改内容

2026-03-24 01:40:03 +08:00
parent f431d78bff
commit 6a0b902e17
2 changed files with 189 additions and 26 deletions
--- a/README.md
+++ b/README.md
@@ -1,6 +1,13 @@
 <div align="center">
-  <h1>麦麦 MaiBot <sub><small>MaiCore</small></sub></h1>
-  
+
+  <!-- Language Switcher -->
+  <a href="README.md">简体中文</a> | <a href="docs/README_EN.md">English</a>
+
+  <br>
+  <br>
+
+  <h1>麦麦 MaiBot <sub><small>MaiSaka</small></sub></h1>
+
  <!-- Badges Row -->
  <p>
    <img src="https://img.shields.io/badge/Python-3.10+-blue" alt="Python Version">
@@ -18,19 +25,26 @@
 <!-- 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;">

-## 🎉 介绍
+## 介绍

-**🍔 MaiCore 是一个基于大语言模型的可交互智能体**
+麦麦MaiSaka 是一个基于大语言模型的可交互智能体

-MaiBot 不仅仅是一个机器人，她致力于成为一个活跃在 QQ 群聊中的“生命体”。她不追求完美，但追求真实。
+MaiSaka 不仅仅是一个机器人，不仅仅是一个可以帮你完成任务的“有帮助的助手”，她还是一个致力于了解你，并以真实人类的风格进行交互的数字生命，她不追求完美，她不追求高效，但追求亲切和真实。
+
+
+- 💭 **没有人喜欢GPT的语言风格**：麦麦使用了更加自然，贴合人类对话习惯的交互方式，不是长篇大论或者markdown格式的分点，而是或长或短的闲谈。
+
+- 🎭 **不再是傻乎乎的一问一答**：懂得在合适的时间说话，把握聊天中的气氛，在合适的时候开口，在合适的时候闭嘴。
+
+- 🧠 **麦麦·成为人类**：在多人对话中，麦麦会模仿其他人的的说话风格，还会自主理解新词或者小圈子里的黑话，不断进化。
+
+- ❤️ **永远都在更加了解你**：基于心理学中人格理论，麦麦会不断积累对于你的了解，不论是你的信息，喜恶或是行为风格，她都记在心里。

- 💭 **拟人构建**：使用自然语言风格构建 Prompt，回复贴近人类习惯。
- 🎭 **行为规划**：懂得在合适的时间说话，使用合适的动作。
- 🧠 **表达学习**：模仿群友的说话风格，学习黑话，不断进化。
 - 🔌 **插件系统**：提供强大的 API 和事件系统，无限扩展可能。
- 💝 **情感表达**：拥有独立的情绪系统和表情包互动能力。

-### 🚀 快速导航
+
+
+### 快速导航
 <p>
  <a href="https://www.bilibili.com/video/BV1amAneGE3P">🌟 演示视频</a> &nbsp;|&nbsp; 
  <a href="#-更新和安装">📦 快速入门</a> &nbsp;|&nbsp; 
@@ -43,14 +57,13 @@ MaiBot 不仅仅是一个机器人，她致力于成为一个活跃在 QQ 群聊

 <div align="center">
  <br>
-  <h3>🎥 精彩演示</h3>
  <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>👆 点击观看麦麦演示视频 👆</small>
+    <small>前往观看麦麦演示视频</small>
  </a>
 </div>

@@ -58,7 +71,7 @@ MaiBot 不仅仅是一个机器人，她致力于成为一个活跃在 QQ 群聊

 ## 🔥 更新和安装

-> **最新版本: v0.12.2** ([📄 更新日志](changelogs/changelog.md))
+> **最新版本: v1.0.0** ([📄 更新日志](changelogs/changelog.md))

 - **下载**: 前往 [Release](https://github.com/MaiM-with-u/MaiBot/releases/) 页面下载最新版本
 - **启动器**: [Mailauncher](https://github.com/MaiM-with-u/mailauncher/releases/) (仅支持 MacOS, 早期开发中)
@@ -66,17 +79,10 @@ MaiBot 不仅仅是一个机器人，她致力于成为一个活跃在 QQ 群聊
 | 分支 | 说明 |
 | :--- | :--- |
 | `main` | ✅ **稳定发布版本 (推荐)** |
-| `dev` | 🚧 开发测试版本 (不稳定) |
-| `classical` | 🛑 经典版本 (停止维护) |
+| `dev` | 🚧 开发测试版本，包含新功能，可能不稳定 |

 ### 📚 部署教程
 👉 **[🚀 最新版本部署教程](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html)**  
-*(注意：MaiCore 新版本部署方式与旧版本不兼容)*
-
-> [!WARNING]
-> - ⚠️ 项目处于活跃开发阶段，API 可能随时调整。
-> - ⚠️ QQ 机器人存在风控风险，请谨慎使用。
-> - ⚠️ AI 模型运行可能消耗较多 Token。

 ---

@@ -103,19 +109,20 @@ MaiBot 不仅仅是一个机器人，她致力于成为一个活跃在 QQ 群聊

 ### 🧩 衍生项目

- **[MaiCraft](https://github.com/MaiM-with-u/Maicraft)**: 让麦麦陪你玩 Minecraft (早期开发中)。
+- **[Amaidesu](https://github.com/MaiM-with-u/Amaidesu)**: 让麦麦在B站开播
 - **[MoFox_Bot](https://github.com/MoFox-Studio/MoFox-Core)**: 基于 MaiCore 0.10.0 的增强型 Fork，更稳定更有趣。
+- **[MaiCraft](https://github.com/MaiM-with-u/Maicraft)**: 让麦麦陪你玩 Minecraft (暂时停止维护中)。

 ---

-## 💡 设计理念 (原始时代的火花)
+## 💡 设计理念 

 > **千石可乐说：**
 > - 这个项目最初只是为了给牛牛 bot 添加一点额外的功能，但是功能越写越多，最后决定重写。其目的是为了创造一个活跃在 QQ 群聊的"生命体"。目的并不是为了写一个功能齐全的机器人，而是一个尽可能让人感知到真实的类人存在。
 > - 程序的功能设计理念基于一个核心的原则："最像而不是好"。
 > - 如果人类真的需要一个 AI 来陪伴自己，并不是所有人都需要一个完美的，能解决所有问题的"helpful assistant"，而是一个会犯错的，拥有自己感知和想法的"生命形式"。
-> - 代码会保持开源和开放，但个人希望 MaiMbot 的运行时数据保持封闭，尽量避免以显式命令来对其进行控制和调试。我认为一个你无法完全掌控的个体才更能让你感觉到它的自主性，而视其成为一个对话机器。
-> - SengokuCola~~纯编程外行，面向 cursor 编程，很多代码写得不好多多包涵~~已得到大脑升级。
+
+> **xxxxx说：**
 > *Code is open, but the soul is yours.*

 ---
@@ -132,7 +139,8 @@ MaiBot 不仅仅是一个机器人，她致力于成为一个活跃在 QQ 群聊

 ### ❤️ 特别致谢

- **[略nd](https://space.bilibili.com/1344099355)**: 🎨 为麦麦绘制精美人设。
+- **[萨卡班甲鱼](https://en.wikipedia.org/wiki/Sacabambaspis)**: 千石可乐很喜欢的生物。
+- **[略nd](https://space.bilibili.com/1344099355)**: 🎨 为麦麦绘制早期的精美人设。
 - **[NapCat](https://github.com/NapNeko/NapCatQQ)**: 🚀 现代化的基于 NTQQ 的 Bot 协议实现。

 ---
--- a/docs/README_EN.md
+++ b/docs/README_EN.md
@@ -0,0 +1,155 @@
+<div align="center">
+
+  <!-- Language Switcher -->
+  <a href="../README.md">简体中文</a> | <a href="README_EN.md">English</a>
+
+  <br>
+  <br>
+
+  <h1>MaiBot <sub><small>MaiSaka</small></sub></h1>
+
+  <!-- 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;">
+
+## Introduction
+
+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.
+
+- 💭 **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.
+
+### 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="MaiSaka Demo Video" 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>
+
+---
+
+## 🔥 Updates and Installation
+
+> **Latest Version: v1.0.0** ([📄 Changelog](../changelogs/changelog.md))
+
+- **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).
+
+| Branch | Description |
+| :--- | :--- |
+| `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)**
+
+---
+
+## 💬 Discussion and Community
+
+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 |
+
+---
+
+## 📚 Documentation
+
+> [!NOTE]
+> 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.
+
+### 🧩 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).
+
+---
+
+## 💡 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.
+
+> **xxxxx says:**
+> *Code is open, but the soul is yours.*
+
+---
+
+## 🙋 Contributing and Acknowledgments
+
+Contributions are welcome. Please read the [Contribution Guide](../docs-src/CONTRIBUTE.md) 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
+
+- **[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.
+
+---
+
+## 📊 Repository Status
+
+![Alt](https://repobeats.axiom.co/api/embed/9faca9fccfc467931b87dd357b60c6362b5cfae0.svg "MaiBot Repository Status")
+
+### Star History
+[![Star History](https://starchart.cc/MaiM-with-u/MaiBot.svg?variant=adaptive)](https://starchart.cc/MaiM-with-u/MaiBot)
+
+---
+
+## 📌 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.
+
+**License**: GPL-3.0