From b734012a9100510665deecb3b6f0976a33d65331 Mon Sep 17 00:00:00 2001
From: SengokuCola <1026294844@qq.com>
Date: Thu, 27 Feb 2025 09:57:26 +0800
Subject: [PATCH] Update README.md

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++------
 1 file changed, 38 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 30b52e006..72ac90a85 100644
--- a/README.md
+++ b/README.md
@@ -3,17 +3,49 @@
 
 
 还在整理中
-=======
-*还没整理完*
+======
 
-基于napcat,nonebot和mongodb
+基于napcat,nonebot和mongodb的专注于群聊天的qqbot
 
-要把env.example改成.env,并填上你的apikey（硅基流动）
+！！未完善！！
+*安装方法*
+1.创建python环境，安装requirements（还没检查好，可能有包漏了）
+2.安装并运行mongodb（麦麦bot会自动连接默认的mongodb，可配置）
+3.安装并允许Napcat，并设置ws反向代理
+4.填写麦麦运行需要的配置文件
+  4.1 把env.example改成.env,并填上你的apikey（硅基流动）
+  4.2 把bot_config_toml改名为bot_config.toml，并填写相关内容.
+5.运行麦麦
 
-未完成整理，可以跑，但是还没写部署方式
 功能和文件结构随时可能发生变化
 
+**功能介绍**
 主要代码在/src/plugins/chat下
 
+聊天功能：
+  支持关键词检索主动发言：对消息的话题topic进行识别，如果检测到麦麦存储过的话题就会主动进行发言，没写完
+  支持bot名字呼唤发言：检测到"麦麦"会主动发言，可配置
+  使用硅基流动的api进行回复生成，可随机使用R1，V3，R1-distill等模型，未来将加入官网api支持
+  动态的prompt构建器，更拟人
+  支持图片，转发消息，回复消息的识别
+  错别字和多条回复功能：麦麦可以随机生成错别字，会多条发送回复以及对消息进行reply
+表情包功能：
+  支持根据发言内容发送对应情绪的表情包：未完善，可以用
+  会自动偷群友的表情包（未完善，暂时禁用）
+日程功能：
+  麦麦会自动生成一天的日程，实现更拟人的回复
+记忆功能：
+  对聊天记录进行概括存储，在需要时调用，没写完
+知识库功能：
+  基于embedding模型的知识库，手动放入txt会自动识别，写完了，暂时禁用
+可视化的界面：
+  基于gradio的后台界面，可以显示实时消息，思考过程和消息发送流（WIP
+关系功能：
+  针对每个用户创建"关系"，可以对不同用户进行个性化回复，目前只有极其简单的好感度（WIP
+人格功能：WIP
+群氛围功能：WIP
+图片发送，转发功能：WIP
+幽默和meme功能：WIP的WIP
 
-纯编程外行，很多代码史一样多多包涵
+
+纯编程外行，面向cursor编程，很多代码史一样多多包涵