Files
picoclaw/docs/channels/matrix/README.zh.md
T
BeaconCat 403ceb39be docs: fix inaccuracies, add translations, and expand channel docs (#1837)
## Config field fixes (cross-verified against Go source)
- MaixCam: server_address → host + port
- IRC: use_tls → tls, channels_to_join → channels (all 6 languages)
- WeCom AI Bot: callback port 18791 → 18790
- credential_encryption: base_url → api_base, add required model field,
  remove incorrect passphrase-only mode docs
- providers.md: agents.defaults.model → model_name (×4), remove
  non-existent session.backlog_limit
- migration guide, troubleshooting: agents.defaults.model → model_name
- ANTIGRAVITY_AUTH: fix file path, Go 1.21 → 1.25, model → model_name
- spawn-tasks: fix truncated file, add Heartbeat introduction
- tools_configuration: add Tavily/SearXNG/GLMSearch, exec allow_remote/
  timeout_seconds/custom_allow_patterns, cron allow_command, skills
  github/search_cache, clawhub timeout/max_zip_size/max_response_size
- configuration: fix builtin skills path (build-time embedded, not cwd),
  HEARTBEAT.md marked auto-generated

## Broken link fixes (15 total)
- chat-apps.md: WeCom/Matrix links with wrong relative paths
- providers.md: migration link with extra docs/ prefix
- hardware-compatibility.md: README links with wrong depth (all 5 langs)
- chat-apps.md: WhatsApp dead links → anchor links (zh/ja)

## Getting-started accuracy
- README (all 6 langs): add picoclaw.io as recommended download,
  add missing picoclaw model CLI command
- docker.md: clarify first-run trigger condition (all 6 langs)
- configuration.md: fix builtin skills path description (all 6 langs)

## QQ channel
- Add quick setup via q.qq.com/qqbot/openclaw (one-click bot creation)
- Add manual setup as fallback (all 6 languages)

## Feishu channel
- Update setup flow: WebSocket/SDK mode, no webhook URL needed
- Preserve Lark international domain note (all 6 languages)

## chat-apps.md
- Add Feishu, Slack, IRC, OneBot detail sections (all 6 languages)
- Add MaixCam section to ja/fr/pt-br/vi
- Fix all channel doc links to point to correct language version

## New translations (25 files, 5 docs × 5 languages)
debug.md, credential_encryption.md, hardware-compatibility.md,
ANTIGRAVITY_AUTH.md, ANTIGRAVITY_USAGE.md → zh/ja/fr/pt-br/vi

## Channel docs (6 languages each, 60 new files)
telegram, discord, qq, feishu, maixcam, dingtalk, line, slack, onebot,
wecom/wecom_aibot, wecom/wecom_app, wecom/wecom_bot

Co-authored-by: BeaconCat <BeaconCat@users.noreply.github.com>
2026-03-20 22:37:05 +08:00

2.1 KiB
Raw Blame History

Matrix 通道配置指南

1. 配置示例

config.json 中添加:

{
  "channels": {
    "matrix": {
      "enabled": true,
      "homeserver": "https://matrix.org",
      "user_id": "@your-bot:matrix.org",
      "access_token": "YOUR_MATRIX_ACCESS_TOKEN",
      "device_id": "",
      "join_on_invite": true,
      "allow_from": [],
      "group_trigger": {
        "mention_only": true
      },
      "placeholder": {
        "enabled": true,
        "text": "Thinking... 💭"
      },
      "reasoning_channel_id": ""
    }
  }
}

2. 参数说明

字段 类型 必填 说明
enabled bool 是否启用 Matrix 通道
homeserver string Matrix 服务器地址(例如 https://matrix.org
user_id string 机器人 Matrix 用户 ID(例如 @bot:matrix.org
access_token string 机器人 access token
device_id string 设备 ID(可选)
join_on_invite bool 是否自动加入邀请房间
allow_from []string 白名单用户(Matrix 用户 ID
group_trigger object 群聊触发策略(支持 mention_only / prefixes
placeholder object 占位消息配置
reasoning_channel_id string 思维链输出目标通道
message_format string 消息格式:richtext(富文本)或 plain(纯文本)

3. 当前支持

  • 文本消息收发
  • 图片/音频/视频/文件消息入站下载(写入 MediaStore / 本地路径回退)
  • 音频消息按统一标记进入现有转写流程([audio: ...]
  • 图片/音频/视频/文件消息出站发送(上传到 Matrix 媒体库后发送)
  • 群聊触发规则(支持仅 @ 提及时响应)
  • Typing 状态(m.typing
  • 占位消息(Thinking... 💭+ 最终回复替换
  • 自动加入邀请房间(可关闭)

4. TODO

  • 富媒体细节增强(如 image/video 的尺寸、缩略图等 metadata