Skip to content

Latest commit

 

History

History
255 lines (204 loc) · 15.9 KB

README.md

File metadata and controls

255 lines (204 loc) · 15.9 KB

ws-plugin

圣经

不使用,那开发的用处何在?不提交bug,那 issue的意义在哪里?解决问题是开发者应有的义务,有问题,那就要去解决完善,你的话我甚至觉得你没参与过开发,你如何论证我发视频是错误的?请问你有什么办法解决目前的协议问题?B站不引人注目,那请问QQ群是谁的地盘?我做视频为了引导开发者解决问题,请问你做了什么?如果你真想为bot做贡献,应该去提交is和pr,而不是在这里当鸵鸟以为不用就没人管了,我希望你作为一个开发者面对问题应该去解决它而不是把头埋进沙子假装看不见它,你不让我们用bot的居心何在?

介绍

Yunzai-Bot 的扩展插件 ws-plugin 提供ontbot协议适配,通过WebSocket连接onebot实现的bot

什么是onebot

OneBot 是一个聊天机器人应用接口标准,旨在统一不同聊天平台上的机器人应用开发接口,使开发者只需编写一次业务逻辑代码即可应用到多种机器人平台。

可以用ws-plugin实现什么功能

支持的Yunzai-bot版本

Miao-Yunzai && Yunzai-Bot (即将停止对原版云崽的支持)

作为客户端:

  • onebot v11
    • 反向 WebSocket
    • 正向 WebSocket
    • 正向http
    • 反向http
  • gsuid_core

作为客户端:

  • onebot v11 (已适配所有协议,如果对应协议的user_id和group_id为string则会转换成number,从1开始自增)
    • 反向 WebSocket
    • 正向 WebSocket
    • 正向http
    • 反向http
  • gsuid_core

安装与更新

使用Git安装(推荐)

请将 ws-plugin 放置在 Yunzai-Bot 的 plugins 目录下,重启 Yunzai-Bot 后即可使用。

请使用 git 进行安装,以方便后续升级。在 Yunzai-Bot 根目录夹打开终端,运行下述指令之一

#gitee
git clone --depth=1 https://gitee.com/xiaoye12123/ws-plugin.git ./plugins/ws-plugin/
pnpm install --filter=ws-plugin
#github
git clone --depth=1 https://github.com/XasYer/ws-plugin.git ./plugins/ws-plugin/
pnpm install --filter=ws-plugin

进行安装。安装完毕后,管理员只需发送 #ws更新 即可自动更新 ws-plugin。

使用说明

功能列表 | 只支持主人使用
指令 说明
#ws帮助 召唤出ws插件的帮助图
#ws设置 进行ws插件相关设置
#ws添加连接 添加一个新的连接
#ws删除连接 删除一个已有的连接
#ws关闭连接 暂时关闭某个连接
#ws打开连接 打开关闭的连接
#ws查看连接 查看当前已有连接和状态
#ws重新连接 断开已有连接并重新连接
#ws连接说明 查看添加连接参数的说明

onebot实现

已实现 CQ 码
CQ 码 功能
[CQ:face] QQ表情
[CQ:image] 图片
[CQ:record] 语音
[CQ:at] @某人
[CQ:poke] 戳一戳
[CQ:music] 音乐分享
[CQ:music] 音乐自定义分享
[CQ:reply] 回复
[CQ:node] 合并转发自定义节点
[CQ:json] JSON消息
已实现 API

可能符合 OneBot 标准的 API

API 功能
send_private_msg 发送私聊消息
send_group_msg 发送群聊消息
send_msg 发送消息
delete_msg 撤回消息
set_group_kick 群组踢人
set_group_ban 群组单人禁言
set_group_anonymous_ban 群组匿名禁言
set_group_whole_ban 群组全员禁言
set_group_admin 群组设置管理员
set_group_card 设置群名片(群备注)
set_group_name 设置群名
set_group_leave 退出群组
set_group_special_title 设置群组专属头衔
set_friend_add_request 处理加好友请求
set_group_add_request 处理加群请求/邀请
get_login_info 获取登录号信息
get_stranger_info 获取陌生人信息
get_friend_list 获取好友列表
get_group_info 获取群信息
get_group_list 获取群列表
get_group_member_info 获取群成员信息
get_group_member_list 获取群成员列表
get_version_info 获取版本信息

从 go-cqhttp cv 过来的api

拓展 API 功能
set_group_portrait 设置群头像
get_msg 获取消息
get_forward_msg 获取合并转发内容
send_private_forward_msg 发送合并转发(私聊)
send_group_forward_msg 发送合并转发(群聊)
get_group_system_msg 获取群系统消息
get_group_root_files 获取群根目录文件列表
get_group_files_by_folder 获取群子目录文件列表
get_group_file_url 获取群文件资源链接
get_status 获取状态
已实现 Event
事件类型 Event
通知事件 群管理员变动
通知事件 群成员减少
通知事件 群成员增加
通知事件 群禁言
通知事件 好友添加
通知事件 群消息撤回
通知事件 好友消息撤回
通知事件 群内戳一戳
请求事件 加好友请求
请求事件 加群请求/邀请

TODO

  1. 更详细的帮助和设置
  2. 支持更多onebot api
  3. 支持onebot v12

鸣谢

免责声明

  1. 功能仅限内部交流与小范围使用,请勿将Yunzai-Bot及ws-plugin用于以盈利为目的的场景
  2. 图片与其他素材均来自于网络,仅供交流学习使用,如有侵权请联系,会立即删除

其他

如果觉得此插件对你有帮助的话,可以点一个star,你的支持就是不断更新的动力~

访问量

访问量