github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2024-12-27 09:00:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add mirai-code-specification.md

Browse Source
This commit is contained in:
Him188 2020-06-12 16:17:37 +08:00
parent 7583172976
commit c9988f4c6a
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/mirai-code-specification.md Normal file
View File

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