Skip to content
Qi-Month edited this page Nov 9, 2026 · 5 revisions

KubeJS 集成

安装 KubeJS 后, 本模组的蒸汽设备可通过脚本注册, 无需修改模组本体.

可注册的五种类型:

  • 锅炉 steam_letters:boiler
  • 太阳能锅炉 steam_letters:solar
  • 固体燃烧室 steam_letters:solid_burner
  • 流体燃烧室 steam_letters:fluid_burner
  • 引擎与飞轮 steam_letters:engine_and_flywheel (一次注册两个方块)

1. 注册第一个方块

在 kubejs/startup_scripts 新建任意文件:

StartupEvents.registry("block", (event) => {
	event.create("mypack:titanium_boiler", "steam_letters:boiler")
		.material("mypack:titanium")
		.production(24)
		.capacity(16000)
})

以下三点需要注意:

  • mypack 为命名空间, 可自定义, 但必须与贴图目录一致
  • 第二个参数为类型 id, 必须写完整 steam_letters:boiler, 省略命名空间不会被识别
  • material 的资源命名空间决定贴图查找位置, 详见第 2 节

保存后重启游戏. 在创造模式搜索 titanium_boiler, 此时方块显示为紫黑格, 表示贴图缺失, 注册本身是成功的.

2. 贴图

KubeJS 只生成 json, png 需自行提供. 锅炉需要两张:

kubejs/assets/mypack/textures/block/steam/boiler/titanium/side.png
kubejs/assets/mypack/textures/block/steam/boiler/titanium/top.png

路径中的 mypack 与 titanium 均来自 material(...), 与方块 id 无关. 修改 material 后, 该路径随之变化.

放置后按 F3 + T 重载资源, 无需重启游戏.

底面使用模组自带贴图, 无需提供. 其余四类所需贴图较多, 完整清单见 API 参考的贴图清单.

3. 数值

  • .production(24): 每 tick 的蒸汽产量, 单位 mB/tick
  • .capacity(16000): 内部罐容量, 单位 mB
  • .maxHeat(100): 仅燃烧室, 最大供热量
  • .temperature(10000): 仅燃烧室, 温度上限, 只影响护目镜显示的数值

未指定的参数使用该设备的默认值, 因此需要默认值时删除对应行即可. 引擎的 strength, speed, consumption 及各自的默认值见 API 参考.

参数为 0 不等同于未指定. 各设备对 0 的处理并不一致: 锅炉的 capacity(0) 使罐容量为 0, 设备无法工作; 燃烧室的 maxHeat(0) 则回退到默认值, temperature(0) 得到温度恒为 0 的燃烧室.

4. 五种类型的区别

  • 锅炉: 需要水与外部热量, 产出蒸汽. 热量由相邻的燃烧室提供
  • 太阳能锅炉: 不需要燃料与燃烧室, 白天自行产热, 产量较低
  • 固体燃烧室: 燃烧物品类燃料, 向上方锅炉供热
  • 流体燃烧室: 燃烧流体类燃料, 作用同上
  • 引擎与飞轮: 消耗蒸汽输出旋转动力. 引擎连接传动, 飞轮储存应力

engine_and_flywheel 的 id 规则: 指定 mypack:titanium 时, 实际注册 mypack:titanium_steam_engine 与 mypack:titanium_steam_flywheel. 引擎上设置的材质与 model 同样应用于飞轮.

脚本引擎的应力值仅由 .strength(...) 决定, 不读取 server.toml 中的应力表 -- 该表依据模组自带方块生成, 不包含脚本设备.

5. 完整示例

以下为两档材质的完整注册示例:

StartupEvents.registry("block", (event) => {
	const Materials = {
		castIron: "kubejs:cast_iron",
		steel: "kubejs:steel"
	}

	// 铸铁
	event.create("kubejs:cast_iron_solar_boiler", "steam_letters:solar")
		.material(Materials.castIron)
		.production(24)
		.capacity(16000)

	event.create("kubejs:cast_iron_boiler", "steam_letters:boiler")
		.material(Materials.castIron)
		.production(24)
		.capacity(16000)

	event.create("kubejs:cast_iron_solid_burner", "steam_letters:solid_burner")
		.material(Materials.castIron)

	event.create("kubejs:cast_iron_fluid_burner", "steam_letters:fluid_burner")
		.material(Materials.castIron)

	// 同时注册 cast_iron_steam_engine 与 cast_iron_steam_flywheel
	event.create("kubejs:cast_iron", "steam_letters:engine_and_flywheel")
		.material(Materials.castIron)
		.strength(32768)
		.speed(32)
		.consumption(24)
		.capacity(16000)

	// 钢, 数值为铸铁的两倍
	event.create("kubejs:steel_solar_boiler", "steam_letters:solar")
		.material(Materials.steel)
		.production(48)
		.capacity(32000)

	event.create("kubejs:steel_boiler", "steam_letters:boiler")
		.material(Materials.steel)
		.production(48)
		.capacity(32000)

	event.create("kubejs:steel_solid_burner", "steam_letters:solid_burner")
		.material(Materials.steel)

	event.create("kubejs:steel_fluid_burner", "steam_letters:fluid_burner")
		.material(Materials.steel)

	event.create("kubejs:steel", "steam_letters:engine_and_flywheel")
		.material(Materials.steel)
		.strength(65536)
		.speed(32)
		.consumption(48)
		.capacity(32000)
})

该示例使用的命名空间为 kubejs:, 因此贴图位于 kubejs/assets/kubejs/textures/block/steam/..., 子目录为 cast_iron 与 steel.

6. 自定义燃料

燃料配方分为两种类型, 写在服务端脚本中:

ServerEvents.recipes((event) => {
	let { steam_letters } = event.getRecipes()

	// 物品或物品标签
	steam_letters.solid_fuel("minecraft:coal", 20 * 10)
	steam_letters.solid_fuel("#minecraft:coals", 20 * 5)

	// 流体或流体标签
	steam_letters.fluid_fuel("minecraft:lava", 20 * 50)
	steam_letters.fluid_fuel("#forge:lava", 20 * 30)
})

第二个参数统一为燃烧时间 time, 而流体固定为 1000mB, 因此配方代表为 [1000mB 流体燃料能够烧多久]

steam_letters: {
	solid_fuel(fuel: InputItem_, time: number, superheated: boolean?): Special.Recipes.SolidFuelSteamLetters
	fluid_fuel(fuel: FuelFluid_, time: number, superheated: boolean?): Special.Recipes.FluidFuelSteamLetters
}

固体燃料: 一个物品燃烧 time tick. 流体燃料: 一份固定 1000 mB, 开始燃烧时一次性扣除, 分摊到 time tick 内消耗, 数值越大燃烧时间越长. 同一物品或流体命中多条配方时, 取 time 最大的一条.

两条返回值的配方均支持链式方法 .superheated(boolean?), 省略参数等价于 true:

steam_letters.solid_fuel("minecraft:blaze_rod", 20 * 20)
	.superheated()

被标记为过热燃料的配方, 点燃后会使燃烧室进入过热状态, 并让上方锅炉改为生产过热蒸汽. 规则见 "蒸汽训练词" 的 "燃烧室与锅炉" 一节.

修改配方无需重启游戏, 按 KubeJS 的重载流程处理.

7. 常见问题

  • 显示为紫黑格: 贴图路径使用的是材质.material()命名空间, 而非方块 id
  • 配置文件中没有这些设备: 脚本设备不写入 toml, 数值由脚本决定

完整方法列表与参数默认值见 KubeJS API 参考. 以 Java 实现设备见 Java 集成.

返回首页

Clone this wiki locally