/LLOneBot

LiteloaderQQNT的OneBot API插件

Primary LanguageTypeScriptMIT LicenseMIT

LLOneBot API

LiteLoaderQQNT的OneBot11协议插件

TG群:https://t.me/+nLZEnpne-pQ1OWFl

注意:本文档对应的是 LiteLoader 1.0.0及以上版本,如果你使用的是旧版本请切换到本项目v1分支查看文档

V3之后不再需要LLAPI

安装方法

Linux 容器化快速安装

执行以下任意脚本,按照提示设置NoVnc密码,即可运行,脚本问题与异常参考 llonebot-docker 项目。

curl https://cdn.jsdelivr.net/gh/MliKiowa/llonebot-docker/fastboot.sh -o fastboot.sh & chmod +x fastboot.sh & sudo sh fastboot.sh
wget -O fastboot.sh https://cdn.jsdelivr.net/gh/MliKiowa/llonebot-docker/fastboot.sh & chmod +x fastboot.sh & sudo sh fastboot.sh

通用手动安装方法

1.安装LiteLoaderQQNT

2.安装本项目插件OneBotApi, 注意本插件2.0以下的版本不支持LiteLoader 1.0.0及以上版本

关于插件的安装方法: 下载后解压复制到插件目录

插件目录:LiteLoaderQQNT/plugins

安装后的目录结构如下

├── plugins
│   ├── LLOneBot
│   │   └── main.js
│   │   └── preload.js
│   │   └── renderer.js
│   │   └── manifest.json
│   │   └── node_modules/...

使用termux安装

https://github.com/LLOneBot/llonebot-termux

支持的API

目前支持的协议

  • http调用api
  • http事件上报
  • 正向websocket
  • 反向websocket

主要功能:

  • 发送好友消息
  • 发送群消息
  • 获取好友列表
  • 获取群列表
  • 获取群成员列表
  • 撤回消息
  • 处理添加好友请求
  • 处理加群请求
  • 退群
  • 上报好友消息
  • 上报添加好友请求
  • 上报群消息
  • 上报好友、群消息撤回
  • 上报加群请求
  • 上报群员人数变动(尚不支持识别群员人数变动原因)
  • 设置群管理员
  • 群禁言/全体禁言
  • 群踢人
  • 群改群成员名片
  • 修改群名

消息格式支持:

  • cq码
  • 文字
  • 表情
  • 图片
  • 引用消息
  • @群成员
  • 语音(支持mp3、wav等多种音频格式直接发送)
  • json消息(只上报)
  • 转发消息记录(目前只能发不能收)
  • 视频(上报时暂时只有个空的file)
  • 文件(上报时暂时只有个空的file), type为file, data为{file: uri}, 发送时uri支持http://, file://, base64://
    {
        "type": "file",
        "data": {
            "file": "file:///D:/1.txt"
        }
    }
    
  • 发送音乐卡片
  • 红包(没有计划支持)
  • xml (没有计划支持)

示例

一些坑

下载了插件但是没有看到在NTQQ中生效
检查是否下载的是插件release的版本,如果是源码的话需要自行编译。依然不生效请查阅LiteLoaderQQNT的文档

调用接口报404
目前没有支持全部的onebot规范接口,请检查是否调用了不支持的接口 -

发送不了图片和语音
检查当前操作用户是否有LiteLoaderQQNT/data/LLOneBot的写入权限,如Windows把QQ上安装到C盘有可能会出现无权限导致发送失败

QQ变得很卡
这是你的群特别多导致的,因为启动后会批量获取群成员列表,获取完之后就正常了

支持的onebot v11 api:

  • get_login_info
  • send_msg
  • send_group_msg
  • send_private_msg
  • delete_msg
  • get_group_list
  • get_group_info
  • get_group_member_list
  • get_group_member_info
  • get_friend_list
  • set_friend_add_request
  • get_msg
  • send_like
  • set_group_add_request
  • set_group_leave
  • set_group_kick
  • set_group_ban
  • set_group_whole_ban
  • set_group_kick
  • set_group_admin
  • set_group_card
  • set_group_name
  • get_version_info
  • get_status
  • can_send_image
  • can_send_record
  • get_image
  • get_record

支持的go-cqhtp api:

  • send_private_forward_msg
  • send_group_forward_msg
  • get_stranger_info

TODO

  • 重构摆脱LLAPI,目前调用LLAPI只能在renderer进程调用,需重构成在main进程调用
  • 支持正、反向websocket(感谢@disymayufei的PR)
  • 转发消息记录
  • 好友点赞api
  • 群管理功能,禁言、踢人,改群名片等
  • 视频消息
  • 文件消息
  • 音乐卡片
  • 无头模式

onebot11文档

https://11.onebot.dev/

鸣谢