mirror of https://github.com/sipeed/picoclaw.git synced 2026-06-12 18:08:54 +00:00

Files

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

README.md

Enable rich-text messages in matrix channel (#1370 )

2026-03-12 01:25:28 +08:00

README.zh.md

docs: fix inaccuracies, add translations, and expand channel docs (#1837 )

2026-03-20 22:37:05 +08:00

README.md

Matrix Channel Configuration Guide

1. Example Configuration

Add this to 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": "",
      "message_format": "richtext"
    }
  }
}

2. Field Reference

Field	Type	Required	Description
enabled	bool	Yes	Enable or disable the Matrix channel
homeserver	string	Yes	Matrix homeserver URL (for example `https://matrix.org`)
user_id	string	Yes	Bot Matrix user ID (for example `@bot:matrix.org`)
access_token	string	Yes	Bot access token
device_id	string	No	Optional Matrix device ID
join_on_invite	bool	No	Auto-join invited rooms
allow_from	[]string	No	User whitelist (Matrix user IDs)
group_trigger	object	No	Group trigger strategy (`mention_only` / `prefixes`)
placeholder	object	No	Placeholder message config
reasoning_channel_id	string	No	Target channel for reasoning output
message_format	string	No	Output format: `"richtext"` (default) renders markdown as HTML; `"plain"` sends plain text only

3. Currently Supported

Text message send/receive with markdown rendering (bold, italic, headers, code blocks, etc.)
Configurable message format (richtext / plain)
Incoming image/audio/video/file download (MediaStore first, local path fallback)
Incoming audio normalization into existing transcription flow ([audio: ...])
Outgoing image/audio/video/file upload and send
Group trigger rules (including mention-only mode)
Typing state (m.typing)
Placeholder message + final reply replacement
Auto-join invited rooms (can be disabled)

4. TODO

Rich media metadata improvements (for example image/video size and thumbnails)