Mirai 协议适配器

Mirai 协议适配器是 mirai-api-http 协议的适配器，你需要先按照 mirai-api-http 文档的说明安装 mirai-api-http。

值得注意的是，本适配器仅支持 mirai-api-http 2.3 以上版本。

本适配器支持 mirai-api-http 的 Websocket Adapter 模式和 Reverse Websocket Adapter 模式。

安装

pip install alicebot-adapter-mirai

配置协议端

编辑 mirai-api-http 的配置文件 setting.yml。

Websocket Adapter 模式

adapters:
  - ws
enableVerify: true
verifyKey: 1234567890
adapterSettings:
  ws:
    host: localhost
    port: 8080
    reservedSyncId: -1

Reverse Websocket Adapter 模式

adapters:
  - reverse-ws
enableVerify: true
verifyKey: 1234567890
singleMode: true
adapterSettings:
  reverse-ws:
    destinations:
      - host: localhost
        port: 8080
        path: /mirai/ws
        protocol: ws
        method: GET
    reservedSyncId: -1

配置 AliceBot

编辑 AliceBot 的配置文件 config.toml。

更多项目请参考 Mirai 配置。

Websocket Adapter 模式

[bot]
adapters = ["alicebot.adapter.mirai"]

[adapter.mirai]
adapter_type = "ws"
verify_key = "1234567890"
qq = 机器人QQ号

Reverse Websocket Adapter 模式

[bot]
adapters = ["alicebot.adapter.mirai"]

[adapter.mirai]
adapter_type = "reverse-ws"
verify_key = "1234567890"
qq = 机器人QQ号

发送富文本消息

与 CQHTTP 协议适配器类似，Mirai 适配器也可以轻松地构建富文本消息。

from alicebot import Plugin
from alicebot.adapter.mirai.message import MiraiMessageSegment


class HalloAlice(Plugin):
    async def handle(self) -> None:
        msg = MiraiMessageSegment.plain("Hello, Alice!") + \
              MiraiMessageSegment.image(url="https://www.example.org/1.jpg")
        await self.event.reply(msg)

    async def rule(self) -> bool:
        if self.event.adapter.name != "mirai":
            return False
        if self.event.type != "FriendMessage":
            return False
        return self.event.message.get_plain_text().lower() == "hello"

更多使用方法请参考 mirai-api-http 消息段类型和 Mirai 消息。

调用 mirai-api-http API

你可以使用下面的方法调用 mirai-api-http API：

from alicebot import Plugin


class TestPlugin(Plugin):
    async def handle(self) -> None:
        resp = await self.event.adapter.call_api("friendProfile", target=10001)
        # 等效于 resp = await self.event.adapter.friendProfile(target=10001)

    async def rule(self) -> bool:
        return self.event.adapter.name == "mirai"

更多使用方法请参考 mirai-api-http 文档。