Docs

使用示例

全局安装(0.4.8以后不推荐)

1 安装依赖

npm install -g onebots

2 初始化配置文件

onebots

3 更改生成的默认配置文件成你想要的配置配置后再次运行上面的指令，启动项目

局部安装

1 初始化node项目

npm init -y

2. 安装onebots以及对应适配器的依赖

npm install onebotsnpm install @icqqjs/icqq# 如需使用icqq适配器，请务必安装npm install web-wechat# 如需使用微信适配器，请务必安装npm install qq-official-bot# 如需使用qq官方机器人适配器，请务必安装npm install node-dd-bot# 如需使用钉钉机器人适配器，请务必安装

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

npm login --scope=@icqqjs --auth-type=legacy --registry=https://npm.pkg.github.comUserName:# 你的github账号Password:# 前往 https://github.com/settings/tokens/new  获取，scopes勾选 read:packagesE-Mail:# 你的公开邮箱地址

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

3. 执行如下命令生成配置文件

npx onebots -r icqq#注册icqq适配器并启动onebotsnpx onebots -r wechat#注册微信适配器并启动onebotsnpx onebots -r qq#注册qq官方适配器并启动onebotsnpx onebots -r dingtalk#注册钉钉适配器并启动onebots# 你也可以同时注册多个适配器，多次使用-r即可，例如 npx onebots -r qq -r icqq -r wechat

4. 更改生成的默认配置文件成你想要的配置配置后再次运行上面的指令，启动项目

默认配置文件

port:6727# 监听端口log_level:info# 日志等级platform:5# 机器人客户端协议（1:Android 2:APad 3:Watch 4:IMac 5:IPad）timeout:30#登录超时时间(秒)general:# 通用配置，在单个配置省略时的默认值V11:# oneBotV11的通用配置heartbeat:3# 心跳间隔 (秒)access_token:""# 访问api的tokenpost_timeout:15# 上报超时时间，(秒)secret:""# 上报数据的sha1签名密钥rate_limit_interval:4# ws心跳间隔(秒)post_message_format:string# "string"或"array"reconnect_interval:3# 重连间隔 (秒)use_http:true# 是否使用 httpenable_cors:true# 是否允许跨域filters:{}# 过滤器配置use_ws:true# 是否使用websockethttp_reverse:[]# http上报地址ws_reverse:[]# 反向ws连接地址V12:# oneBotV12的通用配置heartbeat:3# 心跳间隔 (秒)access_token:""# 访问api的tokenrequest_timeout:15# 上报超时时间 (秒)reconnect_interval:3# 重连间隔 (秒)enable_cors:true# 是否允许跨域use_http:true# 是否启用httpuse_ws:true# 是否启用 websocketfilters:{}# 过滤器配置webhook:[]# http 上报地址ws_reverse:[]# 反向ws连接地址protocol:platform:2sign_api_addr:""#你的签名地址password:""# 账号密码，未配置则扫码登陆# ...其他配置项参考icqq的Config配置# 每个账号的单独配置(用于覆盖通用配置)icqq.123456789:password:""# 账号密码，未配置则扫码登陆version:V11# 使用的oneBot版本# ...其他配置项参见上方对应oneBot版本的通用配置protocol:platform:2sign_api_addr:""#你的签名地址# ...其他配置项参考icqq的Config配置qq.123456789:# `${适配器名称}:${appId}`versions:    -version:V11# 。。。其他配置项参见上方对应oneBot版本的通用配置protocol:# 将会覆盖通用配置中的protocoltoken:''# qq机器人tokensecret:''# qq机器人secretsandbox:false# 是否沙箱环境intents:# 需要监听的intents      -'GROUP_AT_MESSAGE_CREATE'# 群聊@事件 没有群聊权限请注释      -'C2C_MESSAGE_CREATE'# 私聊事件 没有私聊权限请注释      -'DIRECT_MESSAGE'# 频道私信事件#     - 'GUILD_MESSAGES' # 私域机器人频道消息事件，公域机器人请注释      -'GUILDS'# 频道变更事件      -'GUILD_MEMBERS'# 频道成员变更事件      -'GUILD_MESSAGE_REACTIONS'# 频道消息表态事件      -'INTERACTION'# 互动事件      -'PUBLIC_GUILD_MESSAGES'# 公域机器人频道消息事件，私域机器人请注释# 。。。其他配置项参见上方对应oneBot版本的通用配置dingtalk.abcedfg:# `${适配器名称}:${clientId}`versions:    -version:V11    -version:V12protocol:clientSecret:''# 钉钉机器人秘钥 必填username:'钉钉机器人'#钉钉后台配置的机器人名称 不填则显示'钉钉机器人'avatar:''# 机器人头像 不填则显示钉钉logowechat.bot1:# `${适配器名称}:${机器人唯一标识}`versions:    -version:V11    -version:V12protocol:{}

配置解释

Config

OneBotConfig

ConfigV11

ConfigV12

事件过滤器

语法说明

示例

1. 仅上报私聊事件

filters:message_type:private

2. 私聊或指定群聊

filters:$or:message_type:privategroup_id:      -123456789 987654321

3. 私聊事件且不是指定用户

filters:message_type:private$not:user_id:      -123456789 987654321

4. 私聊事件(排除指定用户的事件)或指定群聊事件

filters:$or:    -message_type:private$not:user_id:123456789    -message_type:groupgroup_id:987654321

5. 仅上报消息事件且用户年龄大于18岁

filters:type:messagesender:age:$gt:18

6. 仅上报消息事件且消息内容以！开头的消息

filters:type:messageraw_message:.regexp:'^！|\!'

7. 不上报消息内容包含cnm的消息

filters:$not:type:messageraw_message:$like:cnm

使用API管理oneBot

鸣谢