icewind1991/mx-puppet-steam

mx-puppet-steam

镜像概述和主要用途

mx-puppet-steam是一个基于https://github.com/Sorunome/mx-puppet-bridge%E7%9A%84Matrix%E4%B8%8ESteam%E5%82%80%E5%84%A1%E6%A1%A5%E6%8E%A5%E5%99%A8%E3%80%82%E8%AF%A5%E6%A1%A5%E6%8E%A5%E5%99%A8%E9%80%9A%E8%BF%87%E5%82%80%E5%84%A1%E6%8A%80%E6%9C%AF%E7%99%BB%E5%BD%95Steam%E8%B4%A6%E6%88%B7%EF%BC%88%E4%BD%BF%E7%94%A8%E4%B8%8E%E5%B8%B8%E8%A7%84Steam%E8%B4%A6%E6%88%B7%E7%9B%B8%E5%90%8C%E7%9A%84API%EF%BC%89%EF%BC%8C%E5%B0%86Steam%E6%94%B6%E5%88%B0%E7%9A%84%E6%B6%88%E6%81%AF%E8%BD%AC%E5%8F%91%E8%87%B3Matrix%E8%81%8A%E5%A4%A9%E5%AE%A4%EF%BC%8C%E5%B9%B6%E5%B0%86Matrix%E8%81%8A%E5%A4%A9%E5%AE%A4%E4%B8%AD%E5%8F%91%E9%80%81%E7%9A%84%E6%B6%88%E6%81%AF%E5%9B%9E%E4%BC%A0%E8%87%B3Steam%EF%BC%8C%E5%AE%9E%E7%8E%B0%E4%B8%A4%E4%B8%AA%E5%B9%B3%E5%8F%B0%E9%97%B4%E7%9A%84%E6%B6%88%E6%81%AF%E4%BA%92%E9%80%9A%E3%80%82

核心功能和特性

• ✅ 支持Steam Guard登录（手机或***验证）
• ✅ 一对一消息通讯
• ✅ 群组消息通讯
• ✅ Steam与Matrix间的输入状态通知（正在输入）
• ✅ 在线/离线状态同步
• ✅ 从Steam获取用户昵称和头像
• ✅ Steam用户列表展示
• ❌ Steam群组聊天列表展示（未实现）
• ❌ 群组聊天成员列表展示（未实现）
• ✅ 一对一聊天中嵌入图片桥接
• ✅ 从Steam群组聊天接收嵌入图片
• ❌ 向Steam群组聊天发送嵌入图片（未实现）
• ✅ Steam表情符号向Matrix桥接

使用场景和适用范围

适用于希望在Matrix平台统一管理Steam消息的用户，支持个人和群组聊天场景，可同步基本用户信息和消息状态，满足跨平台即时通讯需求。

使用方法和配置说明

环境要求

运行该桥接器需至少Node.js 12环境。

常规部署步骤

1. 克隆仓库并安装依赖：

   bash
   git clone https://github.com/icewind1991/mx-puppet-steam
   cd mx-puppet-steam
   npm install
   

2. 复制并编辑配置文件：

   bash
   cp sample.config.yaml config.yaml
   # 根据需求编辑config.yaml
   

3. 生成应用服务注册文件（可选参数及默认值在方括号中显示）：

   bash
   npm run start -- -r [-c config.yaml] [-f steam-registration.yaml]
   

4. 将注册文件路径添加到Synapse的homeserver.yaml配置中，在app_service_config_files项下添加，然后重启Synapse。

5. 启动桥接器：

   bash
   npm run start
   

Docker部署

若偏好Docker部署，可使用镜像https://hub.docker.com/r/icewind1991/mx-puppet-steam%E3%80%82

链接账号

1. 与机器人账号@_steampuppet_bot:yourserver.com发起聊天
2. 发送命令链接Steam账号：

   link <用户名> <密码>
   

3. 若需要Steam Guard（手机或***）验证码，按提示输入即可完成链接。

临时事件支持

如需将Matrix的临时事件（输入通知、已读标记、在线状态）桥接到Steam，需在Synapse中启用实验性支持，在注册文件中添加以下配置：

yaml
"de.sorunome.msc2409.push_ephemeral": true

项目 credits

本项目的实现离不开以下项目的支持：

• https://github.com/Sorunome/mx-puppet-bridge%EF%BC%88%E4%BD%9C%E8%80%85%EF%BC%9ASorunome%EF%BC%89
• https://github.com/DoctorMcKay/node-steam-user/%EF%BC%88%E4%BD%9C%E8%80%85%EF%BC%9ADoctorMcKay%EF%BC%89