oicq
Version:
QQ protocol!
73 lines (54 loc) • 2.95 kB
Markdown
# oicq
[](https://www.npmjs.com/package/oicq)
[](https://nodejs.org)
[](https://discord.gg/gKnU7BARzv)
* QQ(安卓)协议基于Node.js的实现。也参考了一些其他开源仓库如[mirai](https://github.com/mamoe/mirai)、[miraiGo](https://github.com/Mrs4s/MiraiGo)等。
* 使用 酷Q/CQHTTP 风格的API，原生支持经典CQ码。
* 实现了大部分常用协议和功能，但不会支持金钱/红包相关协议。
* 请使用 `Node.js 12.16` 以上版本。
----
**Install:**
```bash
> npm init # or > yarn init
> npm i oicq # or > yarn add oicq
```
**Usage:**
```js
const { createClient } = require("oicq");
const uin = 123456789; // your account
const client = createClient(uin);
//监听上线事件
client.on("system.online", () => console.log("Logged in!"));
//监听消息并回复
client.on("message", (data) => data.reply("hello world"));
//监听滑动验证码事件并输入ticket
client.on("system.login.slider", function () {
process.stdin.once("data", (input) => {
this.sliderLogin(input);
});
});
client.login("password"); // your password or password_md5
```
**常用功能一瞥：**
```js
client.sendGroupMsg(gid, "hello") //群聊
client.sendPrivateMsg(uid, "hello") //私聊
client.deleteMsg(id) //撤回
client.setGroupKick(gid, uid) //踢人
client.setGroupBan(gid, uid, 3600) //禁言
```
> 更详细的例子：[demo.js](docs/demo.js)
> 更多API：[index.d.ts](https://github.com/takayama-lily/oicq/blob/b600469337bf9ecd5a871413661d56c6325afce3/index.d.ts#L655)
> 基于此库的插件式机器人框架；[abot](https://github.com/takayama-lily/abot)
**相关文档：**
[滑动验证码ticket教程](https://github.com/takayama-lily/oicq/wiki/01.%E6%BB%91%E5%8A%A8%E9%AA%8C%E8%AF%81%E7%A0%81%E5%92%8C%E8%AE%BE%E5%A4%87%E9%94%81)
[API参考文档](https://github.com/takayama-lily/oicq/wiki/91.API%E6%96%87%E6%A1%A3)
[事件参考文档](https://github.com/takayama-lily/oicq/wiki/92.%E4%BA%8B%E4%BB%B6%E6%96%87%E6%A1%A3)
[常见问题](https://github.com/takayama-lily/oicq/wiki/02.%E5%85%B6%E4%BB%96%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
[关于封号和风控](https://github.com/takayama-lily/oicq/wiki/98.%E5%85%B3%E4%BA%8E%E8%B4%A6%E5%8F%B7%E5%86%BB%E7%BB%93%E5%92%8C%E9%A3%8E%E6%8E%A7)
[wiki列表](https://github.com/takayama-lily/oicq/wiki)
**其他：**
[JavaScript语言基础](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript)
[Node.js入门教程](http://nodejs.cn/learn)
[5分钟上手TypeScript](https://www.tslang.cn/docs/handbook/typescript-in-5-minutes.html)
[](https://qm.qq.com/cgi-bin/qm/qr?k=NXw3NEA5lzPjkRhyEpjVBqMpdg1WHRKJ&jump_from=webapi)