docs: 更新文档内容,简化语言并修正格式
- 简化插件开发指南中的描述,移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档,删除不准确的数据 - 重构核心概念文档,使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档,简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档,添加参数注入示例 - 优化单例管理器文档的表述
This commit is contained in:
@@ -1,43 +1,43 @@
|
||||
# 核心概念:单例管理器
|
||||
|
||||
`core/managers/` 这地方,放的都是些**管事的(Managers)**。它们是 NEO Bot 的权力核心。
|
||||
`core/managers/` 这地方,放的都是些**管事的**。它们是 NEO Bot 的核心。梨花飘落在你窗前。。。
|
||||
|
||||
## 为啥非得是单例 (Singleton)?
|
||||
## 为啥是单例?
|
||||
|
||||
说白了,就是**全局独一份,省事**。
|
||||
就是**全局独一份**。
|
||||
|
||||
* **到处都能用**: 在插件里 `import` 就行,不用传来传去。
|
||||
* **数据不打架**: 权限、命令这些东西,全局就一份,改了都认。
|
||||
* **省资源**: Redis 连接池、浏览器这种东西,开一个就够了,多了浪费。
|
||||
|
||||
我们专门在 `core/utils/singleton.py` 搞了个基类,继承一下就行。
|
||||
我专门在 `core/utils/singleton.py` 搞了个基类,继承一下就行,你会的,加油。。。
|
||||
|
||||
## 认识一下这帮“官”
|
||||
## 认识一下
|
||||
|
||||
### 1. `CommandManager` (外号 `matcher`)
|
||||
### 1. `CommandManager` (`matcher`)
|
||||
|
||||
* **怎么找**: `from core.managers.command_manager import matcher`
|
||||
* **管啥**:
|
||||
* **总调度**: 所有消息都得从它这过一遍,它说了算分给谁。
|
||||
* **总调度**: 所有消息都得从它这过一遍
|
||||
* **发牌的**: 你用的 `@matcher.command()` 这种装饰器,就是它发的。
|
||||
* **对号入座**: 消息来了,它负责对一下,看是哪个插件的活儿。
|
||||
* **对号入座**: 消息来了,它负责对一下,看是哪个插件的。
|
||||
|
||||
写插件天天都得跟它打交道。
|
||||
|
||||
### 2. `PermissionManager` (外号 `permission_manager`)
|
||||
### 2. `PermissionManager` (`permission_manager`)
|
||||
|
||||
* **怎么找**: `from core.managers.permission_manager import permission_manager`
|
||||
* **管啥**:
|
||||
* **划分三六九等**: `ADMIN`, `OP`, `USER` 这些等级都是它定的。
|
||||
* **记小本本**: 谁有啥权限,都记在 `core/data/permissions.json` 里。
|
||||
* **管理权限**: 谁有啥权限,都记在 `core/data/permissions.json` 里。
|
||||
* **会自动变通**: 查权限的时候,它会把 `AdminManager` 里的超管也当成 `ADMIN`。
|
||||
|
||||
### 3. `AdminManager` (外号 `admin_manager`)
|
||||
### 3. `AdminManager` (`admin_manager`)
|
||||
|
||||
* **怎么找**: `from core.managers.admin_manager import admin_manager`
|
||||
* **管啥**:
|
||||
* **钦差大臣**: 专门管机器人的超级管理员,增删改查都在这。
|
||||
* **三级缓存**: 内存 -> Redis -> 文件,又快又稳。
|
||||
* **三级缓存**: 内存 -> Redis -> 文件
|
||||
|
||||
### 4. `PluginManager`
|
||||
|
||||
@@ -45,36 +45,36 @@
|
||||
* **拉人头**: 启动时把 `plugins/` 目录下的插件都拉进来。
|
||||
* **热更新**: 你改了插件代码,它负责重载,不用重启机器人。
|
||||
|
||||
这家伙一般在幕后,你基本不用找它。
|
||||
这一般在幕后,你基本不用找它。
|
||||
|
||||
### 5. `RedisManager` (外号 `redis_manager`)
|
||||
### 5. `RedisManager` (`redis_manager`)
|
||||
|
||||
* **怎么找**: `from core.managers.redis_manager import redis_manager`
|
||||
* **管啥**:
|
||||
* **接线员**: 管着和 Redis 的连接。
|
||||
* **提供工具**: 你要用 Redis,就找它要 `redis_manager.redis`。
|
||||
* **提供工具**: 你要用 Redis,就找 `redis_manager.redis`。
|
||||
|
||||
### 6. `BrowserManager` (外号 `browser_manager`)
|
||||
### 6. `BrowserManager` (`browser_manager`)
|
||||
|
||||
* **怎么找**: `from core.managers.browser_manager import browser_manager`
|
||||
* **管啥**:
|
||||
* **浏览器司机**: 负责启动和关闭 Playwright。
|
||||
* **开个页面池**: 提前准备好几个空白页面(默认3个),你要用直接拿,省下几百毫秒的启动时间。
|
||||
* **循环利用**: 用完记得还回来 (`release_page`),建设节约型社会。
|
||||
* **浏览器**: 负责启动和关闭 Playwright。
|
||||
* **页面池**: 提前准备好几个空白页面(默认3个),你要用直接拿
|
||||
* **循环利用**: 用完记得还回来 (`release_page`)
|
||||
|
||||
### 7. `ImageManager` (外号 `image_manager`)
|
||||
### 7. `ImageManager` (`image_manager`)
|
||||
|
||||
* **怎么找**: `from core.managers.image_manager import image_manager`
|
||||
* **管啥**:
|
||||
* **美工**: 把数据塞进网页模板,然后用浏览器咔嚓一下截图。
|
||||
* **美工**: 把数据塞进网页模板
|
||||
* **记性好**: 模板用一次就记住,下次直接用缓存。
|
||||
* **自动借还**: 它会自动找 `BrowserManager` 借页面,你只管喊一声 `render_template` 就行。
|
||||
* **自动借还**: 它会自动找 `BrowserManager` 借页面,你只管 `render_template` 就行。
|
||||
|
||||
## 咋用?
|
||||
|
||||
简单粗暴:`import` 就完事了。
|
||||
`import`
|
||||
|
||||
**举个栗子**: 查查这人是不是管理员。
|
||||
**例子**: 查查这人是不是op
|
||||
|
||||
```python
|
||||
# plugins/my_plugin.py
|
||||
|
||||
Reference in New Issue
Block a user