From 0b4a19051f13524c16ee2ee13ed3a620257c2be6 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Mon, 18 Nov 2024 11:43:25 +0800 Subject: [PATCH] =?UTF-8?q?doc:=20=E6=B7=BB=E5=8A=A0=20=E6=B6=88=E6=81=AF?= =?UTF-8?q?=E5=B9=B3=E5=8F=B0=E5=AE=9E=E4=BD=93=E7=9A=84=E5=90=91=E5=90=8E?= =?UTF-8?q?=E5=85=BC=E5=AE=B9=E6=80=A7=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/plugin/dev/messages.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/plugin/dev/messages.md b/docs/plugin/dev/messages.md index c329eab10..35a590877 100644 --- a/docs/plugin/dev/messages.md +++ b/docs/plugin/dev/messages.md @@ -7,7 +7,7 @@ LangBot 支持多种消息平台，但每个消息平台的`消息实体`格式均不相同，为了屏蔽这些差异，LangBot 具有一套统一的标准。插件开发者只需要掌握并在插件中使用此页所述的消息实体，LangBot 内部的消息处理逻辑能够自动完成消息的解析和转换。 :::info -LangBot 的消息平台实体是基于 [YiriMirai](https://github.com/YiriMiraiProject/YiriMirai) 的实现改造的 +LangBot 的消息平台实体是基于 [YiriMirai](https://github.com/YiriMiraiProject/YiriMirai) 的实现改造的。 ::: ## 消息链 @@ -72,3 +72,11 @@ msg_chain = MessageChain([ 除了上述实体之外，还有`好友 Friend`和`群 Group`等实体，这些实体的定义位于`pkg/platform/types/entities.py`中。 他们一般被包含于上述事件对象中，可以从中取得一些未被包含在插件事件中的信息。 + +## 向后兼容性 + +以 3.x 版本为基础开发的插件，均可以无缝适配 3.4 版本。但 `import mirai` 在新版本已经不受支持，开发插件时编辑器会报错。请做如下修改： + +- `import mirai` 改为 `import pkg.platform.types as mirai` + - 不建议直接改成 `as mirai`，建议使用 `import pkg.platform.types as platform_types` 并将插件代码中对应的 `mirai.xxx` 替换为 `platform_types.xxx` +- `from mirai import *` 改为 `from pkg.platform.types import *`