docs(README): add detailed documentation for MaiBot-Vtuber

- Overview of the project architecture
- Configuration instructions
- Plugin development guide
- Installation and running steps
- Debug mode usage

Author: ChangingSelf

README.md

@@ -1,59 +1,92 @@
-# MaiBot-Vtuber
-
-聊天机器人麦麦的[VTubeStudio](https://github.com/DenchiSoft/VTubeStudio)插件。其聊天核心为[麦麦Bot](https://github.com/MaiM-with-u/MaiBot)，一款专注于 群组聊天 的赛博网友 QQ BOT。
-
-## 项目结构
-
-```
-.
-├── src/                # 源代码目录
-│   ├── actuator/      # 执行器模块
-│   ├── neuro/         # 神经网络模块
-│   ├── sensor/        # 传感器模块
-│   └── utils/         # 工具函数模块
-├── main.py            # 主程序入口
-└── requirements.txt   # 项目依赖
+# Amaidesu
+
+聊天机器人麦麦的[VTubeStudio](https://
+github.com/DenchiSoft/VTubeStudio)适配器。
+其聊天核心为[麦麦Bot](https://github.com/
+MaiM-with-u/MaiBot)，一款专注于 群组聊天 
+的赛博网友 QQ BOT。
+
+## 架构概述
+
+MaiBot-Vtuber 采用模块化设计，主要由以下几个核心组件构成：
+
+1. **VupNextCore**: 核心模块，负责与 MaiCore 的通信
+2. **PluginManager**: 插件管理器，负责插件的加载和管理
+3. **BasePlugin**: 插件基类，定义插件的基本接口
+4. **插件系统**: 各种功能插件，如 TTS、STT、LLM 等
+
+### 系统架构图
+
+```mermaid
+graph TD
+    A[VupNextCore] --> B[PluginManager]
+    B --> C[BasePlugin]
+    C --> D[ConsoleInput Plugin]
+    C --> E[TTS Plugin]
+    C --> F[STT Plugin]
+    C --> G[LLM Plugin]
+    C --> H[VTubeStudio Plugin]
+    A --> I[MaiCore]
+    A --> J[HTTP Server]
 ```
 
-## 安装步骤
-
-1. 克隆项目到本地：
-```bash
-git clone git@github.com:ChangingSelf/MaiBot-Vtuber.git
-cd MaiBot-Vtuber
+### 消息处理时序图
+
+```mermaid
+sequenceDiagram
+    participant User
+    participant ConsoleInput
+    participant VupNextCore
+    participant PluginManager
+    participant Plugins
+    participant MaiCore
+
+    User->>ConsoleInput: 输入消息
+    ConsoleInput->>VupNextCore: 发送消息
+    VupNextCore->>PluginManager: 分发消息
+    PluginManager->>Plugins: 处理消息
+    Plugins->>VupNextCore: 返回处理结果
+    VupNextCore->>MaiCore: 发送处理后的消息
+    MaiCore-->>VupNextCore: 返回响应
+    VupNextCore-->>Plugins: 分发响应
+    Plugins-->>VupNextCore: 处理响应
+    VupNextCore-->>ConsoleInput: 返回最终结果
+    ConsoleInput-->>User: 显示结果
 ```
 
-2. 创建并激活虚拟环境（推荐）：
-```bash
-python -m venv venv
-# Windows
-.\venv\Scripts\activate
-# Linux/Mac
-source venv/bin/activate
+## 插件开发
+
+插件开发需要继承 `BasePlugin` 类并实现必要的方法：
+
+```python
+from src.core.plugin_manager import BasePlugin
+
+class MyPlugin(BasePlugin):
+    async def setup(self):
+        # 注册消息处理器
+        await self.core.register_websocket_handler("text", self.handle_message)
+    
+    async def handle_message(self, message):
+        # 处理消息
+        pass
+    
+    async def cleanup(self):
+        # 清理资源
+        pass
 ```
 
-3. 安装依赖：
-```bash
-pip install -r requirements.txt
-```
-
-4. 配置并启动麦麦
-
-跟着[麦麦的安装文档](https://docs.mai-mai.org/manual/deployment/mmc_deploy.html)，安装并运行麦麦。
-
-5. 运行
+## 安装与运行
 
-开启VtubeStudio，在选项中允许安装插件，接着运行主程序：
-
-```bash
-python -m main
-```
+1. 克隆仓库
+2. 安装依赖：`pip install -r requirements.txt`
+3. 复制 `config-template.toml` 为 `config.toml` 并配置
+4. 运行：`python main.py`
 
+## 调试模式
 
-`vts_client.py`中是对连接VTubeStudio的pyvts库的封装，启动VTubeStudio之后，在设置中开启允许安装插件的选项，可使用如下命令运行这个文件进行简单测试：
+使用 `--debug` 参数启用调试日志：
 
 ```bash
-python -m src.actuator.vts_client
+python main.py --debug
 ```
 
-会调用当前打开模型的第一个动画。