Restore the README to be consistent with upstream to avoid duplicate conflicts.
This commit is contained in:
parent
0930db1170
commit
92610bbdf2
1 changed files with 0 additions and 252 deletions
252
README.zh.md
252
README.zh.md
|
|
@ -280,257 +280,6 @@ picoclaw agent -m "2+2 等于几?"
|
||||||
|
|
||||||
## 💬 聊天应用集成 (Chat Apps)
|
## 💬 聊天应用集成 (Chat Apps)
|
||||||
|
|
||||||
<<<<<<< HEAD
|
|
||||||
通过 Telegram, Discord, 钉钉、企业微信或 WebSocket 与您的 PicoClaw 对话。
|
|
||||||
|
|
||||||
| 渠道 | 设置难度 |
|
|
||||||
| --- | --- |
|
|
||||||
| **Telegram** | 简单 (仅需 token) |
|
|
||||||
| **Discord** | 简单 (bot token + intents) |
|
|
||||||
| **QQ** | 简单 (AppID + AppSecret) |
|
|
||||||
| **钉钉 (DingTalk)** | 中等 (app credentials) |
|
|
||||||
| **企业微信 (WeCom)** | 中等 (企业ID + Webhook配置) |
|
|
||||||
| **WebSocket** | 简单 (局域网 Web 聊天) |
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>Telegram</b> (推荐)</summary>
|
|
||||||
|
|
||||||
**1. 创建机器人**
|
|
||||||
|
|
||||||
* 打开 Telegram,搜索 `@BotFather`
|
|
||||||
* 发送 `/newbot`,按照提示操作
|
|
||||||
* 复制 token
|
|
||||||
|
|
||||||
**2. 配置**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"telegram": {
|
|
||||||
"enabled": true,
|
|
||||||
"token": "YOUR_BOT_TOKEN",
|
|
||||||
"allow_from": ["YOUR_USER_ID"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
> 从 Telegram 上的 `@userinfobot` 获取您的用户 ID。
|
|
||||||
|
|
||||||
**3. 运行**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>Discord</b></summary>
|
|
||||||
|
|
||||||
**1. 创建机器人**
|
|
||||||
|
|
||||||
* 前往 [https://discord.com/developers/applications](https://discord.com/developers/applications)
|
|
||||||
* Create an application → Bot → Add Bot
|
|
||||||
* 复制 bot token
|
|
||||||
|
|
||||||
**2. 开启 Intents**
|
|
||||||
|
|
||||||
* 在 Bot 设置中,开启 **MESSAGE CONTENT INTENT**
|
|
||||||
* (可选) 如果计划基于成员数据使用白名单,开启 **SERVER MEMBERS INTENT**
|
|
||||||
|
|
||||||
**3. 获取您的 User ID**
|
|
||||||
|
|
||||||
* Discord 设置 → Advanced → 开启 **Developer Mode**
|
|
||||||
* 右键点击您的头像 → **Copy User ID**
|
|
||||||
|
|
||||||
**4. 配置**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"discord": {
|
|
||||||
"enabled": true,
|
|
||||||
"token": "YOUR_BOT_TOKEN",
|
|
||||||
"allow_from": ["YOUR_USER_ID"],
|
|
||||||
"mention_only": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
**5. 邀请机器人**
|
|
||||||
|
|
||||||
* OAuth2 → URL Generator
|
|
||||||
* Scopes: `bot`
|
|
||||||
* Bot Permissions: `Send Messages`, `Read Message History`
|
|
||||||
* 打开生成的邀请 URL,将机器人添加到您的服务器
|
|
||||||
|
|
||||||
**6. 运行**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>QQ</b></summary>
|
|
||||||
|
|
||||||
**1. 创建机器人**
|
|
||||||
|
|
||||||
* 前往 [QQ 开放平台](https://q.qq.com/#)
|
|
||||||
* 创建应用 → 获取 **AppID** 和 **AppSecret**
|
|
||||||
|
|
||||||
**2. 配置**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"qq": {
|
|
||||||
"enabled": true,
|
|
||||||
"app_id": "YOUR_APP_ID",
|
|
||||||
"app_secret": "YOUR_APP_SECRET",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
> 将 `allow_from` 设为空以允许所有用户,或指定 QQ 号以限制访问。
|
|
||||||
|
|
||||||
**3. 运行**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>钉钉 (DingTalk)</b></summary>
|
|
||||||
|
|
||||||
**1. 创建机器人**
|
|
||||||
|
|
||||||
* 前往 [开放平台](https://open.dingtalk.com/)
|
|
||||||
* 创建内部应用
|
|
||||||
* 复制 Client ID 和 Client Secret
|
|
||||||
|
|
||||||
**2. 配置**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"dingtalk": {
|
|
||||||
"enabled": true,
|
|
||||||
"client_id": "YOUR_CLIENT_ID",
|
|
||||||
"client_secret": "YOUR_CLIENT_SECRET",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
> 将 `allow_from` 设为空以允许所有用户,或指定 ID 以限制访问。
|
|
||||||
|
|
||||||
**3. 运行**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>企业微信 (WeCom)</b></summary>
|
|
||||||
|
|
||||||
PicoClaw 支持两种企业微信集成方式:
|
|
||||||
|
|
||||||
**选项1: 智能机器人 (WeCom Bot)** - 设置更简单,支持群聊
|
|
||||||
**选项2: 自建应用 (WeCom App)** - 功能更丰富,支持主动推送消息
|
|
||||||
|
|
||||||
详见 [企业微信自建应用配置指南](docs/wecom-app-configuration.md)。
|
|
||||||
|
|
||||||
**快速设置 - 智能机器人:**
|
|
||||||
|
|
||||||
**1. 创建机器人**
|
|
||||||
|
|
||||||
* 前往企业微信管理后台 → 群聊 → 添加群机器人
|
|
||||||
* 复制 Webhook URL (格式: `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx`)
|
|
||||||
|
|
||||||
**2. 配置**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"wecom": {
|
|
||||||
"enabled": true,
|
|
||||||
"token": "YOUR_TOKEN",
|
|
||||||
"encoding_aes_key": "YOUR_ENCODING_AES_KEY",
|
|
||||||
"webhook_url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_KEY",
|
|
||||||
"webhook_host": "0.0.0.0",
|
|
||||||
"webhook_port": 18793,
|
|
||||||
"webhook_path": "/webhook/wecom",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**快速设置 - 自建应用:**
|
|
||||||
|
|
||||||
**1. 创建应用**
|
|
||||||
|
|
||||||
* 前往企业微信管理后台 → 应用管理 → 创建应用
|
|
||||||
* 复制 **AgentId** 和 **Secret**
|
|
||||||
* 前往"我的企业"页面,复制 **CorpID**
|
|
||||||
|
|
||||||
**2. 配置接收消息**
|
|
||||||
|
|
||||||
* 在应用详情页,点击"接收消息" → "设置API"
|
|
||||||
* 设置 URL 为 `http://your-server:18792/webhook/wecom-app`
|
|
||||||
* 生成 **Token** 和 **EncodingAESKey**
|
|
||||||
|
|
||||||
**3. 配置**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"wecom_app": {
|
|
||||||
"enabled": true,
|
|
||||||
"corp_id": "wwxxxxxxxxxxxxxxxx",
|
|
||||||
"corp_secret": "YOUR_CORP_SECRET",
|
|
||||||
"agent_id": 1000002,
|
|
||||||
"token": "YOUR_TOKEN",
|
|
||||||
"encoding_aes_key": "YOUR_ENCODING_AES_KEY",
|
|
||||||
"webhook_host": "0.0.0.0",
|
|
||||||
"webhook_port": 18792,
|
|
||||||
"webhook_path": "/webhook/wecom-app",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**4. 运行**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
> **注意**: 自建应用需要开放 18792 端口用于接收 Webhook 回调。生产环境建议使用反向代理配置 HTTPS。
|
|
||||||
|
|
||||||
</details>
|
|
||||||
=======
|
|
||||||
PicoClaw 支持多种聊天平台,使您的 Agent 能够连接到任何地方。
|
PicoClaw 支持多种聊天平台,使您的 Agent 能够连接到任何地方。
|
||||||
|
|
||||||
### 核心渠道
|
### 核心渠道
|
||||||
|
|
@ -547,7 +296,6 @@ PicoClaw 支持多种聊天平台,使您的 Agent 能够连接到任何地方
|
||||||
| **Line** | ⭐⭐⭐ 较难 | 需要 HTTPS Webhook | [查看文档](docs/channels/line/README.zh.md) |
|
| **Line** | ⭐⭐⭐ 较难 | 需要 HTTPS Webhook | [查看文档](docs/channels/line/README.zh.md) |
|
||||||
| **OneBot** | ⭐⭐ 中等 | 兼容 NapCat/Go-CQHTTP,社区生态丰富 | [查看文档](docs/channels/onebot/README.zh.md) |
|
| **OneBot** | ⭐⭐ 中等 | 兼容 NapCat/Go-CQHTTP,社区生态丰富 | [查看文档](docs/channels/onebot/README.zh.md) |
|
||||||
| **MaixCam** | ⭐ 简单 | 专为 AI 摄像头设计的硬件集成通道 | [查看文档](docs/channels/maixcam/README.zh.md) |
|
| **MaixCam** | ⭐ 简单 | 专为 AI 摄像头设计的硬件集成通道 | [查看文档](docs/channels/maixcam/README.zh.md) |
|
||||||
>>>>>>> upstream/main
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue