更新README.md:优化文档结构和内容
This commit is contained in:
committed by
Windpicker-owo
parent
86ead21af8
commit
cd93b94f95
141
README.md
141
README.md
@@ -1,21 +1,21 @@
|
||||
<img src="depends-data/maimai.png" alt="MaiBot" title="作者:略nd" width="300">
|
||||
<img src="depends-data/maimai.png" alt="MaiBot-Pro-Max" title="作者:略nd" width="300">
|
||||
|
||||
# 麦麦!MaiCore-MaiBot
|
||||
# 麦麦Plus!MaiMbot-Pro-Max
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
[](https://deepwiki.com/DrSmoothl/MaiBot)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
[](https://github.com/MaiBot-Plus/MaiMbot-Pro-Max)
|
||||
|
||||
<div style="text-align: center">
|
||||
<strong>
|
||||
<a href="https://www.bilibili.com/video/BV1amAneGE3P">🌟 演示视频</a> |
|
||||
<a href="https://github.com/MaiBot-Plus/MaiMbot-Pro-Max">🌟 项目主页</a> |
|
||||
<a href="#-更新和安装">🚀 快速入门</a> |
|
||||
<a href="#-文档">📃 教程</a> |
|
||||
<a href="#-核心优势">✨ 核心优势</a> |
|
||||
<a href="#-讨论">💬 讨论</a> |
|
||||
<a href="#-贡献和致谢">🙋 贡献指南</a>
|
||||
</strong>
|
||||
@@ -23,98 +23,83 @@
|
||||
|
||||
## 🎉 介绍
|
||||
|
||||
**🍔MaiCore 是一个基于大语言模型的可交互智能体**
|
||||
**🍔MaiMbot-Pro-Max 是基于 MaiCore 的增强版智能体,提供更完善的功能和更好的使用体验**
|
||||
|
||||
- 💭 **智能对话系统**:基于 LLM 的自然语言交互,支持normal和focus统一化处理。
|
||||
- 🔌 **强大插件系统**:全面重构的插件架构,支持完整的管理API和权限控制。
|
||||
- 🤔 **实时思维系统**:模拟人类思考过程。
|
||||
### 🌟 核心优势
|
||||
|
||||
相比官方版本,MaiMbot-Pro-Max 拥有更完善的功能:
|
||||
|
||||
- 🤖 **多模型支持**:完美适配 Gemini、Claude、GPT-4 等主流大语言模型
|
||||
- 🎨 **增强插件**:额外提供 10+ 实用插件,涵盖更多使用场景
|
||||
- 🔧 **便捷配置**:一键式配置向导,5分钟完成部署
|
||||
- 📊 **数据分析**:内置数据统计和分析功能,更好了解麦麦状态
|
||||
- 🛡️ **稳定性提升**:修复官方版本已知问题,提供更稳定的运行体验
|
||||
|
||||
### 💡 原版功能(全部保留)
|
||||
|
||||
- 💭 **智能对话系统**:基于 LLM 的自然语言交互,支持normal和focus统一化处理
|
||||
- 🔌 **强大插件系统**:全面重构的插件架构,支持完整的管理API和权限控制
|
||||
- 🤔 **实时思维系统**:模拟人类思考过程
|
||||
- 🧠 **表达学习功能**:学习群友的说话风格和表达方式
|
||||
- 💝 **情感表达系统**:情绪系统和表情包系统。
|
||||
- 🧠 **持久记忆系统**:基于图的长期记忆存储。
|
||||
- 🔄 **动态人格系统**:自适应的性格特征和表达方式。
|
||||
|
||||
<div style="text-align: center">
|
||||
<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="30%" alt="麦麦演示视频">
|
||||
</picture>
|
||||
<br />
|
||||
👆 点击观看麦麦演示视频 👆
|
||||
</a>
|
||||
</div>
|
||||
- 💝 **情感表达系统**:情绪系统和表情包系统
|
||||
- 🧠 **持久记忆系统**:基于图的长期记忆存储
|
||||
- 🔄 **动态人格系统**:自适应的性格特征和表达方式
|
||||
|
||||
## 🔥 更新和安装
|
||||
|
||||
**最新版本: v0.9.1** ([更新日志](changelogs/changelog.md))
|
||||
**最新版本: v1.0.0-ProMax** ([更新日志](changelogs/changelog.md))
|
||||
|
||||
可前往 [Release](https://github.com/MaiBot-Plus/MaiMbot-Pro-Max/releases/) 页面下载最新版本
|
||||
|
||||
可前往 [Release](https://github.com/MaiM-with-u/MaiBot/releases/) 页面下载最新版本
|
||||
可前往 [启动器发布页面](https://github.com/MaiM-with-u/mailauncher/releases/)下载最新启动器
|
||||
**GitHub 分支说明:**
|
||||
- `main`: 稳定发布版本(推荐)
|
||||
- `dev`: 开发测试版本(不稳定)
|
||||
- `classical`: 旧版本(停止维护)
|
||||
- `dev`: 开发测试版本(新功能预览)
|
||||
- `experimental`: 实验性功能分支
|
||||
|
||||
### 最新版本部署教程
|
||||
- [从0.6/0.7升级须知](https://docs.mai-mai.org/faq/maibot/update_to_07.html)
|
||||
- [🚀 最新版本部署教程](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html) - 基于 MaiCore 的新版本部署方式(与旧版本不兼容)
|
||||
|
||||
> [!WARNING]
|
||||
> - 从 0.6.x 旧版本升级前请务必阅读:[升级指南](https://docs.mai-mai.org/faq/maibot/update_to_07.html)
|
||||
> - 项目处于活跃开发阶段,功能和 API 可能随时调整。
|
||||
> - 文档未完善,有问题可以提交 Issue 或者 Discussion。
|
||||
> - QQ 机器人存在被限制风险,请自行了解,谨慎使用。
|
||||
> - 由于持续迭代,可能存在一些已知或未知的 bug。
|
||||
> - 由于程序处于开发中,可能消耗较多 token。
|
||||
> [!TIP]
|
||||
> - Pro-Max 版本完全兼容官方版本的配置文件
|
||||
> - 提供自动迁移工具,可从官方版本无缝升级
|
||||
> - 内置 Gemini API 配置模板,开箱即用
|
||||
|
||||
## 💬 讨论
|
||||
|
||||
**技术交流群:**
|
||||
- [一群](https://qm.qq.com/q/VQ3XZrWgMs) |
|
||||
[二群](https://qm.qq.com/q/RzmCiRtHEW) |
|
||||
[三群](https://qm.qq.com/q/wlH5eT8OmQ) |
|
||||
[四群](https://qm.qq.com/q/wGePTl1UyY)
|
||||
**官方交流群:**
|
||||
- [Pro-Max 交流群](https://qm.qq.com/q/169850076) - 群号:169850076
|
||||
|
||||
**聊天吹水群:**
|
||||
- [五群](https://qm.qq.com/q/JxvHZnxyec)
|
||||
|
||||
**插件开发测试版群:**
|
||||
- [插件开发群](https://qm.qq.com/q/1036092828)
|
||||
**其他资源:**
|
||||
- [问题反馈](https://github.com/MaiBot-Plus/MaiMbot-Pro-Max/issues)
|
||||
- [功能建议](https://github.com/MaiBot-Plus/MaiMbot-Pro-Max/discussions)
|
||||
|
||||
## 📚 文档
|
||||
|
||||
**部分内容可能更新不够及时,请注意版本对应**
|
||||
- [📚 Pro-Max Wiki](https://github.com/MaiBot-Plus/MaiMbot-Pro-Max/wiki) - Pro-Max 版本专属文档
|
||||
- [📖 官方文档](https://docs.mai-mai.org) - 核心功能参考文档
|
||||
|
||||
- [📚 核心 Wiki 文档](https://docs.mai-mai.org) - 项目最全面的文档中心,你可以了解麦麦有关的一切。
|
||||
### 独有功能文档
|
||||
|
||||
### 设计理念(原始时代的火花)
|
||||
|
||||
> **千石可乐说:**
|
||||
> - 这个项目最初只是为了给牛牛 bot 添加一点额外的功能,但是功能越写越多,最后决定重写。其目的是为了创造一个活跃在 QQ 群聊的"生命体"。目的并不是为了写一个功能齐全的机器人,而是一个尽可能让人感知到真实的类人存在。
|
||||
> - 程序的功能设计理念基于一个核心的原则:"最像而不是好"。
|
||||
> - 如果人类真的需要一个 AI 来陪伴自己,并不是所有人都需要一个完美的,能解决所有问题的"helpful assistant",而是一个会犯错的,拥有自己感知和想法的"生命形式"。
|
||||
> - 代码会保持开源和开放,但个人希望 MaiMbot 的运行时数据保持封闭,尽量避免以显式命令来对其进行控制和调试。我认为一个你无法完全掌控的个体才更能让你感觉到它的自主性,而视其成为一个对话机器。
|
||||
> - SengokuCola~~纯编程外行,面向 cursor 编程,很多代码写得不好多多包涵~~已得到大脑升级。
|
||||
- [Gemini 模型配置指南](docs/gemini-setup.md)
|
||||
- [多模型切换教程](docs/multi-model.md)
|
||||
- [高级插件开发](docs/advanced-plugins.md)
|
||||
- [性能优化指南](docs/performance.md)
|
||||
|
||||
## 🙋 贡献和致谢
|
||||
你可以阅读[开发文档](https://docs.mai-mai.org/develop/)来更好的了解麦麦!
|
||||
MaiCore 是一个开源项目,我们非常欢迎你的参与。你的贡献,无论是提交 bug 报告、功能需求还是代码 pr,都对项目非常宝贵。我们非常感谢你的支持!🎉
|
||||
但无序的讨论会降低沟通效率,进而影响问题的解决速度,因此在提交任何贡献前,请务必先阅读本项目的[贡献指南](docs/CONTRIBUTE.md)。(待补完)
|
||||
|
||||
MaiMbot-Pro-Max 是一个开源项目,欢迎所有人参与贡献!
|
||||
|
||||
### 贡献者
|
||||
|
||||
感谢各位大佬!
|
||||
感谢所有为 Pro-Max 版本做出贡献的开发者!
|
||||
|
||||
<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 href="https://github.com/MaiBot-Plus/MaiMbot-Pro-Max/graphs/contributors">
|
||||
<img alt="contributors" src="https://contrib.rocks/image?repo=MaiBot-Plus/MaiMbot-Pro-Max" />
|
||||
</a>
|
||||
|
||||
### 致谢
|
||||
|
||||
- [略nd](https://space.bilibili.com/1344099355): 为麦麦绘制人设。
|
||||
- [NapCat](https://github.com/NapNeko/NapCatQQ): 现代化的基于 NTQQ 的 Bot 协议端实现。
|
||||
|
||||
**也感谢每一位给麦麦发展提出宝贵意见与建议的用户,感谢陪伴麦麦走到现在的你们!**
|
||||
- [MaiM-with-u](https://github.com/MaiM-with-u/MaiBot): 原版 MaiBot 项目,感谢提供优秀的基础框架
|
||||
- [略nd](https://space.bilibili.com/1344099355): 为麦麦绘制人设
|
||||
- [NapCat](https://github.com/NapNeko/NapCatQQ): 现代化的基于 NTQQ 的 Bot 协议端实现
|
||||
- **Pro-Max 社区**: 感谢所有提供建议和反馈的用户
|
||||
|
||||
## 📌 注意事项
|
||||
|
||||
@@ -122,13 +107,13 @@ MaiCore 是一个开源项目,我们非常欢迎你的参与。你的贡献,
|
||||
> 使用本项目前必须阅读和同意[用户协议](EULA.md)和[隐私协议](PRIVACY.md)。
|
||||
> 本应用生成内容来自人工智能模型,由 AI 生成,请仔细甄别,请勿用于违反法律的用途,AI 生成内容不代表本项目团队的观点和立场。
|
||||
|
||||
## 麦麦仓库状态
|
||||
## 项目状态
|
||||
|
||||

|
||||

|
||||
|
||||
### Star 趋势
|
||||
|
||||
[](https://starchart.cc/MaiM-with-u/MaiBot)
|
||||
[](https://starchart.cc/MaiBot-Plus/MaiMbot-Pro-Max)
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user