docs: 更新文档内容,简化语言并修正格式
- 简化插件开发指南中的描述,移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档,删除不准确的数据 - 重构核心概念文档,使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档,简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档,添加参数注入示例 - 优化单例管理器文档的表述
This commit is contained in:
33
README.md
33
README.md
@@ -8,30 +8,30 @@
|
||||
|
||||
## 项目概述
|
||||
|
||||
**Calglau BOT** 是一个基于 NEO Bot Framework 构建的高性能 QQ 机器人。别指望这里有什么花里胡哨的废话,这就是一个为了解决实际问题而生的工具。我们用最硬核的技术栈,解决最麻烦的社群管理和自动化需求。
|
||||
**Calglau BOT** 是一个基于 NEO Bot Framework 构建的高性能 QQ 机器人。
|
||||
|
||||
简单来说:它很快,很稳,而且不挑食。
|
||||
简单来说:扣一
|
||||
|
||||
### 核心特性
|
||||
|
||||
* **模块化插件架构**:所有功能都在 `plugins/` 目录里躺着。想加功能?写个 Python 文件扔进去就行。支持热重载,改完代码直接生效,不用重启,不用中断服务。
|
||||
* **模块化插件架构**:所有功能都在 `plugins/` 目录
|
||||
* **极致性能优化**:
|
||||
* **Python 3.14 JIT**:我们直接上了最新的 Python 版本,开启 JIT 即时编译,速度起飞。
|
||||
* **Mypyc 编译**:核心模块直接编译成 C 扩展,拒绝解释器的龟速。
|
||||
* **Playwright 页面池**:浏览器页面预热池,渲染图片零等待。别再问为什么发图这么快了。
|
||||
* **全局连接复用**:HTTP 和 Redis 连接池化管理,拒绝重复握手浪费时间。
|
||||
* **开发者友好**:完整的类型提示,清晰的 API 设计。写代码就该是种享受,而不是在屎山里游泳。
|
||||
* **集成 Redis 缓存**:能缓存的都缓存了。群信息、用户信息、帮助图片,绝不让数据库多喘一口气。
|
||||
* **正向 WebSocket 连接**:保持最简单的连接方式,只要能上网就能跑,不需要公网 IP,不需要内网穿透。
|
||||
* **Python 3.14 JIT**:pypy不支持那个浏览器扩展我只能用JIT了。。。
|
||||
* **Mypyc 编译**:一些核心模块已经编译成机器码了
|
||||
* **Playwright 页面池**:浏览器页面预热池
|
||||
* **全局连接复用**:HTTP 和 Redis 连接池化管理
|
||||
* **开发者友好**:完整的类型提示,清晰的 API 设计。
|
||||
* **集成 Redis 缓存**:能缓存的都缓存了。群信息、用户信息、帮助图片
|
||||
* **正向 WebSocket 连接**:我只会支持正向WS连接。。。不要提意见,我不会听的。。。
|
||||
|
||||
### 技术栈
|
||||
|
||||
* **核心框架**: Python 3.14 (JIT Enabled) & NEO Bot Framework
|
||||
* **编译优化**: Mypyc (C Extension)
|
||||
* **核心框架**: Python 3.14 JIT & NEO Bot Framework
|
||||
* **编译器**: Mypyc
|
||||
* **异步核心**: `asyncio` + `uvloop` (Linux) / 原生 Loop (Windows)
|
||||
* **网络通信**: `websockets` (OneBot v11), `aiohttp` (Shared Session)
|
||||
* **浏览器引擎**: `Playwright` (Chromium) + Page Pool
|
||||
* **数据序列化**: `orjson` (比标准库快 N 倍)
|
||||
* **数据序列化**: `orjson`
|
||||
* **缓存**: `Redis`
|
||||
* **日志**: `Loguru`
|
||||
|
||||
@@ -65,12 +65,13 @@
|
||||
|
||||
## 快速开始
|
||||
|
||||
别废话,直接跑起来。
|
||||
1
|
||||
|
||||
1. **装环境**: Python 3.14,Redis,还有个 OneBot 客户端 (推荐 NapCat)。
|
||||
|
||||
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/` 目录看,别什么都问我。
|
||||
详细文档去 `docs/` 目录看
|
||||
|
||||
Reference in New Issue
Block a user