156 lines
6.9 KiB
Markdown
156 lines
6.9 KiB
Markdown
<div align="center">
|
|
|
|
<!-- Language Switcher -->
|
|
<a href="docs/README_CN.md">简体中文</a> | <a href="README.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> |
|
|
<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 -->
|
|
<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
|
|
|
|
|
|
|
|
### Star History
|
|
[](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
|