Skip to content

Kook 适配器

Kook(原开黑啦)适配器已完全实现,支持通过 Kook Bot API 接入 onebots 服务。

状态

已实现并可用

功能特性

  • WebSocket 和 Webhook 两种连接模式
  • 消息收发
    • 频道消息收发
    • 私聊消息收发
    • 支持文本、图片、KMarkdown、卡片等多种消息格式
  • 服务器(公会)管理
    • 获取服务器列表和信息
    • 退出服务器
  • 频道管理
    • 获取频道列表和信息
    • 创建、更新、删除频道
    • 获取频道成员列表
  • 成员管理
    • 获取成员信息
    • 踢出成员
    • 设置成员昵称
  • 角色管理
    • 获取角色列表
    • 创建、更新、删除角色
  • 表情回应
    • 添加/删除表情回应
  • 文件上传
  • 语音频道事件
    • 加入/离开语音频道

安装

在 Web 控制台打开「功能扩展」并选择对应适配器;也可以运行:

bash
onebots ui --data-dir <workspace> --setup

管理服务会将适配器及其必需的对等依赖安装到经过验证的不可变运行代。请勿在 OneBots 运行目录中直接执行包管理器安装命令。

配置

config.yaml 中配置 Kook 账号:

yaml
# Kook 机器人账号配置
kook.zhin:
  # Kook 平台配置
  token: 'your_kook_token'
  mode: 'websocket'  # 或 'webhook',默认为 'websocket'
  verifyToken: 'your_verify_token'  # Webhook 模式需要
  encryptKey: 'your_encrypt_key'  # 可选,消息加密密钥
  
  # OneBot V11 协议配置
  onebot.v11:
    access_token: 'your_v11_token'
  
  # OneBot V12 协议配置
  onebot.v12:
    access_token: 'your_v12_token'
  
  # Satori V1 协议配置
  satori.v1:
    token: 'your_satori_token'
    platform: 'kook'
  
  # Milky V1 协议配置
  milky.v1:
    access_token: 'your_milky_token'

配置项说明

配置项类型必填说明
tokenstringKook 机器人 Token
modestring连接模式:websocket(默认)或 webhook
verifyTokenstringWebhook 验证 Token(Webhook 模式需要)
encryptKeystring消息加密密钥(可选)

获取 Token

  1. 访问 KOOK 开发者平台
  2. 创建应用并添加机器人
  3. 在机器人设置中获取 Token

启动服务

bash
# 启动 onebots 服务,加载 Kook 适配器
onebots ui --data-dir /path/to/onebots-data

使用客户端SDK连接

客户端应连接完整账号协议根,例如 http://localhost:6727/kook/{account_id}/onebot/v12。创建 Client、选择接收模式、接入已有 Host 与调用 API 的统一说明见客户端 SDK 使用指南

相关文档

开发计划

Kook 适配器正在规划中,将基于 Kook 官方 Bot API 开发。

相关链接