Webstone

模组

· 作者 SniperGER

使用 WebSocket 远程控制你的红石装置。

0 本站下载 0 关注 更新于 2 年前

最新 1.20.1-1.0.2 · 1.20.6 · Forge

一键开服(送7天)

Webstone



使用 WebSocket 远程控制你的红石装置。

背景

本模组受 Fundy 的一个 YouTube 视频启发,他在视频中简要展示了一个可以通过浏览器控制的自定义红石块。该视频部分从未作为独立模组发布,因此 Webstone 应运而生。

用法

该模组会在端口 4321 上启动一个 WebSocket 服务器,允许你通过任何 WebSocket 客户端(如 此客户端 - 或托管在 的客户端)连接,以切换已注册方块的状态或更改其输出信号强度。
你可以在创造模式的“红石块”标签页中找到 Webstone Remote Block(生存模式暂无合成配方)。要注册它,请空手右键点击该方块(如果成功,你会在快捷栏上方看到一条消息)。要本地切换它,请在潜行状态下右键点击该方块。

合成配方

从 Webstone 1.0.1 开始,Webstone Remote Block 可以在非创造模式下合成:

crafting-webstone-remote-block

配置选项

Webstone 拥有自己的配置文件,位于 .minecraft/config/webstone-config.toml。你可以设置以下选项:

键 默认值 描述
Passphrase "" 用于仅允许授权用户连接的密码短语。
WebSocketPort 4321 Webstone WebSocket 服务器使用的端口。
SecureWebSocket false 指定 WebSocket 是否应使用安全连接。
CertificateFilename cert.pem .minecraft/data 内证书公钥文件的文件名。
CertificateKeyFilename key.pem .minecraft/data 内证书私钥文件的文件名。
CertificateKeyPass "" 用于私钥的密码短语。

API 参考

服务器 → 客户端

如果 WebSocket 服务器需要密码短语才能连接,客户端需要在 Sec-WebSocket-Protocol 头中以十六进制字符串形式提供该密码短语。使用 JavaScript,你可以在创建 WebSocket 实例时,在连接 URL 之后将其作为第二个参数添加到数组中:

const socket = new WebSocket('ws://<IP address or FQDN>:4321', ['<your passphrase>']);

当连接到 WebSocket 服务器时,连接的客户端会收到当前已注册方块的列表(包括其显示名称、当前通电状态、输出信号强度和分配的组 ID(如果有)),以及方块组。

{
    "type": "block_list",
    "data": [
        {
            "blockId": "00000000-0000-0000-0000-000000000000",
            "name": "Example",
            "power": 15,
            "powered": false,
            "groupId": "00000000-0000-0000-0000-000000000000"
        },
        // ...
    ]
}
{
    "type": "block_groups",
    "data": [
        {
            "groupId": "00000000-0000-0000-0000-000000000000",
            "name": "Example Group",
            "blockIds": [
                //...
            ]
        },
        // ...
    ]
}

如果任何方块或组发生更新,其数据将广播给所有连接的客户端。

{
    "type": "block_updated",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000",
        "name": "Example",
        "power": 15,
        "powered": false,
        "groupId": "00000000-0000-0000-0000-000000000000"
    }
}
{
    "type": "group_updated",
    "data": 
        "groupId": "00000000-0000-0000-0000-000000000000",
        "name": "Example Group",
        "blockIds": [
            //...
        ]
    }
}
客户端 → 服务器

方块管理

设置方块的通电状态:

{
    "type": "block_state",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000",
        "powered": false // 可以是 true 或 false
    }
}

设置方块的输出信号强度:

{
    "type": "block_power",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000",
        "power": 7 // 可以是 0 到 15 之间的任意值
    }
}

设置方块的显示名称:

{
    "type": "rename_block",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000",
        "name": "My Example Block"
    }
}

从 Web UI 中删除方块:

{
    "type": "unregister_block",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000"
    }
}

将方块添加或移除出组:

{
    "type": "change_group",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000",
        "groupId": "00000000-0000-0000-0000-000000000000"
    }
}

将方块在组中移动到其他位置:

这仅对已分配到组的方块产生影响。

{
    "type": "move_block",
    "data": {
        "blockId": "00000000-0000-0000-0000-000000000000",
        "newIndex": "2"
    }
}

分组管理

创建新分组:

{
    "type": "create_group",
    "data": {
        "name": "My awesome group"
    }
}

重命名分组:

{
    "type": "create_group",
    "data": {
        "groupId": "00000000-0000-0000-0000-000000000000",
        "name": "My awesome (renamed) group"
    }
}

删除分组:

{
    "type": "delete_group",
    "data": {
        "groupId": "00000000-0000-0000-0000-000000000000"
    }
}

将分组移动到所有分组列表中的新位置:

{
    "type": "move_group",
    "data": {
        "groupId": "00000000-0000-0000-0000-000000000000",
        "newIndex": 2
    }
}

安全性

在 Webstone 1.0.2 中,添加了两个安全选项:连接 WebSocket 服务器所需的可选密码短语,以及使用 SSL 证书支持安全 WebSocket(Secure WebSocket)。

密码短语

为了保护你的服务器免受未授权访问,你可以添加一个可选的密码短语,客户端在连接到 WebSocket 服务器之前需要提交该密码短语。此密码短语需要使用 Bcrypt 进行哈希处理,这样你就不需要以明文形式存储密码短语。

要在基于 Debian 的系统上生成 Bcrypt 哈希值,可以使用 mkpasswd(位于 whois 包中):

$ mkpasswd -m bcrypt <your password>
$2b$05$aHZ8W4AL3o.GnXN5ocSWXumD0Qlu0fU5jLGseYdLzbDW5N1d21Poa

然后将结果添加到配置中的 Passphrase 键。

如 API 参考所述,连接到 WebSocket 服务器时,需要在客户端设置 Sec-WebSocket-Protocol 头部为十六进制编码的密码短语,否则连接将被拒绝。

使用 TLS 的安全 WebSocket

默认情况下,WebSocket 服务器与客户端之间的流量是未加密的。要加密流量,你需要一个域名以及专门针对该域名的 SSL 证书,包括私钥和公钥。这两个密钥需要分别存储在 .minecraft/data 目录下,命名为 cert.pem(公钥)和 key.pem(私钥)。如果私钥有单独的密码短语,你可以在配置中设置 CertificateKeyPass 键。

要启用或禁用安全 WebSocket,请将 SecureWebSocket 键设置为 true 或 false。

支持

目前仅支持 Forge。欢迎将其移植到你喜欢的任何其他加载器,只要明确声明本项目为原始项目即可。

该模组已在 Minecraft 1.20.1 上测试过,但也应该能在更高版本中运行。它可能兼容也可能不兼容旧版本的 Minecraft。

鸣谢

Fundy - 原始创意、纹理(大概)
Kaupenjoe - 制作了一套教程系列,使这个模组的诞生成为可能

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源