node-cq-websocket

A Node SDK for developing QQ chatbots based on WebSocket, which is depending on CoolQ and CQHTTP API plugin.

View project on GitHub

快速開始

創建機器人實例

一個機器人的實例象徵一組對 CQHTTP API 的連線,其中包含了兩個 socket (/event/api)、所有來自 CQHTTP API 的消息上報、對 CQHTTP API 的 API 調用。

首先我們需要先創建機器人的實例,代碼如下:

const { CQWebSocket } = require('cq-websocket')
const bot = new CQWebSocket()

bot 便是機器人的實例,這邊我們完全採用默認值進行連線。

設定 ws 伺服器位址時, 你可以從以下方式擇一配置。

  1. 使用 baseUrl 項指定伺服器 URL。
  2. 使用 protocol, host, port (皆為可選) 指定目標伺服器。

延伸閱讀

對接 CQHTTP API

可以前往以下文件了解如何與 CQHTTP API 進行連接。

閱讀更多 ➡️

認識 CQWebSocket SDK

這邊會提及一些 SDK 默認的行為,消息收發的模式。

閱讀更多 ➡️

錯誤處理

閱讀更多 ➡️