Skip to content

README.md

Latest commit

 

History

History
143 lines (111 loc) · 5.41 KB

README.md

File metadata and controls

143 lines (111 loc) · 5.41 KB

沐沐 MumuBot

一个会聊天、会记事、会融入群文化的赛博 QQ 群友

Powered by Eino

MumuBot

Warning

  • 项目仍在快速迭代，配置项和运行行为可能随版本调整
  • QQ 机器人存在账号风控风险，请谨慎使用
  • AI 模型调用会消耗 Token，请按需控制用量

✨ 特性

  • 🧠 ReAct 智能体 — 通过观察、思考、行动循环，自主判断是否接话、查询信息或保持沉默
  • 💬 拟人对话 — 可自定义人格、语言风格和兴趣话题，说话更接近真实群友
  • 🧵 话题工作记忆 — 持续跟踪当前话题、摘要、参与者与未完事项，并可召回已归档话题
  • 🧩 丰富工具集 — 发言、沉默、戳一戳、贴表情、发表情包、查群公告、网页浏览等 20+ 内置工具
  • 📝 长期记忆 — 基于 MySQL + Milvus 保存和检索事实、经历、偏好、约束与目标
  • 👤 群友画像 — 自动记录群友说话风格、兴趣、活跃度、亲密度
  • 🎭 情绪系统 — 心情、精力、社交意愿三维情绪状态，随对话自然变化
  • 👀 多模态理解 — 支持视觉模型识别图片和视频内容
  • 🖼️ 表情包系统 — 自动收集群内表情包，按描述检索并发送
  • 📖 持续学习 — 主动学习群内黑话、梗和独特表达方式，沉淀为可审核的群文化资料
  • ⏰ 时段策略 — 可配置不同时间段的发言活跃度
  • 🔌 MCP 扩展 — 支持通过 MCP 协议接入外部工具，无限扩展能力
  • 🖥️ 管理后台 — 查看总览、审核学习结果、管理话题/记忆/表情包，并浏览群友画像
  • 📊 监控接口 — 提供健康检查与状态接口，方便接入部署和运维流程

🚀 快速开始

环境要求

依赖 说明
Go 1.25+ 编译运行
Node.js 22+ 构建前端资源
MySQL 存储记忆、消息日志、群友画像
Milvus 向量数据库，用于长期记忆、风格卡片和归档话题检索
NapCat / go-cqhttp OneBot 11 协议实现
大语言模型 API 兼容 OpenAI 格式，需支持工具调用

使用发布包

GitHub Release 提供 Linux、Windows、macOS 的打包产物。归档内包含：

  • 可执行文件
  • config/config.yaml 示例配置
  • config/mcp.json 示例配置
  • README.md 和 LICENSE

运行发布包时不需要额外部署前端静态文件，管理后台所需资源已经内嵌进二进制。

从源码构建

# 1. 克隆项目
git clone https://github.com/SugarMGP/MumuBot.git
cd MumuBot

# 2. 安装前端依赖并构建后台资源
npm ci
npm run build

# 3. 生成 templ 视图代码
go run github.com/a-h/templ/cmd/templ@latest generate ./internal/web/views

# 4. 编译
go build -o mumu-bot .

配置与启动

如果你使用的是 GitHub Release 里的打包归档，可直接编辑归档自带的 config/config.yaml 和 config/mcp.json，不用再执行下面的复制命令。

# 1. 复制配置文件并按需修改
cp config/config.example.yaml config/config.yaml
cp config/mcp.example.json config/mcp.json

# 2. 编辑配置（填入模型、数据库、OneBot 等信息）
# 也可通过环境变量配置敏感信息：
#   MUMU_MODEL_HIGH_API_KEY             - 高档模型 API Key
#   MUMU_MODEL_MID_API_KEY              - 中档模型 API Key
#   MUMU_MODEL_LOW_API_KEY              - 轻量模型 API Key
#   MUMU_EMBEDDING_API_KEY              - Embedding 模型 API Key
#   MUMU_VISION_API_KEY                 - 视觉模型 API Key
#   MUMU_ONEBOT_TOKEN                   - OneBot 访问令牌
#   MUMU_MYSQL_PASSWORD                 - MySQL 密码

# 3. 启动
./mumu-bot

默认情况下服务监听 8080 端口，可在配置中修改。

访问服务的 /admin 路径进入管理后台。未设置后台密钥时，后台会保持关闭状态。

🔧 MCP 工具扩展

通过编辑 config/mcp.json 接入外部 MCP 服务器，支持 SSE 和 Stdio 两种传输方式：

{
    "servers": [
        {
            "name": "example-mcp-server-sse",
            "enabled": false,
            "type": "sse",
            "url": "http://localhost:3333/sse",
            "tool_name_list": [],
            "custom_headers": {
                "Authorization": "Bearer YOUR_TOKEN_HERE"
            }
        },
        {
            "name": "example-mcp-server-stdio",
            "enabled": false,
            "type": "stdio",
            "command": "",
            "args": [],
            "env": []
        }
    ]
}

🤝 贡献

欢迎任何形式的贡献！ 无论是提交 Bug 报告、功能建议，还是直接提交代码，我们都非常感谢。

❤️ 致谢