mirror of
https://github.com/sipeed/picoclaw.git
synced 2026-05-25 16:00:35 +00:00
667fc85d54
add new field type to Channel struct config.channels refactor to channel_list update config version to 3 update the docs
2.1 KiB
2.1 KiB
Back to README
PicoClaw provides QQ support via the official Bot API from the QQ Open Platform.
Configuration
{
"channel_list": {
"qq": {
"enabled": true,
"type": "qq",
"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:
- Open QQ Bot Quick Create and log in by scanning the QR code
- The system automatically creates a bot — copy the App ID and App Secret
- Fill in the credentials in the PicoClaw configuration file
- Run
picoclaw gatewayto start the service - 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.
Manual Setup
- Log in to the QQ Open Platform with your QQ account and register as a developer
- Create a QQ bot and customize its avatar and name
- Obtain the App ID and App Secret from the bot settings
- Fill in the credentials in the PicoClaw configuration file
- Run
picoclaw gatewayto start the service - 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.