修改了文档结构
123
This commit is contained in:
SengokuCola
47
README.md
47
README.md
@@ -13,18 +13,19 @@
|
||||
|
||||
**🍔麦麦是一个基于大语言模型的智能QQ群聊机器人**
|
||||
|
||||
- 🤖 基于 nonebot2 框架开发
|
||||
- 🧠 LLM 提供对话能力
|
||||
- 💾 MongoDB 提供数据持久化支持
|
||||
- 🐧 NapCat 作为QQ协议端支持
|
||||
- 基于 nonebot2 框架开发
|
||||
- LLM 提供对话能力
|
||||
- MongoDB 提供数据持久化支持
|
||||
- NapCat 作为QQ协议端支持
|
||||
|
||||
**最新版本: v0.5.7**
|
||||
**最新版本: v0.5.***
|
||||
|
||||
<div align="center">
|
||||
<a href="https://www.bilibili.com/video/BV1amAneGE3P" target="_blank">
|
||||
<img src="docs/video.png" width="300" alt="麦麦演示视频">
|
||||
<br>
|
||||
👆 点击观看麦麦演示视频 👆
|
||||
|
||||
</a>
|
||||
</div>
|
||||
|
||||
@@ -35,11 +36,28 @@
|
||||
> - 由于持续迭代，可能存在一些已知或未知的bug
|
||||
> - 由于开发中，可能消耗较多token
|
||||
|
||||
**交流群**: 766798517（仅用于开发和建议相关讨论）不建议在群内询问部署问题，我不一定有空回复，会优先写文档和代码
|
||||
**交流群**: 766798517（仅用于开发和建议相关讨论）不一定有空回复，但大家可以自行交流部署问题，我会优先写文档和代码
|
||||
|
||||
## 📚 文档
|
||||
##
|
||||
<div align="left">
|
||||
<h2>📚 文档 ⬇️ 快速开始使用麦麦 ⬇️</h2>
|
||||
</div>
|
||||
|
||||
### 部署方式
|
||||
|
||||
如果你不知道Docker是什么，建议寻找相关教程或使用手动部署
|
||||
|
||||
- [🐳 Docker部署指南](docs/docker_deploy.md)
|
||||
|
||||
- [📦 手动部署指南](docs/manual_deploy.md)
|
||||
|
||||
### 配置说明
|
||||
- [⚙️ 配置详细说明](docs/installation.md) - 环境和机器人配置的详细说明
|
||||
|
||||
<div align="left">
|
||||
<h3>了解麦麦 </h3>
|
||||
</div>
|
||||
|
||||
- [安装与配置指南](docs/installation.md) - 详细的部署和配置说明
|
||||
- [项目架构说明](docs/doc1.md) - 项目结构和核心功能实现细节
|
||||
|
||||
## 🎯 功能介绍
|
||||
@@ -92,8 +110,19 @@
|
||||
- 改进发送消息的触发
|
||||
-
|
||||
|
||||
|
||||
## 设计理念
|
||||
|
||||
- **千石可乐说：**
|
||||
- 这个项目最初只是为了给牛牛bot添加一点额外的功能，但是功能越写越多，最后决定重写。其目的是为了创造一个活跃在QQ群聊的"生命体"。可以目的并不是为了写一个功能齐全的机器人，而是一个尽可能让人感知到真实的类人存在.
|
||||
- 程序的功能设计理念基于一个核心的原则："最像而不是好"
|
||||
- 主打一个陪伴
|
||||
- 如果人类真的需要一个AI来陪伴自己，并不是所有人都需要一个完美的，能解决所有问题的helpful assistant，而是一个会犯错的，拥有自己感知和想法的"生命形式"。
|
||||
- 代码会保持开源和开放，但个人希望MaiMbot的运行时数据保持封闭，尽量避免以显式命令来对其进行控制和调试.我认为一个你无法完全掌控的个体才更能让你感觉到它的自主性，而视其成为一个对话机器.
|
||||
|
||||
|
||||
## 📌 注意事项
|
||||
纯编程外行，面向cursor编程，很多代码史一样多多包涵
|
||||
SengokuCola纯编程外行，面向cursor编程，很多代码史一样多多包涵
|
||||
|
||||
> ⚠️ **警告**：本应用生成内容来自人工智能模型，由 AI 生成，请仔细甄别，请勿用于违反法律的用途，AI生成内容不代表本人观点和立场。
|
||||
|
||||
|
||||
24
docs/docker_deploy.md
Normal file
24
docs/docker_deploy.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# 🐳 Docker 部署指南
|
||||
|
||||
## 部署步骤（推荐，但不一定是最新）
|
||||
|
||||
1. 获取配置文件：
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/SengokuCola/MaiMBot/main/docker-compose.yml
|
||||
```
|
||||
|
||||
2. 启动服务：
|
||||
```bash
|
||||
NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose up -d
|
||||
```
|
||||
|
||||
3. 修改配置后重启：
|
||||
```bash
|
||||
NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose restart
|
||||
```
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
- 目前部署方案仍在测试中，可能存在未知问题
|
||||
- 配置文件中的API密钥请妥善保管，不要泄露
|
||||
- 建议先在测试环境中运行，确认无误后再部署到生产环境
|
||||
@@ -1,60 +1,6 @@
|
||||
# 🔧 安装与配置指南
|
||||
|
||||
## 部署方式
|
||||
|
||||
如果你不知道Docker是什么，建议寻找相关教程或使用手动部署
|
||||
|
||||
### 🐳 Docker部署（推荐，但不一定是最新）
|
||||
|
||||
1. 获取配置文件：
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/SengokuCola/MaiMBot/main/docker-compose.yml
|
||||
```
|
||||
|
||||
2. 启动服务：
|
||||
```bash
|
||||
NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose up -d
|
||||
```
|
||||
|
||||
3. 修改配置后重启：
|
||||
```bash
|
||||
NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose restart
|
||||
```
|
||||
|
||||
### 📦 手动部署
|
||||
|
||||
1. **环境准备**
|
||||
```bash
|
||||
# 创建虚拟环境（推荐）
|
||||
python -m venv venv
|
||||
venv\\Scripts\\activate # Windows
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. **配置MongoDB**
|
||||
- 安装并启动MongoDB服务
|
||||
- 默认连接本地27017端口
|
||||
|
||||
3. **配置NapCat**
|
||||
- 安装并登录NapCat
|
||||
- 添加反向WS：`ws://localhost:8080/onebot/v11/ws`
|
||||
|
||||
4. **配置文件设置**
|
||||
- 修改环境配置文件：`.env.prod`
|
||||
- 修改机器人配置文件：`bot_config.toml`
|
||||
|
||||
5. **启动麦麦机器人**
|
||||
- 打开命令行，cd到对应路径
|
||||
```bash
|
||||
nb run
|
||||
```
|
||||
|
||||
6. **其他组件**
|
||||
- `run_thingking.bat`: 启动可视化推理界面（未完善）
|
||||
|
||||
- ~~`knowledge.bat`: 将`/data/raw_info`下的文本文档载入数据库~~
|
||||
- 直接运行 knowledge.py生成知识库
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
|
||||
122
docs/manual_deploy.md
Normal file
122
docs/manual_deploy.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# 📦 手动部署指南
|
||||
|
||||
## 部署步骤
|
||||
|
||||
1. **环境准备**
|
||||
```bash
|
||||
# 创建虚拟环境（推荐）
|
||||
python -m venv venv
|
||||
venv\\Scripts\\activate # Windows
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. **配置MongoDB**
|
||||
- 安装并启动MongoDB服务
|
||||
- 默认连接本地27017端口
|
||||
|
||||
3. **配置NapCat**
|
||||
- 安装并登录NapCat
|
||||
- 添加反向WS：`ws://localhost:8080/onebot/v11/ws`
|
||||
|
||||
4. **配置文件设置**
|
||||
- 修改环境配置文件：`.env.prod`
|
||||
- 修改机器人配置文件：`bot_config.toml`
|
||||
|
||||
5. **启动麦麦机器人**
|
||||
- 打开命令行，cd到对应路径
|
||||
```bash
|
||||
nb run
|
||||
```
|
||||
|
||||
6. **其他组件**
|
||||
- `run_thingking.bat`: 启动可视化推理界面（未完善）
|
||||
- 直接运行 knowledge.py生成知识库
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
### 环境配置 (.env.prod)
|
||||
```ini
|
||||
# API配置,你可以在这里定义你的密钥和base_url
|
||||
# 你可以选择定义其他服务商提供的KEY，完全可以自定义
|
||||
SILICONFLOW_KEY=your_key
|
||||
SILICONFLOW_BASE_URL=https://api.siliconflow.cn/v1/
|
||||
DEEP_SEEK_KEY=your_key
|
||||
DEEP_SEEK_BASE_URL=https://api.deepseek.com/v1
|
||||
|
||||
# 服务配置,如果你不知道这是什么，保持默认
|
||||
HOST=127.0.0.1
|
||||
PORT=8080
|
||||
|
||||
# 数据库配置,如果你不知道这是什么，保持默认
|
||||
MONGODB_HOST=127.0.0.1
|
||||
MONGODB_PORT=27017
|
||||
DATABASE_NAME=MegBot
|
||||
```
|
||||
|
||||
### 机器人配置 (bot_config.toml)
|
||||
```toml
|
||||
[bot]
|
||||
qq = "你的机器人QQ号"
|
||||
nickname = "麦麦"
|
||||
|
||||
[message]
|
||||
min_text_length = 2
|
||||
max_context_size = 15
|
||||
emoji_chance = 0.2
|
||||
|
||||
[emoji]
|
||||
check_interval = 120
|
||||
register_interval = 10
|
||||
|
||||
[cq_code]
|
||||
enable_pic_translate = false
|
||||
|
||||
[response]
|
||||
#现已移除deepseek或硅基流动选项，可以直接切换分别配置任意模型
|
||||
model_r1_probability = 0.8 #推理模型权重
|
||||
model_v3_probability = 0.1 #非推理模型权重
|
||||
model_r1_distill_probability = 0.1
|
||||
|
||||
[memory]
|
||||
build_memory_interval = 300
|
||||
|
||||
[others]
|
||||
enable_advance_output = true # 是否启用详细日志输出
|
||||
|
||||
[groups]
|
||||
talk_allowed = [] # 允许回复的群号列表
|
||||
talk_frequency_down = [] # 降低回复频率的群号列表
|
||||
ban_user_id = [] # 禁止回复的用户QQ号列表
|
||||
|
||||
[model.llm_reasoning]
|
||||
name = "Pro/deepseek-ai/DeepSeek-R1"
|
||||
base_url = "SILICONFLOW_BASE_URL"
|
||||
key = "SILICONFLOW_KEY"
|
||||
|
||||
[model.llm_reasoning_minor]
|
||||
name = "deepseek-ai/DeepSeek-R1-Distill-Qwen-32B"
|
||||
base_url = "SILICONFLOW_BASE_URL"
|
||||
key = "SILICONFLOW_KEY"
|
||||
|
||||
[model.llm_normal]
|
||||
name = "Pro/deepseek-ai/DeepSeek-V3"
|
||||
base_url = "SILICONFLOW_BASE_URL"
|
||||
key = "SILICONFLOW_KEY"
|
||||
|
||||
[model.llm_normal_minor]
|
||||
name = "deepseek-ai/DeepSeek-V2.5"
|
||||
base_url = "SILICONFLOW_BASE_URL"
|
||||
key = "SILICONFLOW_KEY"
|
||||
|
||||
[model.vlm]
|
||||
name = "deepseek-ai/deepseek-vl2"
|
||||
base_url = "SILICONFLOW_BASE_URL"
|
||||
key = "SILICONFLOW_KEY"
|
||||
```
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
- 目前部署方案仍在测试中，可能存在未知问题
|
||||
- 配置文件中的API密钥请妥善保管，不要泄露
|
||||
- 建议先在测试环境中运行，确认无误后再部署到生产环境
|
||||
Reference in New Issue
Block a user