K2cr2O1
7f331970dd
- 简化插件开发指南中的描述，移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档，删除不准确的数据 - 重构核心概念文档，使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述
78 lines
2.8 KiB
Markdown
78 lines
2.8 KiB
Markdown
# Calglau BOT by NEO Bot Framework
|
||
|
||
> **[INTERNAL USE ONLY]**
|
||
>
|
||
> 本仓库为 Calglau BOT 的内部开发版本，请遵守相关保密协议。
|
||
|
||
**Powered by NEO Bot Framework**
|
||
|
||
## 项目概述
|
||
|
||
**Calglau BOT** 是一个基于 NEO Bot Framework 构建的高性能 QQ 机器人。
|
||
|
||
简单来说：扣一
|
||
|
||
### 核心特性
|
||
|
||
* **模块化插件架构**：所有功能都在 `plugins/` 目录
|
||
* **极致性能优化**：
|
||
* **Python 3.14 JIT**：pypy不支持那个浏览器扩展我只能用JIT了。。。
|
||
* **Mypyc 编译**：一些核心模块已经编译成机器码了
|
||
* **Playwright 页面池**：浏览器页面预热池
|
||
* **全局连接复用**：HTTP 和 Redis 连接池化管理
|
||
* **开发者友好**：完整的类型提示，清晰的 API 设计。
|
||
* **集成 Redis 缓存**：能缓存的都缓存了。群信息、用户信息、帮助图片
|
||
* **正向 WebSocket 连接**：我只会支持正向WS连接。。。不要提意见，我不会听的。。。
|
||
|
||
### 技术栈
|
||
|
||
* **核心框架**: Python 3.14 JIT & NEO Bot Framework
|
||
* **编译器**: Mypyc
|
||
* **异步核心**: `asyncio` + `uvloop` (Linux) / 原生 Loop (Windows)
|
||
* **网络通信**: `websockets` (OneBot v11), `aiohttp` (Shared Session)
|
||
* **浏览器引擎**: `Playwright` (Chromium) + Page Pool
|
||
* **数据序列化**: `orjson`
|
||
* **缓存**: `Redis`
|
||
* **日志**: `Loguru`
|
||
|
||
---
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
.
|
||
├── plugins/ # 插件目录，业务逻辑都在这
|
||
│ ├── admin.py # 管理员指令
|
||
│ ├── bili_parser.py # B站解析 (高性能版)
|
||
│ ├── code_py.py # 代码沙箱
|
||
│ ├── echo.py # 复读机
|
||
│ ├── forward_test.py # 合并转发测试
|
||
│ ├── jrcd.py # 今日运势
|
||
│ └── thpic.py # 东方图片
|
||
├── core/ # 框架核心，非请勿动
|
||
│ ├── api/ # OneBot API 封装
|
||
│ ├── managers/ # 各种管理器 (指令, 浏览器, 图片, 插件)
|
||
│ ├── utils/ # 工具函数
|
||
│ ├── ws.py # WebSocket 通信层 (已编译)
|
||
│ └── bot.py # Bot 实例
|
||
├── data/ # 数据存储
|
||
│ ├── admin.json # 管理员名单
|
||
│ └── permissions.json # 权限配置
|
||
├── templates/ # Jinja2 模板
|
||
├── setup_mypyc.py # 编译脚本
|
||
└── main.py # 启动入口
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
1
|
||
|
||
|
||
1. **装环境**: Python 3.14，Redis， OneBot 客户端 (推荐 NapCat)。
|
||
2. **装依赖**: `pip install -r requirements.txt`
|
||
3. **装浏览器**: `playwright install chromium`
|
||
4. **编译核心 (可选)**: `python setup_mypyc.py build_ext --inplace`
|
||
5. **启动**: `python -X jit main.py`
|
||
|
||
详细文档去 `docs/` 目录看
|