From e067384985dc64dda2d5fcabf4ed9fbd4f510892 Mon Sep 17 00:00:00 2001 From: Dreamwxz Date: Fri, 16 May 2025 17:52:33 +0800 Subject: [PATCH] =?UTF-8?q?=E5=B0=86=E6=96=87=E4=BB=B6=E5=85=A8=E9=83=A8?= =?UTF-8?q?=E5=BD=92=E8=BF=9Bdocs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 146 ++++-------------- changelogs/changelog_dev.md | 27 ---- {src => docs}/0.6Bing.md | 0 {depends-data => docs}/CONTRIBUTE.md | 0 .../HeartFC_chatting_logic.md | 0 .../HeartFC_readme.md | 0 src/README.md => docs/HeartFC_system.md | 0 .../README.md => docs/use_tool.md | 0 8 files changed, 34 insertions(+), 139 deletions(-) delete mode 100644 changelogs/changelog_dev.md rename {src => docs}/0.6Bing.md (100%) rename {depends-data => docs}/CONTRIBUTE.md (100%) rename src/heartFC_chatting_logic.md => docs/HeartFC_chatting_logic.md (100%) rename src/heartFC_readme.md => docs/HeartFC_readme.md (100%) rename src/README.md => docs/HeartFC_system.md (100%) rename src/tools/tool_can_use/README.md => docs/use_tool.md (100%) diff --git a/README.md b/README.md index 17a8da37b..98a8076ac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# 麦麦！MaiCore-MaiMBot (编辑中) -
-
+# 麦麦！MaiCore-MaiBot (编辑中) + + + MaiBot + ![Python Version](https://img.shields.io/badge/Python-3.10+-blue) ![License](https://img.shields.io/github/license/SengokuCola/MaiMBot?label=协议) @@ -10,40 +12,14 @@ ![stars](https://img.shields.io/github/stars/MaiM-with-u/MaiBot?style=flat&label=星标数) ![issues](https://img.shields.io/github/issues/MaiM-with-u/MaiBot) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/DrSmoothl/MaiBot) + + 🌟 案例展示 | 🚀 快速入门 | 📃 教程 | 💬 讨论 | 🙋 常见问题
-

- - Logo - -
- - 画师：略nd - - -

MaiBot(麦麦)

-

- 一款专注于 群组聊天 的赛博网友 -
- 探索本项目的文档 » -
-
- - 报告Bug - · - 提出新特性 -

-

- -## 新版0.6.x部署前先阅读：https://docs.mai-mai.org/faq/maibot/backup_update.html - - ## 📝 项目简介 **🍔MaiCore是一个基于大语言模型的可交互智能体** - - 💭 **智能对话系统**：基于LLM的自然语言交互 - 🤔 **实时思维系统**：模拟人类思考过程 - 💝 **情感表达系统**：丰富的表情包和情绪表达 @@ -58,49 +34,29 @@ - ### 📢 版本信息 -**最新版本: v0.6.3** ([查看更新日志](changelogs/changelog.md)) -> [!WARNING] -> 请阅读教程后更新！！！！！！！ -> 请阅读教程后更新！！！！！！！ -> 请阅读教程后更新！！！！！！！ -> 次版本MaiBot将基于MaiCore运行，不再依赖于nonebot相关组件运行。 -> MaiBot将通过nonebot的插件与nonebot建立联系，然后nonebot与QQ建立联系，实现MaiBot与QQ的交互 +**最新版本: v0.6.3** ([更新日志](changelogs/changelog.md)) -**分支说明：** +**GitHub分支说明：** - `main`: 稳定发布版本 -- `dev`: 开发测试版本（不知道什么意思就别下） -- `classical`: 0.6.0之前的版本 - - - -> [!WARNING] -> - 项目处于活跃开发阶段，代码可能随时更改 -> - 文档未完善，有问题可以提交 Issue 或者 Discussion -> - QQ机器人存在被限制风险，请自行了解，谨慎使用 -> - 由于持续迭代，可能存在一些已知或未知的bug -> - 由于开发中，可能消耗较多token +- `dev`: 开发测试版本（不稳定） +- `classical`: 0.6.0之前的版本(停止维护) ### ⚠️ 重要提示 -- 升级到v0.6.x版本前请务必阅读：[升级指南](https://docs.mai-mai.org/faq/maibot/backup_update.html) -- 本版本基于MaiCore重构，通过nonebot插件与QQ平台交互 -- 项目处于活跃开发阶段，功能和API可能随时调整 - -### 💬交流群（开发和建议相关讨论）不一定有空回复，会优先写文档和代码 -- [一群](https://qm.qq.com/q/VQ3XZrWgMs) 766798517 -- [二群](https://qm.qq.com/q/RzmCiRtHEW) 571780722 -- [五群](https://qm.qq.com/q/JxvHZnxyec) 1022489779 -- [三群](https://qm.qq.com/q/wlH5eT8OmQ) 1035228475【已满】 -- [四群](https://qm.qq.com/q/wGePTl1UyY) 729957033【已满】 - +- 从0.5.x旧版本升级前请请务必阅读：[升级指南](https://docs.mai-mai.org/faq/maibot/backup_update.html) +- 项目处于活跃开发阶段，功能和API可能随时调整。 +- 文档未完善，有问题可以提交 Issue 或者 Discussion。 +- QQ机器人存在被限制风险，请自行了解，谨慎使用。 +- 由于持续迭代，可能存在一些已知或未知的bug。 +- 由于程序处于开发中，可能消耗较多token。 +### 💬交流群 +- [一群](https://qm.qq.com/q/VQ3XZrWgMs) | [二群](https://qm.qq.com/q/RzmCiRtHEW) | [五群](https://qm.qq.com/q/JxvHZnxyec) | [三群](https://qm.qq.com/q/wlH5eT8OmQ)(已满)| [四群](https://qm.qq.com/q/wGePTl1UyY)(已满) ## 📚 文档 - ### (部分内容可能过时，请注意版本对应) ### 核心文档 @@ -109,45 +65,9 @@ ### 最新版本部署教程(MaiCore版本) - [🚀 最新版本部署教程](https://docs.mai-mai.org/manual/deployment/mmc_deploy_windows.html) - 基于MaiCore的新版本部署方式（与旧版本不兼容） - -## 🎯 0.6.3 功能介绍 - -| 模块 | 主要功能 | 特点 | -|----------|------------------------------------------------------------------|-------| -| 💬 聊天系统 | • **统一调控不同回复逻辑**
• 智能交互模式 (普通聊天/专注聊天)
• 关键词主动发言
• 多模型支持
• 动态prompt构建
• 私聊功能(PFC)增强 | 拟人化交互 | -| 🧠 心流系统 | • 实时思考生成
• **智能状态管理**
• **概率回复机制**
• 自动启停机制
• 日程系统联动
• **上下文感知工具调用** | 智能化决策 | -| 🧠 记忆系统 | • **记忆整合与提取**
• 海马体记忆机制
• 聊天记录概括 | 持久化记忆 | -| 😊 表情系统 | • **全新表情包系统**
• **优化选择逻辑**
• 情绪匹配发送
• GIF支持
• 自动收集与审查 | 丰富表达 | -| 📅 日程系统 | • 动态日程生成
• 自定义想象力
• 思维流联动 | 智能规划 | -| 👥 关系系统 | • **工具调用动态更新**
• 关系管理优化
• 丰富接口支持
• 个性化交互 | 深度社交 | -| 📊 统计系统 | • 使用数据统计
• LLM调用记录
• 实时控制台显示 | 数据可视 | -| 🛠️ 工具系统 | • **LPMM知识库集成**
• **上下文感知调用**
• 知识获取工具
• 自动注册机制
• 多工具支持 | 扩展功能 | -| 📚 **知识库(LPMM)** | • **全新LPMM系统**
• **强大的信息检索能力** | 知识增强 | -| ✨ **昵称系统** | • **自动为群友取昵称**
• **降低认错人概率** (早期阶段) | 身份识别 | - -## 📐 项目架构 - -```mermaid -graph TD - A[MaiCore] --> B[对话系统] - A --> C[心流系统] - A --> D[记忆系统] - A --> E[情感系统] - B --> F[多模型支持] - B --> G[动态Prompt] - C --> H[实时思考] - C --> I[日程联动] - D --> J[记忆存储] - D --> K[记忆检索] - E --> L[表情管理] - E --> M[情绪识别] -``` - ## ✍️如何给本项目报告BUG/提交建议/做贡献 -MaiCore是一个开源项目，我们非常欢迎你的参与。你的贡献，无论是提交bug报告、功能需求还是代码pr，都对项目非常宝贵。我们非常感谢你的支持！🎉 但无序的讨论会降低沟通效率，进而影响问题的解决速度，因此在提交任何贡献前，请务必先阅读本项目的[贡献指南](depends-data/CONTRIBUTE.md)（待补完） - - +MaiCore是一个开源项目，我们非常欢迎你的参与。你的贡献，无论是提交bug报告、功能需求还是代码pr，都对项目非常宝贵。我们非常感谢你的支持！🎉 但无序的讨论会降低沟通效率，进而影响问题的解决速度，因此在提交任何贡献前，请务必先阅读本项目的[贡献指南](docs/CONTRIBUTE.md)（待补完） ## 设计理念（原始时代的火花） @@ -162,27 +82,29 @@ MaiCore是一个开源项目，我们非常欢迎你的参与。你的贡献， ## 📌 注意事项 > [!WARNING] -> 使用本项目前必须阅读和同意用户协议和隐私协议 +> 使用本项目前必须阅读和同意[用户协议](https://docs.mai-mai.org/manual/other/EULA.html)和隐私协议。 > 本应用生成内容来自人工智能模型，由 AI 生成，请仔细甄别，请勿用于违反法律的用途，AI生成内容不代表本人观点和立场。 -## 致谢 - -- [NapCat](https://github.com/NapNeko/NapCatQQ): 现代化的基于 NTQQ 的 Bot 协议端实现 - -## 麦麦仓库状态 - -![Alt](https://repobeats.axiom.co/api/embed/9faca9fccfc467931b87dd357b60c6362b5cfae0.svg "Repobeats analytics image") - -### 贡献者 +## 贡献者 感谢各位大佬！ contributors + + 画师：略nd + +### 致谢 + +- [NapCat](https://github.com/NapNeko/NapCatQQ): 现代化的基于 NTQQ 的 Bot 协议端实现 **也感谢每一位给麦麦发展提出宝贵意见与建议的用户，感谢陪伴麦麦走到现在的你们** -## Stargazers over time +## 麦麦仓库状态 -[![Stargazers over time](https://starchart.cc/MaiM-with-u/MaiBot.svg?variant=adaptive)](https://starchart.cc/MaiM-with-u/MaiBot) +![Alt](https://repobeats.axiom.co/api/embed/9faca9fccfc467931b87dd357b60c6362b5cfae0.svg "Repobeats analytics image") + +## Star 趋势 + +[![Star 趋势](https://starchart.cc/MaiM-with-u/MaiBot.svg?variant=adaptive)](https://starchart.cc/MaiM-with-u/MaiBot) diff --git a/changelogs/changelog_dev.md b/changelogs/changelog_dev.md deleted file mode 100644 index 663ad9629..000000000 --- a/changelogs/changelog_dev.md +++ /dev/null @@ -1,27 +0,0 @@ -这里放置了测试版本的细节更新 - -## [test-0.6.1-snapshot-1] - 2025-4-5 -- 修复pfc回复出错bug -- 修复表情包打字时间，不会卡表情包 -- 改进了知识库的提取 -- 提供了新的数据库连接方式 -- 修复了ban_user无效的问题 - -## [test-0.6.0-snapshot-9] - 2025-4-4 -- 可以识别gif表情包 - -## [test-0.6.0-snapshot-8] - 2025-4-3 -- 修复了表情包的注册，获取和发送逻辑 -- 表情包增加存储上限 -- 更改了回复引用的逻辑，从基于时间改为基于新消息 -- 增加了调试信息 -- 自动清理缓存图片 -- 修复并重启了关系系统 - -## [test-0.6.0-snapshot-7] - 2025-4-2 -- 修改版本号命名：test-前缀为测试版，无前缀为正式版 -- 提供私聊的PFC模式，可以进行有目的，自由多轮对话 - -## [0.6.0-mmc-4] - 2025-4-1 -- 提供两种聊天逻辑，思维流聊天（ThinkFlowChat 和 推理聊天（ReasoningChat） -- 从结构上可支持多种回复消息逻辑 \ No newline at end of file diff --git a/src/0.6Bing.md b/docs/0.6Bing.md similarity index 100% rename from src/0.6Bing.md rename to docs/0.6Bing.md diff --git a/depends-data/CONTRIBUTE.md b/docs/CONTRIBUTE.md similarity index 100% rename from depends-data/CONTRIBUTE.md rename to docs/CONTRIBUTE.md diff --git a/src/heartFC_chatting_logic.md b/docs/HeartFC_chatting_logic.md similarity index 100% rename from src/heartFC_chatting_logic.md rename to docs/HeartFC_chatting_logic.md diff --git a/src/heartFC_readme.md b/docs/HeartFC_readme.md similarity index 100% rename from src/heartFC_readme.md rename to docs/HeartFC_readme.md diff --git a/src/README.md b/docs/HeartFC_system.md similarity index 100% rename from src/README.md rename to docs/HeartFC_system.md diff --git a/src/tools/tool_can_use/README.md b/docs/use_tool.md similarity index 100% rename from src/tools/tool_can_use/README.md rename to docs/use_tool.md