2020-06-12 16:17:37 +08:00
|
|
|
# mirai Code Specification - mirai 码规范
|
|
|
|
|
|
|
|
|
|
> 此文档最后更新于 2020/06/12, 基于 mirai `1.1.0`
|
|
|
|
|
|
|
|
|
|
## mirai 码
|
2020-12-17 11:34:23 +08:00
|
|
|
mirai 的部分 [消息](../mirai-core-api/src/commonMain/kotlin/message/data/Message.kt) 可以表示为形如 `[mirai:atall]` 的字符串.
|
2020-06-16 16:05:36 +08:00
|
|
|
|
2020-06-12 16:17:37 +08:00
|
|
|
## 变更记录
|
|
|
|
|
- `1.1.0`: 引入 mirai 码于 `mirai-serialization` 模块
|
2020-12-19 11:15:57 +08:00
|
|
|
- `1.2.0`: mirai 码集成到 mirai-core。不再需要 `mirai-serialization` 模块。
|
2020-06-12 16:17:37 +08:00
|
|
|
|
|
|
|
|
## 格式
|
|
|
|
|
|
|
|
|
|
格式分为有参数和无参数两种.
|
|
|
|
|
|
|
|
|
|
### 无参数
|
|
|
|
|
|
|
|
|
|
字符串格式: \[mirai:*typename*\]
|
|
|
|
|
|
|
|
|
|
```regex
|
|
|
|
|
(?:\[mirai:([^:]+)\])
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
| Message Type | mirai Code Typename | Example |
|
|
|
|
|
|:-----------------------------------------------------------------------------------|:--------------------|:----------------|
|
2020-12-17 11:34:23 +08:00
|
|
|
| [AtAll](../mirai-core-api/src/commonMain/kotlin/message/data/AtAll.kt) | atall | `[mirai:atall]` |
|
2020-06-12 16:17:37 +08:00
|
|
|
|
|
|
|
|
### 有参数
|
|
|
|
|
字符串格式: \[mirai:*名称*:*参数列表*\]
|
|
|
|
|
多个参数之间使用逗号分隔, 如 `[mirai:at:123456,test]`
|
|
|
|
|
|
|
|
|
|
```regex
|
|
|
|
|
(?:\[mirai:([^\]]*)?:(.*?)?\])
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
| Message Type | mirai Code Typename | Params | Example | Note |
|
|
|
|
|
|:-----------------------------------------------------------------------------------------------------|:--------------------|:----------------------|:------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
2020-12-17 11:34:23 +08:00
|
|
|
| [At](../mirai-core-api/src/commonMain/kotlin/message/data/At.kt#L29) | at | `target`, `display` | `[mirai:at:123456,test]` | `target` 为 at 对象的 QQ 账号;<br /> `display` 为官方客户端中 at 显示的内容 |
|
|
|
|
|
| [Face](../mirai-core-api/src/commonMain/kotlin/message/data/Face.kt#L20) | face | `id` | `[mirai:face:123]` | `id` 见 [Face.IdList](../mirai-core-api/src/commonMain/kotlin/message/data/Face.kt#L36-L237) |
|
|
|
|
|
| [PokeMessage](../mirai-core-api/src/commonMain/kotlin/message/data/HummerMessage.kt#L40) | poke | `name`, `type` , `id` | `[mirai:poke:戳一戳,1,-1]` | 详见 [PokeMessage.Types](../mirai-core-api/src/commonMain/kotlin/message/data/HummerMessage.kt#L55-L138) |
|
|
|
|
|
| [VipFace](../mirai-core-api/src/commonMain/kotlin/message/data/HummerMessage.kt#L149) | vipface | `id`, `name`, `count` | `[mirai:vipface:9,榴莲,5]` | 详见 [VipFace.Companion](../mirai-core-api/src/commonMain/kotlin/message/data/HummerMessage.kt#L174-L225) |
|
|
|
|
|
| [Image](../mirai-core-api/src/commonMain/kotlin/message/data/Image.kt#L35) | image | `imageId` | `[mirai:image:/f8f1ab55-bf8e-4236-b55e-955848d7069f]` | `imageId` 见 [Image.imageId](../mirai-core-api/src/commonMain/kotlin/message/data/Image.kt#L82) |
|
|
|
|
|
| [FlashImage](../mirai-core-api/src/commonMain/kotlin/message/data/HummerMessage.kt#L234) | flash | `imageId` | `[mirai:flash:/f8f1ab55-bf8e-4236-b55e-955848d7069f]` | `imageId` 见 [Image.imageId](../mirai-core-api/src/commonMain/kotlin/message/data/Image.kt#L82) |
|
