协议提供服务器

[内置]

通过协议提供服务器间接对游戏服务器进行连接, 所有与游戏服务器的交互发生在协议提供服务器.

这意味着在MineChat客户端上只与协议提供服务器建立了连接, 你的所有的尝试与游戏服务器的交互都会交给协议提供服务器处理后转发给游戏服务器. 游戏服务器的消息会由协议提供服务器处理再由协议提供服务器回传给MineChat客户端.

📝 添加服务器

名称	默认值	附加信息
协议提供服务器	默认协议提供服务器	用于当前会话的协议提供服务器
连接账户	默认账户	用于当前会话的账户
显示名称	Minecraft Server	在服务器列表中显示的标题
地址	127.0.0.1	游戏服务器的地址
端口	19132	游戏服务器的端口
会话附加属性	{}	在创建会话时会在请求体中加入该内容, 优先级大于全局会话附加属性

🎲 插件配置页

名称	默认值	附加信息
默认协议提供服务器	127.0.0.1:8873	默认用于会话的协议提供服务器
全局会话附加属性	{}	在创建会话时会在请求体中加入该内容

🔧 开发者资源

所有WS包消息体的结构都是:

{
    type: 'string',
    data: 'any'
}

向插件发送包

name将作为消息体的type发送

obj如果是JsonElement将直接作为data发送

obj如果是String, 将使用JsonParser.parseString()尝试将字符串解析为JsonElement; 如果解析失败将会直接将字符串作为data发送

添加事件监听

添加监听将会向协议提供服务器服务器发送type为on的包, data为name的内容

触发callback时返回的是服务器消息体的data内容 (类型为JsonElement, 可能为null)

开发协议提供服务器

协议提供服务器使用http, 使得可以让协议插件开发不局限于Jvm语言 你可以自行实现以下接口, 实现你自己的协议提供服务器!

你可以参考MineChat官方开发的协议提供服务器:

https://github.com/Cdm2883/minechat-bedrock-protocol-server

基本接口

获取协议提供服务器信息

GET http://<HOST>:<PORT>/info

用于获取当前协议提供服务器信息

200: OK 成功

{
    description: 'string',          // 描述文本
    backend: 'string',              // 后端实现
    online: 'number',               // 在线连接数
    bedrock_protocols: ['number'],  // 支持的基岩版协议列表
    java_protocols: ['number']      // 支持的Java版协议列表
}

获取游戏服务器motd

GET http://<HOST>:<PORT>/motd

当MineChat客户端无法直接获取游戏服务器motd时, 将请求该接口尝试交给协议提供服务器来获取游戏服务器的motd并返回

Query Parameters

Name	Type	Description
host*	String	游戏服务器地址
port*	Number	游戏服务器端口

200: OK 成功

{
    summary: 'string',   // 服务器总结信息
    delay: 'number',     // 服务延迟
    count: 'string',     // 服务人数信息
    icon: 'string|null'  // 服务器base64图标
}

创建会话

POST http://<HOST>:<PORT>/session

只是带上配置尝试创建一个会话, 此时还未与游戏服务器连接

Request Body

Name	Type	Description
host*	String	游戏服务器地址
port*	Number	游戏服务器端口
offline	Boolean	是否是离线账户 (默认false)
username	String	用户名 (离线账户必须)

200: OK 成功

{
    code: 0,
    message: "success",
    data: {
        session_id: 'string'  // 创建会话的UUID
    }
}

Websocket

在创建会话后, 插件将请求ws://<HOST>:<PORT>/session/<SESSION ID>开启WS连接

客户端包

由客户端发出的包

// 注册事件
{
    type: "on",
    data: 'string'  // 事件名称
}

// 请求开启游戏服务器连接
{ type: "connect" }

// 发送消息
{
    type: '"chat"|"say"',
    data: 'string'  // 消息内容
}

// 执行命令
{
    type: '"command"|"cmd"',
    data: 'string'  // 命令内容
}

服务端包

由服务端发出的包

// 正在排队
{ type: "waiting-connection" }

// 正常关闭会话
{
    type: "close",
    data: 'string|null'  // 原因
}

// 输出消息
{
    type: "print",
    data: 'string'  // 内容
}

// 事件回调
{
    type: "event",
    event: 'string',  // 事件名称
    data: 'any'       // 内容
}