fengming 0.3.10 → 0.3.12

package/docs/channels/qqbot.md

@@ -1,314 +0,0 @@
----
-summary: "QQ Bot setup, config, and usage"
-read_when:
-  - You want to connect FengMing to QQ
-  - You need QQ Bot credential setup
-  - You want QQ Bot group or private chat support
-title: QQ bot
----
-
-QQ Bot connects to FengMing via the official QQ Bot API (WebSocket gateway). The
-plugin supports C2C private chat, group @messages, and guild channel messages with
-rich media (images, voice, video, files).
-
-Status: downloadable plugin. Direct messages, group chats, guild channels, and
-media are supported. Reactions and threads are not supported.
-
-## Install
-
-Install QQ Bot before setup:
-
-```bash
-fengming plugins install @fengming/qqbot
-```
-
-## Setup
-
-1. Go to the [QQ Open Platform](https://q.qq.com/) and scan the QR code with your
-   phone QQ to register / log in.
-2. Click **Create Bot** to create a new QQ bot.
-3. Find **AppID** and **AppSecret** on the bot's settings page and copy them.
-
-> AppSecret is not stored in plaintext — if you leave the page without saving it,
-> you'll have to regenerate a new one.
-
-4. Add the channel:
-
-```bash
-fengming channels add --channel qqbot --token "AppID:AppSecret"
-```
-
-5. Restart the Gateway.
-
-Interactive setup paths:
-
-```bash
-fengming channels add
-fengming configure --section channels
-```
-
-## Configure
-
-Minimal config:
-
-```json5
-{
-  channels: {
-    qqbot: {
-      enabled: true,
-      appId: "YOUR_APP_ID",
-      clientSecret: "YOUR_APP_SECRET",
-    },
-  },
-}
-```
-
-Default-account env vars:
-
-- `QQBOT_APP_ID`
-- `QQBOT_CLIENT_SECRET`
-
-File-backed AppSecret:
-
-```json5
-{
-  channels: {
-    qqbot: {
-      enabled: true,
-      appId: "YOUR_APP_ID",
-      clientSecretFile: "/path/to/qqbot-secret.txt",
-    },
-  },
-}
-```
-
-Env SecretRef AppSecret:
-
-```json5
-{
-  channels: {
-    qqbot: {
-      enabled: true,
-      appId: "YOUR_APP_ID",
-      clientSecret: { source: "env", provider: "default", id: "QQBOT_CLIENT_SECRET" },
-    },
-  },
-}
-```
-
-Notes:
-
-- Env fallback applies to the default QQ Bot account only.
-- `fengming channels add --channel qqbot --token-file ...` provides the
-  AppSecret only; the AppID must already be set in config or `QQBOT_APP_ID`.
-- `clientSecret` also accepts SecretRef input, not just a plaintext string.
-- Legacy `secretref:/...` marker strings are not valid `clientSecret` values;
-  use structured SecretRef objects like the example above.
-
-### Multi-account setup
-
-Run multiple QQ bots under a single FengMing instance:
-
-```json5
-{
-  channels: {
-    qqbot: {
-      enabled: true,
-      appId: "111111111",
-      clientSecret: "secret-of-bot-1",
-      accounts: {
-        bot2: {
-          enabled: true,
-          appId: "222222222",
-          clientSecret: "secret-of-bot-2",
-        },
-      },
-    },
-  },
-}
-```
-
-Each account launches its own WebSocket connection and maintains an independent
-token cache (isolated by `appId`).
-
-Add a second bot via CLI:
-
-```bash
-fengming channels add --channel qqbot --account bot2 --token "222222222:secret-of-bot-2"
-```
-
-### Group chats
-
-QQ Bot group chat support uses QQ group OpenIDs, not display names. Add the bot
-to a group, then mention it or configure the group to run without a mention.
-
-```json5
-{
-  channels: {
-    qqbot: {
-      groupPolicy: "allowlist",
-      groupAllowFrom: ["member_openid"],
-      groups: {
-        "*": {
-          requireMention: true,
-          historyLimit: 50,
-          toolPolicy: "restricted",
-        },
-        GROUP_OPENID: {
-          name: "Release room",
-          requireMention: false,
-          ignoreOtherMentions: true,
-          historyLimit: 20,
-          prompt: "Keep replies short and operational.",
-        },
-      },
-    },
-  },
-}
-```
-
-`groups["*"]` sets defaults for every group, and a concrete
-`groups.GROUP_OPENID` entry overrides those defaults for one group. Group
-settings include:
-
-- `requireMention`: require an @mention before the bot replies. Default: `true`.
-- `ignoreOtherMentions`: drop messages that mention someone else but not the bot.
-- `historyLimit`: keep recent non-mention group messages as context for the next mentioned turn. Set `0` to disable.
-- `toolPolicy`: `full`, `restricted`, or `none` for group-scoped tools.
-- `name`: friendly label used in logs and group context.
-- `prompt`: per-group behavior prompt appended to the agent context.
-
-Activation modes are `mention` and `always`. `requireMention: true` maps to
-`mention`; `requireMention: false` maps to `always`. A session-level activation
-override, when present, wins over config.
-
-The inbound queue is per peer. Group peers get a larger queue cap, keep human
-messages ahead of bot-authored chatter when full, and merge bursts of normal
-group messages into one attributed turn. Slash commands still run one by one.
-
-### Voice (STT / TTS)
-
-STT and TTS support two-level configuration with priority fallback:
-
-| Setting | Plugin-specific                                          | Framework fallback            |
-| ------- | -------------------------------------------------------- | ----------------------------- |
-| STT     | `channels.qqbot.stt`                                     | `tools.media.audio.models[0]` |
-| TTS     | `channels.qqbot.tts`, `channels.qqbot.accounts.<id>.tts` | `messages.tts`                |
-
-```json5
-{
-  channels: {
-    qqbot: {
-      stt: {
-        provider: "your-provider",
-        model: "your-stt-model",
-      },
-      tts: {
-        provider: "your-provider",
-        model: "your-tts-model",
-        voice: "your-voice",
-      },
-      accounts: {
-        "qq-main": {
-          tts: {
-            providers: {
-              openai: { voice: "shimmer" },
-            },
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-Set `enabled: false` on either to disable.
-Account-level TTS overrides use the same shape as `messages.tts` and deep-merge
-over the channel/global TTS config.
-
-Inbound QQ voice attachments are exposed to agents as audio media metadata while
-keeping raw voice files out of generic `MediaPaths`. `[[audio_as_voice]]` plain
-text replies synthesize TTS and send a native QQ voice message when TTS is
-configured.
-
-Outbound audio upload/transcode behavior can also be tuned with
-`channels.qqbot.audioFormatPolicy`:
-
-- `sttDirectFormats`
-- `uploadDirectFormats`
-- `transcodeEnabled`
-
-## Target formats
-
-| Format                     | Description        |
-| -------------------------- | ------------------ |
-| `qqbot:c2c:OPENID`         | Private chat (C2C) |
-| `qqbot:group:GROUP_OPENID` | Group chat         |
-| `qqbot:channel:CHANNEL_ID` | Guild channel      |
-
-> Each bot has its own set of user OpenIDs. An OpenID received by Bot A **cannot**
-> be used to send messages via Bot B.
-
-## Slash commands
-
-Built-in commands intercepted before the AI queue:
-
-| Command        | Description                                                                                              |
-| -------------- | -------------------------------------------------------------------------------------------------------- |
-| `/bot-ping`    | Latency test                                                                                             |
-| `/bot-version` | Show the FengMing framework version                                                                      |
-| `/bot-help`    | List all commands                                                                                        |
-| `/bot-me`      | Show the sender's QQ user ID (openid) for `allowFrom`/`groupAllowFrom` setup                             |
-| `/bot-upgrade` | Show the QQBot upgrade guide link                                                                        |
-| `/bot-logs`    | Export recent gateway logs as a file                                                                     |
-| `/bot-approve` | Approve a pending QQ Bot action (for example, confirming a C2C or group upload) through the native flow. |
-
-Append `?` to any command for usage help (for example `/bot-upgrade ?`).
-
-Admin commands (`/bot-me`, `/bot-upgrade`, `/bot-logs`, `/bot-clear-storage`, `/bot-streaming`, `/bot-approve`) are direct-message-only and require the sender's openid in an explicit non-wildcard `allowFrom` list. A wildcard `allowFrom: ["*"]` permits chat but does not grant admin command access. Group messages match against `groupAllowFrom` first and fall back to `allowFrom`. Running an admin command in a group returns a hint rather than silently dropping.
-
-When QQ Bot exec approvals use the default same-chat fallback, native approval
-button clicks follow the same explicit non-wildcard command allowlist. To grant
-approval-only access without broader command access, configure
-`channels.qqbot.execApprovals.approvers`.
-
-## Engine architecture
-
-QQ Bot ships as a self-contained engine inside the plugin:
-
-- Each account owns an isolated resource stack (WebSocket connection, API client, token cache, media storage root) keyed by `appId`. Accounts never share inbound/outbound state.
-- The multi-account logger tags log lines with the owning account so diagnostics stay separable when you run several bots under one gateway.
-- Inbound, outbound, and gateway bridge paths share a single media payload root under `~/.fengming/media`, so uploads, downloads, and transcode caches land under one guarded directory instead of a per-subsystem tree.
-- Rich media delivery goes through one `sendMedia` path for C2C and group targets. Local files and buffers above the large-file threshold use QQ's chunked upload endpoints, while smaller payloads use the one-shot media API.
-- Credentials can be backed up and restored as part of standard FengMing credential snapshots; the engine re-attaches each account's resource stack on restore without requiring a fresh QR-code pair.
-
-## QR-code onboarding
-
-As an alternative to pasting `AppID:AppSecret` manually, the engine supports a QR-code onboarding flow for linking a QQ Bot to FengMing:
-
-1. Run the QQ Bot setup path (for example `fengming channels add --channel qqbot`) and pick the QR-code flow when prompted.
-2. Scan the generated QR code with the phone app tied to the target QQ Bot.
-3. Approve the pairing on the phone. FengMing persists the returned credentials into `credentials/` under the right account scope.
-
-Approval prompts generated by the bot itself (for example, "allow this action?" flows exposed by the QQ Bot API) surface as native FengMing prompts that you can accept with `/bot-approve` rather than replying through the raw QQ client.
-
-## Troubleshooting
-
-- **Bot replies "gone to Mars":** credentials not configured or Gateway not started.
-- **No inbound messages:** verify `appId` and `clientSecret` are correct, and the
-  bot is enabled on the QQ Open Platform.
-- **Repeated self-replies:** FengMing records QQ outbound ref indexes as
-  bot-authored and ignores inbound events whose current `msgIdx` matches that
-  same bot account. This prevents platform echo loops while still allowing users
-  to quote or reply to previous bot messages.
-- **Setup with `--token-file` still shows unconfigured:** `--token-file` only sets
-  the AppSecret. You still need `appId` in config or `QQBOT_APP_ID`.
-- **Proactive messages not arriving:** QQ may intercept bot-initiated messages if
-  the user hasn't interacted recently.
-- **Voice not transcribed:** ensure STT is configured and the provider is reachable.
-
-## Related
-
-- [Pairing](/channels/pairing)
-- [Groups](/channels/groups)
-- [Channel troubleshooting](/channels/troubleshooting)