docs: 更新文档内容并优化语言风格
重构所有文档内容,使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范
This commit is contained in:
@@ -1,51 +1,10 @@
|
||||
# 插件开发:基础指南
|
||||
# 插件开发入门
|
||||
|
||||
在 NEO Bot Framework 中,几乎所有的功能都是通过**插件**来实现的。框架提供了一个强大而简单的插件系统,让您可以专注于功能逻辑的实现。
|
||||
写插件是给 NEO Bot 添加功能的唯一方式。这玩意儿很简单,一个 Python 文件就是一个插件。
|
||||
|
||||
## 插件是什么?
|
||||
## 1. 创建你的第一个插件
|
||||
|
||||
一个插件本质上就是一个位于 `plugins/` 目录下的独立 Python 文件 (`.py`)。
|
||||
|
||||
框架会在启动时自动扫描并加载这个目录下的所有文件作为插件。
|
||||
|
||||
## 🔥 热重载工作流
|
||||
|
||||
在开始编写插件之前,了解框架的**热重载**机制至关重要,它能极大地提升您的开发效率。
|
||||
|
||||
1. **启动机器人**: 首先,在您的终端中运行 `python main.py` 并保持其运行状态。
|
||||
2. **创建或修改插件**: 在 `plugins/` 目录下创建新的 `.py` 文件,或者修改一个已有的插件文件。
|
||||
3. **保存文件**: 当您保存文件时,框架会自动检测到文件变更。
|
||||
4. **自动重载**: 控制台会显示 `插件重载完成` 的日志,这意味着您的新代码已经生效,无需重启整个程序。
|
||||
|
||||
## 创建您的第一个插件
|
||||
|
||||
让我们来创建一个经典的 "Hello World" 插件。
|
||||
|
||||
### 1. 创建文件
|
||||
|
||||
在 `plugins/` 目录下创建一个新文件,命名为 `hello.py`。
|
||||
|
||||
### 2. 定义插件元数据 (`__plugin_meta__`)
|
||||
|
||||
为了让框架能够识别您的插件信息(例如在 `/help` 命令中显示),您需要在文件顶部定义一个名为 `__plugin_meta__` 的特殊字典。
|
||||
|
||||
```python
|
||||
# plugins/hello.py
|
||||
|
||||
__plugin_meta__ = {
|
||||
"name": "你好世界",
|
||||
"description": "一个简单的插件,用于回复 'Hello, World!'。",
|
||||
"usage": "/hello - 发送问候。",
|
||||
}
|
||||
```
|
||||
|
||||
* `name`: 插件的名称。
|
||||
* `description`: 插件功能的简短描述。
|
||||
* `usage`: 插件的使用方法说明。
|
||||
|
||||
### 3. 编写处理器
|
||||
|
||||
现在,让我们来编写一个响应 `/hello` 指令的函数。我们需要从框架中导入 `matcher` 和事件类型。
|
||||
在 `plugins/` 目录下,新建一个 `hello.py` 文件。
|
||||
|
||||
```python
|
||||
# plugins/hello.py
|
||||
@@ -53,36 +12,65 @@ __plugin_meta__ = {
|
||||
from core.managers.command_manager import matcher
|
||||
from models.events.message import MessageEvent
|
||||
|
||||
# __plugin_meta__ 是插件元信息,会在 /help 指令里显示
|
||||
__plugin_meta__ = {
|
||||
"name": "你好世界",
|
||||
"description": "一个简单的插件,用于回复 'Hello, World!'。",
|
||||
"usage": "/hello - 发送问候。",
|
||||
"description": "一个简单的示例插件",
|
||||
"usage": "/hello - 发送你好"
|
||||
}
|
||||
|
||||
# 使用 @matcher.command 装饰器来注册一个指令
|
||||
@matcher.command("hello")
|
||||
async def handle_hello_command(event: MessageEvent):
|
||||
# @matcher.command() 装饰器注册一个命令
|
||||
# "hello" 是命令名,aliases 是别名
|
||||
@matcher.command("hello", aliases=["hi", "你好"])
|
||||
async def handle_hello(event: MessageEvent):
|
||||
"""
|
||||
当用户发送 /hello 时,此函数将被调用。
|
||||
处理 /hello 命令
|
||||
"""
|
||||
# 使用 event.reply() 方法可以快速回复消息到来源地
|
||||
await event.reply("Hello, World!")
|
||||
# event.reply() 是一个快捷方法,可以直接回复消息
|
||||
await event.reply(f"你好,{event.sender.nickname}!")
|
||||
|
||||
```
|
||||
|
||||
### 4. 测试插件
|
||||
## 2. 加载插件
|
||||
|
||||
1. 确保 `python main.py` 正在运行。
|
||||
2. 保存 `plugins/hello.py` 文件。您应该会在控制台看到插件重载的日志。
|
||||
3. 在任何一个机器人所在的群聊或私聊中,发送 `/hello`。
|
||||
4. 机器人应该会回复 `Hello, World!`。
|
||||
不用你动手,NEO Bot 启动时会自动加载 `plugins/` 目录下的所有 `.py` 文件。
|
||||
|
||||
恭喜!您已经成功创建并运行了您的第一个插件。
|
||||
如果你是在 Bot 运行时新增或修改了插件,只需要在控制台输入 `reload` 命令,或者让管理员在群里发 `/reload`,就能热重载所有插件。
|
||||
|
||||
## 插件的最佳实践
|
||||
## 3. 测试插件
|
||||
|
||||
* **保持独立**: 尽量让每个插件文件只负责一项相关的功能。
|
||||
* **清晰命名**: 为您的插件文件和处理函数选择清晰、描述性的名称。
|
||||
* **善用模型**: 充分利用 `models` 中定义的事件和消息段类型,以获得完整的类型提示和代码补全支持。
|
||||
* **异步优先**: 框架是基于 `asyncio` 构建的。对于任何 I/O 密集型操作(如网络请求、文件读写),请务必使用 `async/await` 语法,以避免阻塞事件循环。
|
||||
现在,去群里或者私聊给 Bot 发送:
|
||||
|
||||
现在您已经掌握了插件的基础,可以继续学习更高级的主题,例如[如何处理带参数的指令](./command-handling.md)。
|
||||
* `/hello`
|
||||
* `/hi`
|
||||
* `/你好`
|
||||
|
||||
Bot 应该会回复你:“你好,[你的昵称]!”
|
||||
|
||||
## 插件剖析
|
||||
|
||||
### `__plugin_meta__`
|
||||
|
||||
这个字典不是必须的,但强烈建议写上。它定义了插件的元信息,主要给 `/help` 命令用。
|
||||
|
||||
* `name`: 插件叫啥。
|
||||
* `description`: 这插件是干嘛的。
|
||||
* `usage`: 怎么用,写上具体的指令和说明。
|
||||
|
||||
### `@matcher.command()`
|
||||
|
||||
这是最核心的装饰器,用来注册一个命令处理器。
|
||||
|
||||
* **第一个参数**: `name` (str),命令的主名。
|
||||
* `aliases`: `List[str]`,命令的别名列表。
|
||||
* `permission`: `int`,执行该命令所需的权限等级,默认为 `USER` (所有人可用)。可以是 `ADMIN`, `OP`。
|
||||
|
||||
### 处理器函数
|
||||
|
||||
被 `@matcher.command()` 装饰的函数就是处理器。它必须是一个 `async` 异步函数。
|
||||
|
||||
* **参数**: 框架会自动往里注入参数,你只需要用类型提示声明你需要什么。
|
||||
* `event: MessageEvent`: 这是最常用的,包含了消息的所有信息,比如发送者、群号、消息内容等。
|
||||
* `args: str`: 如果命令有参数(比如 `/echo hello world`),`args` 就是 `hello world` 这部分字符串。
|
||||
|
||||
就这么简单,一个最基础的插件就写完了。
|
||||
|
||||
Reference in New Issue
Block a user