snowluma: SnowLuma (OneBot 11) Go SDK, drop-in compatible with napcat
This commit is contained in:
23
doc.go
Normal file
23
doc.go
Normal file
@ -0,0 +1,23 @@
|
||||
// Package snowluma 是对接 SnowLuma(OneBot v11 协议)的 Go 软件包。
|
||||
//
|
||||
// 通过 New 创建与 SnowLuma 交互的客户端对象,Set* 方法配置连接方式
|
||||
// (正向/反向 WebSocket、HTTP API、HTTP POST 上报),On* 注册事件处理,
|
||||
// Run 启动后即可直接调用对象上的 150+ 个 SnowLuma 接口。
|
||||
//
|
||||
// bot := snowluma.New().SetToken("xxx").SetForwardWS("ws://127.0.0.1:3001")
|
||||
// bot.OnMessage(func(c *snowluma.Context) {
|
||||
// if c.HasAtMe() {
|
||||
// c.ReplyText("hi")
|
||||
// }
|
||||
// })
|
||||
// bot.Run(ctx)
|
||||
//
|
||||
// 本包与 [gitea.doicat.com/bot/napcat] 的公开 API 保持一致,现有的 napcat
|
||||
// 机器人项目只需把导入路径换成本包并加一个别名即可迁移:
|
||||
//
|
||||
// import napcat "gitea.doicat.com/bot/snowluma"
|
||||
//
|
||||
// 支持 OneBot 11 标准 API、NapCat/go-cqhttp 兼容 API 与 SnowLuma 扩展 API
|
||||
// (闪传、Ark 卡片、群待办、群相册、QQ 空间、系统表情、流式接口等);
|
||||
// 未收录的接口可用 Context.Call / Client.Call 裸调。
|
||||
package snowluma
|
||||
Reference in New Issue
Block a user