mirai/docs/MiraiCodeSepecification.md
2020-12-19 11:15:57 +08:00

3.8 KiB

mirai Code Specification - mirai 码规范

此文档最后更新于 2020/06/12, 基于 mirai 1.1.0

mirai 码

mirai 的部分 消息 可以表示为形如 [mirai:atall] 的字符串.

变更记录

  • 1.1.0: 引入 mirai 码于 mirai-serialization 模块
  • 1.2.0: mirai 码集成到 mirai-core。不再需要 mirai-serialization 模块。

格式

格式分为有参数和无参数两种.

无参数

字符串格式: [mirai:typename]

(?:\[mirai:([^:]+)\])
Message Type mirai Code Typename Example
AtAll atall [mirai:atall]

有参数

字符串格式: [mirai:名称:参数列表]
多个参数之间使用逗号分隔, 如 [mirai:at:123456,test]

(?:\[mirai:([^\]]*)?:(.*?)?\])
Message Type mirai Code Typename Params Example Note
At at target, display [mirai:at:123456,test] target 为 at 对象的 QQ 账号;
display 为官方客户端中 at 显示的内容
Face face id [mirai:face:123] idFace.IdList
PokeMessage poke name, type , id [mirai:poke:戳一戳,1,-1] 详见 PokeMessage.Types
VipFace vipface id, name, count [mirai:vipface:9,榴莲,5] 详见 VipFace.Companion
Image image imageId [mirai:image:/f8f1ab55-bf8e-4236-b55e-955848d7069f] imageIdImage.imageId
FlashImage flash imageId [mirai:flash:/f8f1ab55-bf8e-4236-b55e-955848d7069f] imageIdImage.imageId