Kritor

本项目目前处于开发阶段, 所定义 api 可能会有较大变动

Kritor是一个聊天机器人应用接口标准. 旨在统一腾讯QQ IM平台上的机器人应用开发接口. 使开发者只需编写一次业务逻辑代码即可应用到多种机器人平台. 在QQNT中, 协议出现大范围变动, OneBot 的原有定义已经不再适用或过于复杂, 因此我们制定了一套新的定义来满足现在的需要.

Kritor使用grpc作为通信协议, 并提供了一套标准的接口定义, 开发者可以使用任何支持grpc的语言进行开发.

特性

• 多语言：支持多种编程语言, 包括Nodejs、Kotlin、C#等
• 标准化：提供一套标准的接口定义(提供全套proto文件), 使开发者只需编写一次业务逻辑代码即可应用到多种机器人平台
• 稳定性：使用高质量, 低延迟的通信协议, 保证稳定性和性能

项目结构

• docs: 文档
• protos: 接口定义

注解字段解释

extend google.protobuf.MethodOptions {
  bool require = 1; // 需要强制实现的服务
  string desc = 2; // 服务描述
}

使用说明

主动RPC

协议端作为 Server, 插件端作为 Client. 插件端可以通过构造 Stub 对象来直接对协议端进行请求操作.

被动RPC

协议端作为 Client, 插件端作为 Server. 因为 Grpc 并没有服务端直接调用客户端的方法, 所以Kritor通过双向流来实现插件端对协议端的调用.

各语言插件示例

• Kotlin
• TypeScript
• Go
• C#

接入状态

• Shamrock: v1.1.0+
• Lagrange.Core: 0.0.3+
  • Lagrange.Kritor: 一个Kritor在 C# 的实现.