matrix adapter

zh-CN/about/contact.md

@@ -26,5 +26,4 @@
 
 <https://forum.koishi.xyz>
 
-论坛是一种特别的讨论方式，它允许你的问题、想法、反馈被永久的保存下来，并且可以同时进行不同的讨论。
-你的问题在论坛有更大的可能性获得解答，并且能够保存下来让他人也受益。
+论坛是一种特别的讨论方式，它允许你的问题、想法、反馈被永久的保存下来，并且可以同时进行不同的讨论。你的问题在论坛有更大的可能性获得解答，并且能够保存下来让他人也受益。

zh-CN/manual/console/adapter.md

@@ -80,6 +80,31 @@ Koishi 使用适配器插件来支持各种聊天平台。其中，常用的适
 - 发送邮件服务器：`smtp.gmail.com`，端口号 `465`
 - 参考：[通过其他电子邮件平台查看 Gmail](https://support.google.com/mail/answer/7126229?hl=zh-Hans#zippy=%2C%E7%AC%AC-%E6%AD%A5%E6%A3%80%E6%9F%A5-imap-%E6%98%AF%E5%90%A6%E5%B7%B2%E5%90%AF%E7%94%A8%2C%E7%AC%AC-%E6%AD%A5%E5%9C%A8%E7%94%B5%E5%AD%90%E9%82%AE%E4%BB%B6%E5%AE%A2%E6%88%B7%E7%AB%AF%E4%B8%AD%E6%9B%B4%E6%94%B9-smtp-%E5%92%8C%E5%85%B6%E4%BB%96%E8%AE%BE%E7%BD%AE)
 
+## Matrix
+
+1. 参考 [此链接](https://spec.matrix.org/unstable/application-service-api/#registration) 编写 `registry.yaml` 文件：
+
+```yaml
+id: koishi                    # Application Service 的 ID
+hs_token:                     # 填入任意内容，与配置文件相对应，请确保不会泄漏
+as_token:                     # 填入任意内容，与配置文件相对应，请确保不会泄漏
+url:                          # 你的机器人地址，通常是 {selfUrl}/matrix
+sender_localpart: koishi      # 不能与机器人的 ID 相同
+namespaces:
+  users:
+  - exclusive: true
+    # 这里填入你的机器人的 userId
+    # 如果需要同时接入多个 matrix 机器人，请使用正则表达式
+    regex: '@koishi:matrix.example.com'
+```
+
+2. 将 `registry.yaml` 添加进你的服务器 (如 synapse 则使用 `app_service_config_files` 配置项来指向 `registry.yaml` 并重启服务器)
+3. 在控制台中配置本插件，`host` 填入你的 homeserver 域名，`hs_token`, `as_token` 上述文件中的对应值，`id` 填入任意值 (需要与 `sender_localpart` 不同)
+4. 安装 [koishi-plugin-verifier](https://common.koishi.chat/plugins/verifier.html) (或其他自助通过群组邀请的插件)
+5. 在房间中邀请机器人 (机器人的 ID 为 `@${id}:${host}`)
+
+参考：[@koishijs/plugin-adapter-matrix](../../plugins/adapter/matrix.md)
+
 ## OneBot
 
 这里只介绍最常见的 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) 配置方法。

zh-CN/plugins/adapter/matrix.md

@@ -0,0 +1,72 @@
+# @koishijs/plugin-adapter-matrix
+
+## 接入方式
+
+1. 参考 [此链接](https://spec.matrix.org/unstable/application-service-api/#registration) 编写 `registry.yaml` 文件：
+
+```yaml
+id: koishi                    # Application Service 的 ID
+hs_token:                     # 填入任意内容，与配置文件相对应，请确保不会泄漏
+as_token:                     # 填入任意内容，与配置文件相对应，请确保不会泄漏
+url:                          # 你的机器人地址，通常是 {selfUrl}/matrix
+sender_localpart: koishi      # 不能与机器人的 ID 相同
+namespaces:
+  users:
+  - exclusive: true
+    # 这里填入你的机器人的 userId
+    # 如果需要同时接入多个 matrix 机器人，请使用正则表达式
+    regex: '@koishi:matrix.example.com'
+```
+
+2. 将 `registry.yaml` 添加进你的服务器 (如 synapse 则使用 `app_service_config_files` 配置项来指向 `registry.yaml` 并重启服务器)
+3. 在控制台中配置本插件，`host` 填入你的 homeserver 域名，`hs_token`, `as_token` 上述文件中的对应值，`id` 填入任意值 (需要与 `sender_localpart` 不同)
+4. 安装 [koishi-plugin-verifier](https://common.koishi.chat/plugins/verifier.html) (或其他自助通过群组邀请的插件)
+5. 在房间中邀请机器人 (机器人的 ID 为 `@${id}:${host}`)
+
+## 配置项
+
+### options.id
+
+- 类型: `string`
+- 必需参数
+
+机器人的 ID。机器人最后的用户名将会是 `@{id}:{host}`。请注意不能与上面的 `sender_localpart` 相同。
+
+### options.host
+
+- 类型: `string`
+- 必需参数
+
+你的 matrix homeserver 域名。
+
+### options.hsToken
+
+- 类型: `string`
+- 必需参数
+
+与上述文件中的 `hs_token` 对应。
+
+### options.asToken
+
+- 类型: `string`
+- 必需参数
+
+与上述文件中的 `as_token` 对应。
+
+### options.endpoint
+
+- 类型: `string`
+
+你的 matrix homeserver 地址。默认为 `https://{host}`。
+
+### options.name
+
+- 类型: `string`
+
+机器人的名称，如果设置了将会在启动时为机器人更改。
+
+### options.avatar
+
+- 类型: `string`
+
+机器人的头像地址，如果设置了将会在启动时为机器人更改。

zh-CN/plugins/index.md

@@ -9,6 +9,7 @@ Koishi 官方提供了许多插件。为了更好地模块化开发，它们被
 - [@koishijs/plugin-adapter-lark](./adapter/lark.md)
 - [@koishijs/plugin-adapter-line](./adapter/line.md)
 - [@koishijs/plugin-adapter-mail](./adapter/mail.md)
+- [@koishijs/plugin-adapter-matrix](./adapter/matrix.md)
 - [@koishijs/plugin-adapter-onebot](./adapter/onebot.md)
 - [@koishijs/plugin-adapter-qqguild](./adapter/qqguild.md)
 - [@koishijs/plugin-adapter-telegram](./adapter/telegram.md)