Skip to content

快速开始

本文将引导您快速部署和配置 QYbot

前置准备重要

在开始安装前,请完成以下准备工作:

  1. 注册 QQ 开放平台账号

  2. 获取机器人凭证

    • 进入开发管理页面
    • 获取 AppIdAppSecret(只会显示一次,请妥善保存,否则请按照提示重置 AppSecret)
  3. 添加 IP 白名单

    • 开发管理页面中的白名单添加您的部署设备的公网 IP
    • 如果你使用个人电脑部署且不确定白名单如何填写,请访问IP 查询页面,将网页显示的数字 IP 地址(如 39.xxx.xxx.xxx )加入白名单,并阅读下面的重要提示

      重要提示

      家用宽带的公网 IP 通常每几天会变化,如发现正常运行的机器人出现问题,请先检查你的设备公网 ip是否与白名单上的相同,否则请在开发管理页面更新白名单,我们推荐您使用服务器部署:雨云服务器

  4. 配置沙箱环境

    • 进入沙箱配置页面
    • 选择测试群聊(未上线机器人仅能选择 20 人以下群,机器人加入后人数不限)

安装方式

选项 1:引导包安装(仅限 Windows)

最简单的方式

适合 Windows 用户,自动处理依赖

  1. 下载安装程序并放入你期望安装的位置:BotInstall.exe
  2. 运行安装程序,按提示操作
  3. 安装过程中输入您的 AppId 和 AppSecret
  4. 完成安装后运行 start.bat
  5. 测试机器人

注意事项

安装包会自动下载 Chrome 和 Node.js(如未安装)

选项 2:压缩包安装(全平台支持)

最稳定的方式

适合所有操作系统,手动控制更强

  1. 安装前置依赖

    关于 Chrome

    框架本身并不完全依赖 Chrome,但是部分插件的图片生成功能需要 Chrome 依赖,缺失 Chrome 不会影响机器人的正常运行,但是不具备本地生图的能力

  2. 下载并配置

    • 下载压缩包:QYbot_v1.1.5.zip
    • 解压到目标位置
    • 编辑 app.js 文件,填入 AppId 和 AppSecret:
      javascript
      module.exports = {
        botConfig: {
          appId: "你的AppId",
          secret: "你的AppSecret",
          // ...其他配置
        },
      };
  3. 启动机器人

    bash
    # 在解压目录打开终端
    npm start
  4. 测试机器人

选项 3:命令行安装(开发者推荐)

适合开发者

使用 Git 管理代码,便于后续更新

  1. 安装前置依赖

  2. 克隆并配置项目

    bash
    git clone https://github.com/iYeXin/qybot
    cd qybot
    npm install
  3. 编辑配置文件

    • 修改 app.js 填入 AppId 和 AppSecret
  4. 启动机器人

    bash
    npm start

开始使用

群聊: 在你设置的群聊内发送 @你的bot 你好@你的bot 热搜 抖音 ,查看是否正常回复

注意

如果将 @你的bot 复制到聊天框,可能导致机器人无法接接收到消息,请尽量手动输入@符号进行选择

私聊: 给机器人发送 你好热搜 抖音

说明

未上线的机器人需要在QQ 机器人管理端沙箱配置中添加允许的用户才能发送私聊消息

插件操作

安装插件

  1. 插件市场下载插件 ZIP 包
  2. 将 ZIP 包放入 /plugins 目录
  3. 系统会自动解压并加载插件

插件目录结构

/plugins/
  └── my-plugin/
        ├── manifest.json
        ├── main.js
        └── config.js

配置插件

编辑插件目录中的 config.jsconfig.json 文件:

javascript
// 示例:天气插件配置
module.exports = {
  API_KEY: "your_api_key",
  ...
};

常见问题排查

401 未授权错误

解决方案

检查 IP 白名单是否配置正确

机器人不响应消息

检查步骤

  1. 确认消息格式正确:@bot 命令 内容
  2. 检查控制台日志确认是否收到消息
  3. 确认机器人是否被正确@
  4. 检查沙箱环境配置的群聊是否正确
  5. 重新启动机器人(关闭并重新打开命令行窗口)

后续步骤

  1. 探索插件市场发现更多功能
  2. 参考插件开发文档创建自定义插件
  3. 加入社区获取支持:QYbot 社区
  4. 加入我们的 QQ 群进行讨论

Released under the MIT License.