
Webstone
使用WebSockets远程控制你的红石装置。
Webstone
使用 WebSocket 远程控制你的红石装置。
背景
本模组受 Fundy 的 YouTube 视频 启发,该视频简要展示了一个可通过浏览器控制的自定义红石方块。视频中的这一部分从未作为独立模组发布,因此 Webstone 应运而生。
使用
本模组会在 4321 端口上开启一个 WebSocket 服务器,让你可以用任意 WebSocket 客户端(例如 这个 —— 或位于 http://webstone.festival.tf 的托管客户端)连接,以切换已注册方块的状态或修改其输出信号强度。
你可以在创造模式的“红石方块”标签页中找到 Webstone 远程方块(暂无生存模式合成配方)。要注册它,请空手右键点击(如果成功,你会在快捷栏上方看到一条消息)。要在本地切换它,请潜行时右键点击该方块。
合成配方
从 Webstone 1.0.1 开始,Webstone 远程方块可以在创造模式之外合成:

配置选项
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 // Can be either true or false
}
}
设置方块的输出信号强度:
{
"type": "block_power",
"data": {
"blockId": "00000000-0000-0000-0000-000000000000",
"power": 7 // Can be anything between 0 and 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 证书的 Secure WebSocket 支持。
通行短语
为了保护你的服务器免受未授权访问,你可以添加一个可选通行短语,客户端在连接 WebSocket 服务器之前需要提交该短语。此通行短语需要使用 Bcrypt 进行哈希处理,因此你不必以明文形式存储通行短语。
要生成 Bcrypt 哈希,你可以在基于 Debian 的系统上使用 mkpasswd(可在 whois 包中找到):
$ mkpasswd -m bcrypt <your password>
$2b$05$aHZ8W4AL3o.GnXN5ocSWXumD0Qlu0fU5jLGseYdLzbDW5N1d21Poa
然后,需要将结果使用 Passphrase 键添加到配置中。
如 API 参考中所述,连接 WebSocket 服务器时,客户端需要将 Sec-WebSocket-Protocol 头部设置为十六进制编码的通行短语,这样连接才不会被拒绝。
使用 TLS 的 Secure WebSocket
默认情况下,WebSocket 服务器与客户端之间的流量是不加密的。要加密流量,你需要一个域名以及该域名专用的 SSL 证书,包括私钥和公钥。两个密钥都需要分别以 cert.pem(公钥)和 key.pem(私钥)的形式存储在 .minecraft/data 中。如果私钥需要自己的通行短语,你可以在配置中设置 CertificateKeyPass 键。
要启用或禁用 Secure WebSocket,请将 SecureWebSocket 键设置为 true 或 false。
支持
目前仅支持 Forge。欢迎将其移植到你喜欢的任何其他模组加载器,只要明确说明本项目为原始项目即可。
本模组已在 Minecraft 1.20.1 上测试,但也应该可以在较新版本上运行。在较旧版本的 Minecraft 上可能可以运行,也可能无法运行。
致谢
Fundy - 原始创意、纹理(大概)
Kaupenjoe - 创建了使本模组得以实现的教程系列
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。