mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-15 17:30:13 +08:00
feat(matrix): add missing Matrix constant and update docs (#7368)
* feat(matrix): 添加 Matrix 平台适配器支持及更新文档 * feat(matrix): 添加 Matrix 平台图标和教程链接
This commit is contained in:
@@ -22,6 +22,7 @@ UNIQUE_SESSION_ID_BUILDERS: dict[str, Callable[[AstrMessageEvent], str | None]]
|
||||
"qq_official_webhook": lambda e: e.get_sender_id(),
|
||||
"lark": lambda e: f"{e.get_sender_id()}%{e.get_group_id()}",
|
||||
"misskey": lambda e: f"{e.get_session_id()}_{e.get_sender_id()}",
|
||||
"matrix": lambda e: f"{e.get_sender_id()}_{e.get_group_id() or e.get_session_id()}",
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -22,6 +22,7 @@ class PlatformAdapterType(enum.Flag):
|
||||
SATORI = enum.auto()
|
||||
MISSKEY = enum.auto()
|
||||
LINE = enum.auto()
|
||||
MATRIX = enum.auto()
|
||||
ALL = (
|
||||
AIOCQHTTP
|
||||
| QQOFFICIAL
|
||||
@@ -38,6 +39,7 @@ class PlatformAdapterType(enum.Flag):
|
||||
| SATORI
|
||||
| MISSKEY
|
||||
| LINE
|
||||
| MATRIX
|
||||
)
|
||||
|
||||
|
||||
@@ -57,6 +59,7 @@ ADAPTER_NAME_2_TYPE = {
|
||||
"satori": PlatformAdapterType.SATORI,
|
||||
"misskey": PlatformAdapterType.MISSKEY,
|
||||
"line": PlatformAdapterType.LINE,
|
||||
"matrix": PlatformAdapterType.MATRIX,
|
||||
}
|
||||
|
||||
|
||||
|
||||
1
dashboard/src/assets/images/platform_logos/matrix.svg
Normal file
1
dashboard/src/assets/images/platform_logos/matrix.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg width="75" height="32" xmlns="http://www.w3.org/2000/svg"><g fill="#000" fill-rule="nonzero"><path d="M.936.732V31.25H3.13v.732H.095V0h3.034v.732zm8.45 9.675v1.544h.044a4.461 4.461.0 011.487-1.368c.58-.323 1.245-.485 1.993-.485.72.0 1.377.14 1.972.42.595.279 1.047.771 1.355 1.477.338-.5.796-.941 1.377-1.323.58-.383 1.266-.574 2.06-.574.602.0 1.16.074 1.674.22.514.148.954.383 1.322.707.366.323.653.746.859 1.268.205.522.308 1.15.308 1.887v7.633H20.71v-6.464c0-.383-.015-.743-.044-1.082a2.305 2.305.0 00-.242-.882 1.473 1.473.0 00-.584-.596c-.257-.146-.606-.22-1.047-.22-.44.0-.796.085-1.068.253-.272.17-.485.39-.639.662a2.654 2.654.0 00-.308.927 7.074 7.074.0 00-.078 1.048v6.354h-3.128v-6.398c0-.338-.007-.673-.021-1.004a2.825 2.825.0 00-.188-.916 1.411 1.411.0 00-.55-.673c-.258-.168-.636-.253-1.135-.253a2.33 2.33.0 00-.584.1 1.94 1.94.0 00-.705.374c-.228.184-.422.449-.584.794-.161.346-.242.798-.242 1.357v6.619H6.434V10.407h2.952zm16.456 1.677a3.751 3.751.0 011.233-1.17 5.37 5.37.0 011.685-.629 9.579 9.579.0 011.884-.187c.573.0 1.153.04 1.74.121.588.081 1.124.24 1.609.475.484.235.88.562 1.19.981.308.42.462.975.462 1.666v5.934c0 .516.03 1.008.088 1.478.058.471.161.824.308 1.06H32.87a4.435 4.435.0 01-.22-1.104c-.5.515-1.087.876-1.762 1.081a7.084 7.084.0 01-2.071.31c-.544.0-1.05-.067-1.52-.2a3.472 3.472.0 01-1.234-.617 2.87 2.87.0 01-.826-1.059c-.199-.426-.298-.934-.298-1.522.0-.647.114-1.18.342-1.6.227-.419.52-.753.881-1.004.36-.25.771-.437 1.234-.562.462-.125.929-.224 1.399-.298.47-.073.932-.132 1.387-.176.456-.044.86-.11 1.212-.199.353-.088.631-.217.837-.386.206-.169.301-.415.287-.74.0-.337-.055-.606-.166-.804a1.217 1.217.0 00-.44-.464 1.737 1.737.0 00-.639-.22 5.292 5.292.0 00-.782-.055c-.617.0-1.101.132-1.454.397-.352.264-.558.706-.617 1.323h-3.128c.044-.735.227-1.345.55-1.83zm6.179 4.423a5.095 5.095.0 01-.639.165 9.68 9.68.0 01-.716.11c-.25.03-.5.067-.749.11a5.616 5.616.0 00-.694.177 2.057 2.057.0 00-.594.298c-.17.125-.305.284-.408.474-.103.192-.154.434-.154.728.0.28.051.515.154.706.103.192.242.342.419.453.176.11.381.187.617.231.234.044.477.066.726.066.617.0 1.094-.102 1.432-.309.338-.205.587-.452.75-.739.16-.286.26-.576.297-.87.036-.295.055-.53.055-.707v-1.17a1.4 1.4.0 01-.496.277zm11.863-6.1v2.096h-2.291v5.647c0 .53.088.883.264 1.059.176.177.529.265 1.057.265.177.0.345-.007.507-.022.161-.015.316-.037.463-.066v2.426a7.49 7.49.0 01-.882.089 21.67 21.67.0 01-.947.022c-.484.0-.944-.034-1.377-.1a3.233 3.233.0 01-1.145-.386 2.04 2.04.0 01-.782-.816c-.191-.353-.287-.816-.287-1.39v-6.728H36.57v-2.096h1.894v-3.42h3.129v3.42h2.29zm4.471.0v2.118h.044a3.907 3.907.0 011.454-1.754 4.213 4.213.0 011.036-.497 3.734 3.734.0 011.145-.176c.206.0.433.037.683.11v2.912a5.862 5.862.0 00-.528-.077 5.566 5.566.0 00-.595-.033c-.573.0-1.058.096-1.454.287a2.52 2.52.0 00-.958.783 3.143 3.143.0 00-.518 1.158 6.32 6.32.0 00-.154 1.434v5.14h-3.128V10.407h2.973zM54.039 8.642V6.06h3.128v2.582H54.04zm3.128 1.765v11.405H54.04V10.407h3.128zm1.63.0h3.569l2.005 2.978 1.982-2.978h3.459l-3.745 5.339 4.208 6.067h-3.57l-2.378-3.596-2.38 3.596h-3.502l4.097-6.001zM74.094 31.25V.732H71.9V0h3.035v31.982H71.9v-.732z"></path></g></svg>
|
||||
|
After Width: | Height: | Size: 3.1 KiB |
@@ -38,6 +38,8 @@ export function getPlatformIcon(name) {
|
||||
return new URL('@/assets/images/platform_logos/misskey.png', import.meta.url).href
|
||||
} else if (name === 'line') {
|
||||
return new URL('@/assets/images/platform_logos/line.png', import.meta.url).href
|
||||
} else if (name === 'matrix') {
|
||||
return new URL('@/assets/images/platform_logos/matrix.svg', import.meta.url).href
|
||||
}
|
||||
}
|
||||
|
||||
@@ -65,6 +67,7 @@ export function getTutorialLink(platformType) {
|
||||
"satori": "https://docs.astrbot.app/platform/satori/llonebot.html",
|
||||
"misskey": "https://docs.astrbot.app/platform/misskey.html",
|
||||
"line": "https://docs.astrbot.app/platform/line.html",
|
||||
"matrix": "https://docs.astrbot.app/platform/matrix.html",
|
||||
}
|
||||
return tutorialMap[platformType] || "https://docs.astrbot.app";
|
||||
}
|
||||
@@ -107,6 +110,7 @@ export function getPlatformDisplayName(platformId) {
|
||||
vocechat: 'vocechat (VoceChat)',
|
||||
satori: 'satori (Satori)',
|
||||
line: 'line (LINE)',
|
||||
matrix: 'matrix (Matrix)',
|
||||
};
|
||||
return displayNameMap[platformId] || platformId;
|
||||
}
|
||||
|
||||
@@ -3,6 +3,27 @@
|
||||
> [!TIP]
|
||||
> 该平台适配器由社区([stevessr](https://github.com/stevessr)) 维护。如果您觉得有帮助,请支持开发者,给该仓库点一个 Star。❤️
|
||||
|
||||
## 部署 Matrix 服务器
|
||||
|
||||
Matrix 是一个 IM 协议,有着丰富的服务端实现。
|
||||
|
||||
请在 [Matrix Server](https://matrix.org/ecosystem/servers/)查看可用的服务端。
|
||||
|
||||
|
||||
|
||||
## 支持的基本消息类型
|
||||
|
||||
|
||||
| 消息类型 | 是否支持接收 | 是否支持发送 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ---------------------------------------------- |
|
||||
| 文本 | 是 | 是 | |
|
||||
| 图片* | 是 | 是 | |
|
||||
| 语音* | 是 | 是 | |
|
||||
| 视频* | 是 | 是 | |
|
||||
| 文件* | 是 | 是 | |
|
||||
| 投票 | 是 | 否 | |
|
||||
*: 会持久化到本地,插件会按配置清理,在发送前会进行上传操作,超过服务器允许大小的上传将会失败
|
||||
|
||||
## 安装 astrbot_plugin_matrix_adapter 插件
|
||||
|
||||
进入 AstrBot WebUI 的插件市场,搜索 `astrbot_plugin_matrix_adapter`,点击安装。
|
||||
@@ -13,7 +34,11 @@
|
||||
|
||||
## 配置
|
||||
|
||||
请参考该仓库的 [README.md](https://github.com/stevessr/astrbot_plugin_matrix_adapter?tab=readme-ov-file#astrbot-matrix-adapter-%E6%8F%92%E4%BB%B6) 进行配置。
|
||||
- **`matrix_homeserver` (必填)`**: 你的 matrix 服务器实例的完整URL地址,支持域名委托自动探测。例如官方实例`https://matrix.org`
|
||||
- **`matrix_user_id`**: 你的 matrix 完整用户名。如 `@username:homeserver.com`
|
||||
- **`matrix_auth_method` (必填)** : 你的登陆方式,可选`password`,`token`,`oauth2`,`qr`推荐使用`password`或`oauth2/qr`模式 (oauth2/qr 模式下请确保用于认证/扫码的设备回调可以访问到 astrbot 配置的公开地址)
|
||||
|
||||
更多请参考该仓库的 [README.md](https://github.com/stevessr/astrbot_plugin_matrix_adapter?tab=readme-ov-file#astrbot-matrix-adapter-%E6%8F%92%E4%BB%B6) 进行配置。
|
||||
|
||||
## 问题提交
|
||||
|
||||
|
||||
Reference in New Issue
Block a user