更改文件结构
This commit is contained in:
137
README.md
137
README.md
@@ -1,21 +1,21 @@
|
||||
<div align="center">
|
||||
|
||||
<!-- Language Switcher -->
|
||||
<a href="README.md">简体中文</a> | <a href="docs/README_EN.md">English</a>
|
||||
<a href="docs/README_CN.md">简体中文</a> | <a href="README.md">English</a>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<h1>麦麦 MaiBot <sub><small>MaiSaka</small></sub></h1>
|
||||
<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=%E5%8D%8F%E8%AE%AE" alt="License">
|
||||
<img src="https://img.shields.io/badge/状态-开发中-yellow" alt="Status">
|
||||
<img src="https://img.shields.io/github/contributors/Mai-with-u/MaiBot.svg?style=flat&label=%E8%B4%A1%E7%8C%AE%E8%80%85" alt="Contributors">
|
||||
<img src="https://img.shields.io/github/forks/Mai-with-u/MaiBot.svg?style=flat&label=%E5%88%86%E6%94%AF%E6%95%B0" alt="Forks">
|
||||
<img src="https://img.shields.io/github/stars/Mai-with-u/MaiBot?style=flat&label=%E6%98%9F%E6%A0%87%E6%95%B0" alt="Stars">
|
||||
<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>
|
||||
@@ -25,31 +25,24 @@
|
||||
<!-- 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 是一个基于大语言模型的可交互智能体
|
||||
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.
|
||||
|
||||
- 💭 **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.
|
||||
|
||||
- 💭 **没有人喜欢GPT的语言风格**:麦麦使用了更加自然,贴合人类对话习惯的交互方式,不是长篇大论或者markdown格式的分点,而是或长或短的闲谈。
|
||||
|
||||
- 🎭 **不再是傻乎乎的一问一答**:懂得在合适的时间说话,把握聊天中的气氛,在合适的时候开口,在合适的时候闭嘴。
|
||||
|
||||
- 🧠 **麦麦·成为人类**:在多人对话中,麦麦会模仿其他人的的说话风格,还会自主理解新词或者小圈子里的黑话,不断进化。
|
||||
|
||||
- ❤️ **永远都在更加了解你**:基于心理学中人格理论,麦麦会不断积累对于你的了解,不论是你的信息,喜恶或是行为风格,她都记在心里。
|
||||
|
||||
- 🔌 **插件系统**:提供强大的 API 和事件系统,无限扩展可能。
|
||||
|
||||
|
||||
|
||||
### 快速导航
|
||||
### Quick Navigation
|
||||
<p>
|
||||
<a href="https://www.bilibili.com/video/BV1amAneGE3P">🌟 演示视频</a> |
|
||||
<a href="#-更新和安装">📦 快速入门</a> |
|
||||
<a href="#-部署教程">📃 核心文档</a> |
|
||||
<a href="#-讨论与社区">💬 加入社区</a>
|
||||
<a href="https://www.bilibili.com/video/BV1amAneGE3P">🌟 Demo Video</a> |
|
||||
<a href="#-updates-and-installation">📦 Quick Start</a> |
|
||||
<a href="#-deployment-guide">📃 Core Documentation</a> |
|
||||
<a href="#-discussion-and-community">💬 Join Community</a>
|
||||
</p>
|
||||
|
||||
<!-- Clear float to ensure subsequent content starts below the image area if text is short -->
|
||||
@@ -60,103 +53,103 @@ MaiSaka 不仅仅是一个机器人,不仅仅是一个可以帮你完成任务
|
||||
<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);">
|
||||
<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>前往观看麦麦演示视频</small>
|
||||
<small>Watch the MaiSaka demo video</small>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🔥 更新和安装
|
||||
## 🔥 Updates and Installation
|
||||
|
||||
> **最新版本: v1.0.0** ([📄 更新日志](changelogs/changelog.md))
|
||||
> **Latest Version: v1.0.0** ([📄 Changelog](changelogs/changelog.md))
|
||||
|
||||
- **下载**: 前往 [Release](https://github.com/MaiM-with-u/MaiBot/releases/) 页面下载最新版本
|
||||
- **启动器**: [Mailauncher](https://github.com/MaiM-with-u/mailauncher/releases/) (仅支持 MacOS, 早期开发中)
|
||||
- **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` | ✅ **稳定发布版本 (推荐)** |
|
||||
| `dev` | 🚧 开发测试版本,包含新功能,可能不稳定 |
|
||||
| `main` | ✅ **Stable release (recommended)** |
|
||||
| `dev` | 🚧 Development testing branch with new features, may be unstable |
|
||||
|
||||
### 📚 部署教程
|
||||
👉 **[🚀 最新版本部署教程](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html)**
|
||||
### 📚 Deployment Guide
|
||||
👉 **[🚀 Latest Deployment Guide](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html)**
|
||||
|
||||
---
|
||||
|
||||
## 💬 讨论与社区
|
||||
## 💬 Discussion and Community
|
||||
|
||||
我们欢迎所有对 MaiBot 感兴趣的朋友加入!
|
||||
We welcome everyone interested in MaiBot to join us.
|
||||
|
||||
| 类别 | 群组 | 说明 |
|
||||
| Category | Group | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **技术交流** | [麦麦脑电图](https://qm.qq.com/q/RzmCiRtHEW) | 技术交流/答疑 |
|
||||
| **技术交流** | [麦麦大脑磁共振](https://qm.qq.com/q/VQ3XZrWgMs) | 技术交流/答疑 |
|
||||
| **技术交流** | [麦麦要当VTB](https://qm.qq.com/q/wGePTl1UyY) | 技术交流/答疑 |
|
||||
| **闲聊吹水** | [麦麦之闲聊群](https://qm.qq.com/q/JxvHZnxyec) | 仅限闲聊,不答疑 |
|
||||
| **插件开发** | [插件开发群](https://qm.qq.com/q/1036092828) | 进阶开发与测试 |
|
||||
| **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.
|
||||
|
||||
- **[📚 核心 Wiki 文档](https://docs.mai-mai.org)**: 最全面的文档中心,了解麦麦的一切。
|
||||
- **[📚 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)**: 让麦麦在B站开播
|
||||
- **[MoFox_Bot](https://github.com/MoFox-Studio/MoFox-Core)**: 基于 MaiCore 0.10.0 的增强型 Fork,更稳定更有趣。
|
||||
- **[MaiCraft](https://github.com/MaiM-with-u/Maicraft)**: 让麦麦陪你玩 Minecraft (暂时停止维护中)。
|
||||
- **[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
|
||||
|
||||
> **千石可乐说:**
|
||||
> - 这个项目最初只是为了给牛牛 bot 添加一点额外的功能,但是功能越写越多,最后决定重写。其目的是为了创造一个活跃在 QQ 群聊的"生命体"。目的并不是为了写一个功能齐全的机器人,而是一个尽可能让人感知到真实的类人存在。
|
||||
> - 程序的功能设计理念基于一个核心的原则:"最像而不是好"。
|
||||
> - 如果人类真的需要一个 AI 来陪伴自己,并不是所有人都需要一个完美的,能解决所有问题的"helpful assistant",而是一个会犯错的,拥有自己感知和想法的"生命形式"。
|
||||
> **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说:**
|
||||
> **xxxxx says:**
|
||||
> *Code is open, but the soul is yours.*
|
||||
|
||||
---
|
||||
|
||||
## 🙋 贡献和致谢
|
||||
## 🙋 Contributing and Acknowledgments
|
||||
|
||||
欢迎参与贡献!请先阅读 [贡献指南](docs-src/CONTRIBUTE.md)。
|
||||
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
|
||||
|
||||
- **[萨卡班甲鱼](https://en.wikipedia.org/wiki/Sacabambaspis)**: 千石可乐很喜欢的生物。
|
||||
- **[略nd](https://space.bilibili.com/1344099355)**: 🎨 为麦麦绘制早期的精美人设。
|
||||
- **[NapCat](https://github.com/NapNeko/NapCatQQ)**: 🚀 现代化的基于 NTQQ 的 Bot 协议实现。
|
||||
- **[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
|
||||
|
||||

|
||||

|
||||
|
||||
### Star 趋势
|
||||
[](https://starchart.cc/MaiM-with-u/MaiBot)
|
||||
### Star History
|
||||
[](https://starchart.cc/MaiM-with-u/MaiBot)
|
||||
|
||||
---
|
||||
|
||||
## 📌 注意事项 & 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
|
||||
|
||||
Reference in New Issue
Block a user