@icqqjs/icqq

icqq

QQ（安卓）协议基于 Node.js 的实现，支持最低node版本为 v14
若你不熟悉 Node.js 或不会组织代码，可通过 template或demo 创建一个简单的应用程序
Type Docs（文档仅供参考，具体类型以包内d.ts声明文件为准）
从 OICQ v1.x 升级（v1 在 OICQ 的 master 分支）
如果你仍在使用 OICQ v1.x，又不想升级，可以使用 oicq-icalingua-plus-plus

ICQQ 是 OICQ 的分支。ICQQ 的存在少不了 OICQ 作者 takayama-lily 与 OICQ 的其它贡献者们，在此特别鸣谢！

与oicq2的差异

createClient将不再传递uin，改为在login时传入，如果你希望密码登录，请一定参考密码登录教程
支持频道(基础的消息收发能力)
支持群精华消息的添加和移除
消息类型添加ForwardElem
支持监听指定群/好友的消息

安装:

在你的项目根目录新建文件 .npmrc ,并录入以下内容

@icqqjs:registry=https://npm.pkg.github.com

命令行输入 npm login --scope=@icqqjs --auth-type=legacy --registry=https://npm.pkg.github.com ，回车，根据提示登录github

npm login --scope=@icqqjs --auth-type=legacy --registry=https://npm.pkg.github.com

UserName: # 你的github账号
Password: # 前往 https://github.com/settings/tokens/new  获取，scopes勾选 read:packages 
E-Mail: # 你的公开邮箱地址

安装依赖

npm i @icqqjs/icqq  # or > yarn add @icqqjs/icqq

从旧版升级

npm i icqq@npm:@icqqjs/icqq

快速上手:

const { createClient } = require("@icqqjs/icqq");
const client = createClient({ platform: 3, ver: '2.1.7', sign_api_addr: 'http://127.0.0.1:8080/' });

client.on("system.online", () => console.log("Logged in!"));
client.on("message", e => {
  console.log(e);
  e.reply("hello world", true); //true表示引用对方的消息
});

client.on("system.login.qrcode", (e) => {
    //扫码后按回车登录
    process.stdin.once("data", () => {
      client.login();
    });
  })
client.login();

注意：

扫码登录仅能使用Watch协议登录下进行，如需扫码登陆，请在creatClient时按照上方示例代码传入platform，其他协议暂时无法登陆
建议使用密码登录，只需验证一次设备便长期有效密码登录教程

声明：

本项目为协议实现，不推荐直接使用。
想开发机器人的新用户推荐使用zhin框架开发。
CQHTTP 用户建议使用onebots，该项目同时支持OneBot V11 和OneBot V12。
云崽用户想迁移到icqq，可参考Miao-Yunzai，该分支使用icqq来代替oicq

鸣谢：

oicq icqq原来的仓库
oicq-guild 将其频道的api移植到icqq上
oicq-icalingua-plus-plus 参考了该分支上登录协议相关的pr

其他：

QQWebApi QQ Web Api 收集整理 (途中)
TXHook 抓包工具推荐 参与贡献：
贡献指南

@icqqjs/icqq

icqq

与oicq2的差异

Settings

On This Page