modulepackage
0.0.0-20241114044244-86e0bad4287c
Repository: https://github.com/cutereimu/onebot.git
Documentation: pkg.go.dev
# README
OneBot的Go SDK
这是针对onebot-11编写的Go SDK。
OneBot是一个通用聊天机器人应用接口标准。
开始
请多参阅onebot-11的文档。
[!IMPORTANT] 本项目是基于onebot的正向ws接口,因此你需要开启对应机器人项目的ws监听。
本项目处理消息的格式是消息段数组,因此你需要将onobot中的
event.message_format
配置为array
。
引入项目:
go get -u github.com/CuteReimu/onebot
关于如何使用,可以参考examples
文件夹下的例子
进度
目前已支持的功能有:
- 消息链
- 所有消息类型
- 所有消息解析
- 事件
- 消息事件,包括私聊消息、群消息等
- 通知事件,包括群成员变动、好友变动等
- 请求事件,包括加群请求、加好友请求等
- 元事件,包括 OneBot 生命周期、心跳等
- 请求
- 发送、撤回消息
- 获取消息
- 发送好友赞
- 群管理
- 设置群名片
- 退出群
- 处理好友、加群请求
- 获取账号信息
- 获取群信息
- 获取群成员信息
- 获取群荣誉信息
- 获取QQ相关信息
- 图片语音相关
- 获取OneBot相关信息
- 其它
- 连接与认证
- 请求限流
- 快速操作
# Packages
No description provided by the author
# Functions
Connect 连接onebot
concurrentEvent 参数如果是true,表示采用并发方式处理事件和消息,由调用者自行解决并发问题。 如果是false表示用单线程处理事件和消息,调用者无需关心并发问题。.
# Constants
推荐群.
推荐好友.
成员被踢.
机器人被踢.
主动退群.
管理员已同意入群.
管理员已邀请入群.
匿名消息.
正常消息.
系统提示.
加群请求.
邀请入群.
群消息.
私聊消息.
好友私聊.
群私聊.
其它.
管理员.
群成员.
群主.
女.
男.
未知.
WsChannelAll 在一条连接上同时提供 api 和 event 的服务.
WsChannelApi 连接此接口后,向 OneBot 发送如下结构的 JSON 对象,即可调用相应的 API.
WsChannelEvent 连接此接口后,OneBot 会在收到事件后推送至客户端.
# Structs
Anonymous 匿名发消息.
No description provided by the author
At @某人.
No description provided by the author
Contact 推荐好友、推荐群.
Dice 掷骰子魔法表情.
Face QQ表情.
Forward 合并转发.
Friend 好友.
FriendRequest 加好友请求.
Group 群.
GroupDecreaseNotice 群成员减少.
GroupIncreaseNotice 群成员增加.
No description provided by the author
No description provided by the author
GroupMessage 群消息.
GroupRequest 加群请求/邀请.
Image 图片.
No description provided by the author
Location 位置.
Member 群成员.
Music 音乐分享.
Node 合并转发节点.
Poke 戳一戳,字段含义参考文档
https://github.com/botuniverse/onebot-11/blob/master/message/segment.md#%E6%88%B3%E4%B8%80%E6%88%B3.
PrivateMessage 私聊消息.
Profile 用户资料.
Record 语音.
Reply 回复.
RPS 猜拳魔法表情.
Shake 窗口抖动.
Share 链接分享.
Text 纯文本.
Video 短视频.
No description provided by the author
# Interfaces
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WsChannel 连接通道.