mirror of
https://github.com/sipeed/picoclaw.git
synced 2026-05-25 16:00:35 +00:00
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>
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
> Back to [README](../../../README.md)
|
||||
|
||||
# QQ
|
||||
|
||||
PicoClaw provides QQ support via the official Bot API from the QQ Open Platform.
|
||||
|
||||
## Configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"channels": {
|
||||
"qq": {
|
||||
"enabled": true,
|
||||
"app_id": "YOUR_APP_ID",
|
||||
"app_secret": "YOUR_APP_SECRET",
|
||||
"allow_from": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------- | ------ | -------- | -------------------------------------------------------- |
|
||||
| enabled | bool | Yes | Whether to enable the QQ channel |
|
||||
| app_id | string | Yes | App ID of the QQ bot application |
|
||||
| app_secret | string | Yes | App Secret of the QQ bot application |
|
||||
| allow_from | array | No | Allowlist of user IDs; empty means all users are allowed |
|
||||
|
||||
## Setup
|
||||
|
||||
### Quick Setup (Recommended)
|
||||
|
||||
The QQ Open Platform provides a one-click creation entry:
|
||||
|
||||
1. Open [QQ Bot Quick Create](https://q.qq.com/qqbot/openclaw/index.html) and log in by scanning the QR code
|
||||
2. The system automatically creates a bot — copy the **App ID** and **App Secret**
|
||||
3. Fill in the credentials in the PicoClaw configuration file
|
||||
4. Run `picoclaw gateway` to start the service
|
||||
5. Open QQ and start chatting with the bot
|
||||
|
||||
> The App Secret is only shown once — save it immediately. Viewing it again will force a reset.
|
||||
>
|
||||
> Bots created via the quick entry are for the creator's personal use only and do not support group chats. For group chat support, configure sandbox mode on the [QQ Open Platform](https://q.qq.com/).
|
||||
|
||||
### Manual Setup
|
||||
|
||||
1. Log in to the [QQ Open Platform](https://q.qq.com/) with your QQ account and register as a developer
|
||||
2. Create a QQ bot and customize its avatar and name
|
||||
3. Obtain the **App ID** and **App Secret** from the bot settings
|
||||
4. Fill in the credentials in the PicoClaw configuration file
|
||||
5. Run `picoclaw gateway` to start the service
|
||||
6. Search for your bot in QQ and start chatting
|
||||
|
||||
> During development, it is recommended to enable sandbox mode and add test users and groups to the sandbox for debugging.
|
||||
Reference in New Issue
Block a user