ComputerCraft 唤醒节点

ComputerCraft 唤醒节点

一个Forge模组,为CC: Tweaked电脑添加唤醒节点,支持动态区块加载控制,让你可以远程唤醒远处的CC电脑。

管理

ComputerCraft Wake Nodes

ComputerCraft Wake Nodes 是一个适用于 Minecraft 1.20.1 的 Forge 模组,为 CC: Tweaked(ComputerCraft)计算机添加了一个小型区块加载网络,对于自动化装置尤其有用。

它引入了三个 ComputerCraft 外设:

  • wake_node:附加到 ComputerCraft 计算机上,并以字符串 ID 注册,实际上充当区块加载器。
  • wake_node_advanced:wake_node 的升级版,允许用户选择加载区域(1×1、3×3 或 5×5 区块)。
  • wake_controller:由另一台计算机使用,用于列出、加载、卸载和检查已注册的节点。

主要用例是唤醒远处的计算机装置,使其区块加载并运行足够长的时间,以便其启动逻辑得以执行。

它还添加了 Wake Chip,一种供其他方块使用的合成组件。

如果安装了 Create,则会为 Wake Chip、Wake Node、Advanced Wake Node 和 Wake Controller 提供自定义的 Create 配方。

特性

  • 通过将 Wake Node 附加到 ComputerCraft 计算机上来注册远程唤醒点。
  • 从 Wake Controller 按需加载远程计算机的区块。
  • 永久加载区块直至手动卸载,或通过自动超时进行临时加载。
  • 节点注册在服务器重启后仍然保留。
  • 保持区块加载的临时性:已加载的区块在重启后不会自动恢复。
  • 为两种方块提供简单的 ComputerCraft API。

需求

  • Minecraft 1.20.1
  • Forge 47.2.0+
  • Java 17
  • CC: Tweaked 1.108.4+

添加的内容

Wake Chip

供其他方块使用的合成组件。

配方:

Wake chip recipe

创造模式标签页:Ingredients

Wake Node

一种薄型外设方块,必须直接放置在 CC: Tweaked 计算机方块的相邻面。

功能:

  • 暴露 wake_node 外设类型
  • 存储从 Lua 分配的节点 ID
  • 将所附加计算机的维度与区块注册到持久化注册表中
  • 当其支撑的计算机被移除时自动破坏

重要的放置规则:

  • 除非支撑方块是 ComputerCraft 计算机方块,否则拒绝放置

配方:

Wake Node recipe

创造模式标签页:Functional Blocks

Advanced Wake Node

Wake Node 的升级版,允许用户选择所附加计算机周围的加载区域:

  • 1×1 — 1 个区块(与基础 Wake Node 相同)
  • 3×3 — 9 个区块
  • 5×5 — 25 个区块

它继承基础 Wake Node 的所有特性,并新增了 setRange()、getRange() 和 listAvailableRanges() 方法。

配方(形状与 Wake Node 相同,但使用下界合金代替铁):

Advanced Wake Node recipe

创造模式标签页:Functional Blocks

Wake Controller

一种外设方块,由控制器计算机用于管理已注册的唤醒节点。

功能:

  • 暴露 wake_controller 外设类型
  • 列出已注册的节点
  • 加载和卸载节点区块
  • 报告节点当前是否已加载以及临时加载还剩多少时间

配方:

Wake Controller recipe

创造模式标签页:Functional Blocks

工作原理

  1. 将 Wake Node 放置在 CC: Tweaked 计算机的某一面上。
  2. 在该计算机上,对 wake_node 外设调用 setId("some_name") 以注册节点。
    执行此注册的计算机将成为节点所有者。
  3. 通过 grantController(computerId) 授权控制器计算机。
  4. 将 Wake Controller 放置在另一台计算机旁边。
  5. 在已授权的控制器计算机上,调用 loadNode("some_name") 或 loadFor("some_name", seconds)。

被加载的区块是计算机所在的区块,而不是 Wake Node 方块所在的区块。

每个节点都有一个所有者计算机和一个包含已授权控制器计算机 ID 的访问控制列表(ACL)。
控制器方法仅对调用计算机已获授权管理的节点生效。

节点注册会被保存,但活动的强制加载区块不会。服务器重启后,节点仍存在于注册表中,但在再次请求之前,它们都不会保持加载状态。

ComputerCraft API

外设类型

  • Wake Node 外设类型:wake_node
  • Advanced Wake Node 外设类型:wake_node_advanced
  • Wake Controller 外设类型:wake_controller

Wake Node API

使用标准的 ComputerCraft 调用查找外设,例如:

local wake = peripheral.find("wake_node")

请查看 GitHub 上的 API.md 文件 以获取更简洁的 API 文档版本。

setId(id)

以此节点在给定的字符串 ID 下注册。

  • id 必须是非空字符串
  • 首次成功注册时,调用计算机将成为节点所有者
  • 如果同一 ID 已在同一节点上注册,则该调用被接受
  • 如果该 ID 已被其他节点使用,则该调用会引发错误

示例:

local wake = peripheral.find("wake_node")
assert(wake, "wake_node not found")

wake.setId("remote_factory")

grantController(computerId)

授权某个控制器计算机 ID 管理此节点。

  • 只有所有者计算机可以调用此方法
  • computerId 必须是正整数
  • 幂等:重复授予同一 ID 会被接受

revokeController(computerId)

从此节点的允许列表中移除某个控制器计算机 ID。

  • 只有所有者计算机可以调用此方法
  • 幂等:撤销一个不存在的 ID 会被接受

listControllers()

返回已授权控制器计算机 ID 的排序列表。

getPermissions()

返回此节点的所有权与控制列表(ACL):

{
  owner = 17,
  controllers = { 42, 73 }
}

getId()

返回当前节点 ID,如果尚未分配则返回 nil。

示例:

print(wake.getId())

getChunk()

返回描述所附加计算机区块的表:

{
  dimension = "minecraft:overworld",
  chunk_x = 12,
  chunk_z = -4
}

getInfo()

返回包含节点 ID 和区块信息的表:

{
  id = "remote_factory",
  dimension = "minecraft:overworld",
  chunk_x = 12,
  chunk_z = -4
}

如果尚未分配 ID,则 id 返回为空字符串。

Advanced Wake Node API

Advanced Wake Node 暴露 wake_node_advanced 外设类型。它继承基础 Wake Node 的所有方法,并新增以下内容:

local wake = peripheral.find("wake_node_advanced")

setRange(size)

设置计算机周围的加载区域。

  • size 必须为 1、3 或 5
  • 只有节点所有者可以调用此方法
  • 如果节点当前已加载,则区块集会实时更新(除非被配置禁用)
  • 如果范围超过服务器最大值或调用者不是所有者,则会引发错误

示例:

wake.setRange(5) -- load a 5×5 area (25 chunks)

getRange()

返回当前范围大小(1、3 或 5)。

print(wake.getRange()) -- 3

listAvailableRanges()

根据服务器配置返回允许的范围值数组。

local ranges = wake.listAvailableRanges()
-- { 1, 3, 5 }

getInfo()(覆盖)

返回与基础 getInfo() 相同的表,并额外包含两个字段:

{
  id = "remote_factory",
  dimension = "minecraft:overworld",
  chunk_x = 12,
  chunk_z = -4,
  range = 3,
  loaded_chunks = 9
}

Wake Controller API

使用标准的 ComputerCraft 调用查找外设,例如:

local ctl = peripheral.find("wake_controller")

listNodes()

返回调用控制器计算机可访问的已注册节点 ID 列表。

示例:

for _, id in ipairs(ctl.listNodes()) do
  print(id)
end

getNodeInfo(id)

返回可访问节点的节点信息。

如果节点不存在或调用控制器未获授权,则会引发错误。

返回的表:

{
  id = "remote_factory",
  dimension = "minecraft:overworld",
  chunk_x = 12,
  chunk_z = -4,
  loaded = false,
  expires_at = 90
}

注意:

  • loaded 为布尔值
  • expires_at 仅对临时加载存在
  • expires_at 以剩余秒数表示,而非绝对时间戳

loadNode(id)

无限期强制加载节点区块,直至发生以下情况之一:

  • 调用 unloadNode(id)
  • 调用 unloadAll()
  • 服务器停止

如果节点不存在,则会引发错误。

如果调用控制器未获此节点授权,也会引发错误。

loadFor(id, seconds)

在限定秒数内强制加载节点区块。

  • seconds 必须为正数
  • seconds 不得超过配置的 max_load_duration_seconds

如果节点不存在或时长无效,则会引发错误。

如果调用控制器未获此节点授权,也会引发错误。

unloadNode(id)

如果给定节点当前已加载,则卸载它。

unloadAll()

卸载调用控制器可访问的所有当前已加载节点。

isNodeLoaded(id)

如果节点当前已加载则返回 true,否则返回 false。

如果调用控制器未获此节点授权,则会引发错误。

getLoadedNodes()

返回调用控制器可访问的当前已加载节点 ID 列表。

示例设置

远程计算机

将 Wake Node 附加到计算机并注册:

local wake = peripheral.find("wake_node")
assert(wake, "wake_node not found")

wake.setId("remote_factory")
wake.grantController(42) -- controller computer ID
print(textutils.serialize(wake.getInfo()))

控制器计算机

加载远程区块两分钟:

local ctl = peripheral.find("wake_controller")
assert(ctl, "wake_controller not found")

print("Known nodes:")
for _, id in ipairs(ctl.listNodes()) do
  print(" - " .. id)
end

ctl.loadFor("remote_factory", 120)
print(textutils.serialize(ctl.getNodeInfo("remote_factory")))

配置

服务器配置键:

  • chunk_loading.max_loaded_nodes:可同时加载的最大节点数。默认值:16
  • chunk_loading.max_load_duration_seconds:loadFor 接受的最大时长。默认值:300
  • chunk_loading.default_load_radius:目标计算机周围的区块半径。0 表示仅计算机自身的区块。默认值:0
  • chunk_loading.chunk_ops_per_tick:每个服务器 tick 处理的排队加载/卸载操作的最大数量。较低的值可平滑峰值,但唤醒节点更慢。默认值:3

通用配置键:

  • logging.enable_node_logs:为注册、加载、卸载和过期事件启用服务器日志消息。默认值:true

行为说明

  • 注册通过世界级注册表共享。
  • 每个节点都有一个所有者计算机 ID 和一个包含已授权控制器计算机 ID 的 ACL。
  • 控制器方法仅对调用控制器已获授权管理的节点生效。
  • 如果 Wake Node 被破坏,其注册将被移除。
  • 如果支撑的计算机被移除,Wake Node 会自动破坏。
  • 临时区块加载在服务器 tick 时过期并自动清理。
  • 服务器停止时,所有活动的区块票据都会被释放。

示例脚本

仓库中包含示例 Lua 脚本,位于 sampleScripts/recallCreateTrains/,演示了 Wake Nodes 如何唤醒远程 Create 车站计算机并通过 Rednet 协调列车召回流程。

许可证

代码以 MIT 许可证授权。

部分捆绑资源(纹理)以 ComputerCraft Public License v1.0.0(CCPL)授权。

详情请参阅 GitHub 上的 LICENSE 和 LICENSE-CCPL 文件。