基于icqq的oneBot实现

Type Docs

使用示例

全局安装

1 安装依赖

npm install -g onebots

2 初始化配置文件

(1) 配置文件存到(用户目录/.onebots/config.yaml)

onebots

(2) 配置文件存到(当前目录/config.yaml)

onebots -c config.yaml

二选一即可

3 更改配置文件后，启动项目

(1) 使用全局配置文件(用户目录/.onebots/config.yaml)

onebots

(2) 使用指定配置文件(当前目录/config.yaml)

onebots -c config.yaml

2 在NodeJS项目中启动

1 初始化node项目

npm init -y

2. 安装onebots

npm install onebots

3. 在项目跟目录添加配置文件config.yaml

port: 6727 # 项目onebots监听的端口(默认：6727)
1472258369: # 你的机器人账户
  version: V11 # oneBot版本（V11 或 V12）

4. 新建入口文件index.js并输入一下内容

const {createApp}=require('onebots')
createApp('config.yaml')
.start()

5. 启动项目

node ./index.js

使用接口管理oneBot

url	method	params	desc
/list	GET		获取当前运行的机器人列表
/detail	GET	uin	获取指定机器人配置
/qrcode	GET	uin	获取指定机器人登录二维码
/add	POST	{uin,...config}	添加机器人 config 为机器人配置
/edit	POST	{uin,...config}	修改机器人配置 config 为机器人配置
/remove	get	uin,force	移除机器人,force为true时，将删除机器人data目录

鸣谢

1. icqqjs/icqq 底层服务支持
2. takayama-lily/onebot oneBot V11 原先版本