-
B 草莓呜咩 从 中的 研刊 移动了该主题
-
KubeJS 模组附属开发指南 (NeoForge 1.21.1)
目录
简介
KubeJS是一个允许玩家使用JavaScript修改Minecraft游戏的模组，为其开发附属模组可以进一步扩展其功能，为JavaScript脚本提供更多的API，让开发者拥有更多的操作可能性，
例如偷走你的钱包。项目结构
一个标准的KubeJS附属模组项目结构如下（1.21.1 NeoForge），导入模组不用多说了吧。。。
你都写KubeJS附属了，还不会搭环境？
依赖的模组为KubeJS和Rhino蠢牛（1.21.1）：src/main/ ├── java/ │ └── com/example/kubejsaddon/ │ ├── YourAddonPlugin.java (主插件类) │ ├── YourAddonEvents.java (自定义事件) │ └── utils/ │ ├── SomeUtils.java (实用工具类) │ └── ...其他Event类 ├── resources/ │ ├── kubejs.plugins.txt (KubeJS插件声明)---最重要！！ │ ├── youraddon.mixins.json (可选的Mixin配置) │ └── META-INF/ │ └── neoforge.mods.toml (模组信息) └── templates/ └── META-INF/ └── neoforge.mods.toml (模板文件)核心组件
主插件类
主插件类是KubeJS附属模组的入口点，需要
implements KubeJSPlugin接口，相较于1.20.1为extend kubeJSPlugin：package com.example.kubejsaddon; import dev.latvian.mods.kubejs.plugin.KubeJSPlugin; import dev.latvian.mods.kubejs.script.BindingRegistry; import dev.latvian.mods.kubejs.event.EventGroupRegistry; public class YourAddonPlugin implements KubeJSPlugin { @Override public void init() { // 初始化代码，会在KubeJS加载时执行 System.out.println("YourAddon Plugin initialized!"); } @Override public void registerEvents(EventGroupRegistry registry) { // 注册自定义事件组 registry.register(YourAddonEvents.GROUP); } @Override public void registerBindings(BindingRegistry bindings) { // 绑定Java类和对象到JS环境 bindings.add("YourUtils", YourUtils.class); // 绑定Minecraft原生类 bindings.add("SomeMinecraftClass", net.minecraft.SomeClass.class); } }事件系统
KubeJS使用事件系统来允许JavaScript脚本响应游戏中的各种事件。要创建自定义事件，需要定义事件组和事件处理器：
package com.example.kubejsaddon; import dev.latvian.mods.kubejs.event.EventGroup; import dev.latvian.mods.kubejs.event.EventHandler; import dev.latvian.mods.kubejs.event.KubeEvent; public interface YourAddonEvents { // 创建事件组 EventGroup GROUP = EventGroup.of("YourAddonEvents"); // 定义启动时事件 EventHandler STARTUP_EVENT = GROUP.startup("customStartup", () -> CustomStartupEvent.class); // 定义服务器事件 EventHandler SERVER_EVENT = GROUP.server("customServer", () -> CustomServerEvent.class); // 定义客户端事件 EventHandler CLIENT_EVENT = GROUP.client("customClient", () -> CustomClientEvent.class); } // 自定义事件类 class CustomStartupEvent implements KubeEvent { private final String message; public CustomStartupEvent(String message) { this.message = message; } public String getMessage() { return message; } }在JavaScript中使用自定义事件：
// 在startup_scripts目录下的JS文件中 YourAddonEvents.customStartup(event => { console.log("Custom startup event received: " + event.message) }) // 在server_scripts目录下的JS文件中 YourAddonEvents.customServer(event => { console.log("Custom server event with data: " + event.data) })触发自定义事件的Java代码：
// 在适当的时机触发事件 YourAddonEvents.STARTUP_EVENT.post(new CustomStartupEvent("Hello from Java!"));工具类编写
为了向JavaScript环境提供有用的功能，通常需要创建各种工具类，丰富自己在开发时有更多的工具选择，而不局限于KubeJS提供的
Utils：package com.example.kubejsaddon.utils; import dev.latvian.mods.kubejs.typings.Info; public class YourUtils { // 使用@Info注解提供JavaScript文档 //使用ProbeJS补全时会显示该方法调用时是用于什么 @Info("一个简单的方法描述") public static String doSomething(String input) { return "Processed: " + input; } @Info("另一个带有参数说明的方法") public static int calculate(int a, int b) { return a + b; } // 静态内部类也可以被暴露给JavaScript public static class InnerHelper { @Info("内部类的方法") public static boolean check(String value) { return value != null && !value.isEmpty(); } } }配置文件
kubejs.plugins.txt
在
src/main/resources/kubejs.plugins.txt文件中声明你的KubeJS插件，这个txt非常重要，这是你KubeJS Plugins能被运行的重要文件之一！如果缺失，KubeJS将无法检测到你的附属Mod：# KubeJS插件声明 # 格式：完整类名 [依赖模组ID] or [client] # 主插件类 com.example.kubejsaddon.YourAddonPlugin # 如果有客户端专用插件 # com.example.kubejsaddon.YourAddonClientPlugin client # 如果依赖其他模组 # com.example.kubejsaddon.IntegrationPlugin some_mod_id编写完后就可以
build为jar，放到生产环境中测试，建议搭配ProbeJS食用你自己编写的第一个KubeJS Plugins，在游戏中使用/probejs dump来检测ProbeJS是否能将你的方法导出为ts文件，并在vscode中补全，编写一些方法来测试你的附属是否有效。如果上述都成功实现了，那么恭喜你成功开发了一个KubeJS附属！
