openclaw-kook-plugin
v0.1.0
Published
OpenClaw Kook (开黑啦) channel plugin - Kook 即时通讯平台的 OpenClaw 频道插件
Maintainers
Readme
OpenClaw Kook 插件
OpenClaw 的 Kook 频道插件,支持 Kook 即时通讯平台的机器人集成。
📋 项目状态
总体完成度:95% ✅
Kook 插件的主体框架已经基本完成,具备了 OpenClaw 频道插件的完整架构。
✨ 特性
- ✅ WebSocket Gateway 实时连接
- ✅ 支持文字、图片、文件消息
- ✅ KMarkdown 富文本格式
- ✅ 消息反应功能
- ✅ 服务器/频道管理
- ✅ 完整的权限管理
- ✅ 配对机制
- ✅ 原生命令支持
- ✅ 配置系统
- ✅ 状态系统
- ✅ 安全模块
- ✅ 目录集成
- ✅ 账户探测
- ✅ 权限审计
🚀 快速开始
安装
# 克隆仓库
git clone https://gitee.com/sunmou_bit/openclaw-kook-plugin.git
cd openclaw-kook-plugin
# 安装依赖
npm install配置
在 OpenClaw 配置文件中添加:
channels:
kook:
enabled: true
token: "你的Kook Bot Token"使用
- 在 Kook 开发者平台创建 Bot
- 获取 Bot Token
- 在 OpenClaw 配置中填入 Token
- 重启 OpenClaw
📁 项目结构
openclaw-kook-plugin/
├── src/ # 源代码
│ ├── index.ts # 插件入口
│ ├── channel.ts # 频道插件实现
│ ├── runtime.ts # 运行时管理
│ ├── gateway.ts # Gateway 管理
│ ├── api.ts # HTTP API 封装
│ ├── send.ts # 消息发送
│ ├── monitor.ts # 监控循环
│ ├── listeners.ts # 事件监听器
│ ├── probe.ts # 账户探测
│ ├── audit.ts # 权限审计
│ ├── accounts.ts # 账户管理
│ ├── status.ts # 状态收集
│ ├── targets.ts # 目标解析
│ ├── directory.ts # 目录集成
│ ├── security.ts # 安全模块
│ ├── message-handler.ts # 消息处理器
│ └── actions.ts # 消息动作适配器
├── docs/ # 文档
│ ├── 开发指南.md # 开发指南
│ └── 项目总结.md # 项目总结
├── tests/ # 测试(待创建)
├── scripts/ # 脚本(待创建)
├── README.md # 项目说明
├── package.json # 项目配置
├── tsconfig.json # TypeScript 配置
└── openclaw.plugin.json # 插件配置🛠️ 开发
# 开发模式
npm run dev
# 构建
npm run build
# 测试
npm run test
# 代码检查
npm run lint
# 代码格式化
npm run format📚 技术栈
- 语言: TypeScript
- 运行时: Node.js >= 18.0.0
- WebSocket: ws
- 构建工具: TypeScript Compiler
🎯 架构说明
核心模块
| 模块 | 说明 | 状态 |
|------|------|------|
| index.ts | 插件入口 | ✅ |
| channel.ts | 频道插件实现 | ✅ |
| runtime.ts | 运行时管理 | ✅ |
| gateway.ts | WebSocket Gateway 管理 | ✅ |
| api.ts | HTTP API 封装 | ✅ |
| send.ts | 消息发送 | ✅ |
| monitor.ts | 监控循环 | ✅ |
| listeners.ts | 事件监听器 | ✅ |
| probe.ts | 账户探测 | ✅ |
| audit.ts | 权限审计 | ✅ |
| accounts.ts | 账户管理 | ✅ |
| status.ts | 状态收集 | ✅ |
| targets.ts | 目标解析 | ✅ |
| directory.ts | 目录集成 | ✅ |
| security.ts | 安全模块 | ✅ |
| message-handler.ts | 消息处理器 | ✅ |
| actions.ts | 消息动作适配器 | ✅ |
开发阶段
- Phase 1: 基础框架 ✅
- Phase 2: 消息功能 ✅
- Phase 3: 完整功能集成 ✅
- 最终完善: 测试和文档完善 📝
📖 文档
🤝 贡献
欢迎贡献!请查看 CONTRIBUTING.md(待创建)了解详情。
📄 许可证
MIT License
👤 作者
孙教授
🙏 致谢
- OpenClaw 团队
- Discord 插件实现(作为参考)
- Kook 开发者社区
仓库地址: https://gitee.com/sunmou_bit/openclaw-kook-plugin
