Pane

模组

· 作者 EthRocky

一个适用于 Fabric 和 NeoForge 的 GUI 库:在运行中的游戏上叠加工具窗口、模态屏幕、21 种小部件、双向数据绑定以及类 CSS 主题,完全通过 Minecraft 自身的渲染管线实现。无需原生代码,无冲突。

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

最新 0.4.0+mc26.2 · 26.2 · NeoForge

一键开服(送7天)

Pane

Pane 是适用于 Fabric 和 NeoForge 的 GUI 库。我开发它是因为我的光影编辑器需要合适的工具窗口,而现有的方案要么依赖原生库,要么与其他已安装的 UI 模组冲突。Pane 通过 Minecraft 自身的 DrawContext 绘制所有内容,因此不存在任何冲突问题。它能在包含 150 个模组的整合包中与 Axiom、Flashback、Sodium 和 Iris 一起稳定运行。

功能介绍

有两种方式将 UI 显示在屏幕上。

覆盖窗口(Overlay windows) 在游戏运行时悬浮于其上。它们可以通过标题栏拖拽,从任意边缘调整大小,当内容超出范围时支持滚动。按下快捷键(默认为 P)释放鼠标,点击世界即可回到游戏。这是专为编辑器类工具设计的模式。

屏幕(Screens) 是由相同组件构建的正常模态菜单,托管在原版 Screen 中,因此它们的打开、关闭和暂停行为与游戏中的其他菜单完全一致。

组件

按钮、复选框、滑块、下拉菜单、支持复制粘贴的文本输入框、可通过拖拽微调的数字输入框、颜色选择器、进度条、选项卡、滚动容器、表格、支持多选和拖拽排序的列表视图、按键捕获、右键上下文菜单、确认对话框和提示框。共计 21 种组件,创建方式统一:

Window win = Window.of("My Tool").at(40, 40);
win.add(Label.of("Target"));
win.add(TextInput.of(name));
win.add(Slider.of(speed, 0f, 2f));
win.add(Button.of("Apply").onClick(() -> apply()));
PaneOverlay.addWindow(win);

数据绑定

组件绑定到 State<T> 对象。组件写入状态,你的代码读取状态,而从代码中设置状态则会更新组件。将一个状态绑定到滑块和数字输入框,它们会自动保持同步:

State<Float> radius = State.of(16f);
Slider.of(radius, 0f, 256f);
NumberField.of(radius, 0f, 256f);
radius.onChange(v -> sendToServer(v));

标记与样式

如果你不想用 Java 构建复杂的布局,可以使用 PML 进行结构定义,使用 PSS 进行样式设置。PSS 的工作原理类似 CSS:支持类型、类和 ID 选择器以及正常的优先级规则,并且可以在运行时重新加载样式表以重新设置样式,无需重新编译。

button   { bg: #292A31; padding: 3; }
.warn    { fg: #FF5555; }
#saveBtn { border-color: #4FA3FF; }

主题

每个组件都从一组八个颜色令牌中进行绘制。该模组自带三种主题:Studio(深色,默认)、Paper(浅色)和 Vanilla(匹配游戏原生菜单)。自定义主题只需创建一个包含你自定义颜色的记录(record)即可。

默认行为

窗口拖拽、调整大小、屏幕边界限制、调整大小光标以及溢出滚动等功能开箱即用。如果其他模组释放了光标(例如 Flashback 的回放编辑器或 Axiom),Pane 的窗口仍可点击,且在其他位置的点击仍会传递给该模组。如果不需要这些功能,每个都有相应的开关,例如 .draggable(false) 或 PaneOverlay.setCursorShapes(false)。

开发者指南

将 jar 文件添加到你的开发环境中,并在 fabric.mod.json 或 neoforge.mods.toml 中依赖 pane:

repositories {
    exclusiveContent {
        forRepository { maven { url = "https://api.modrinth.com/maven" } }
        filter { includeGroup "maven.modrinth" }
    }
}

dependencies {
    modImplementation "maven.modrinth:pane:<version>"   // 例如 0.4.0+1.21.11-fabric
    // 在前面添加 `include` 可将 Pane 打包到你的 jar 中,这样玩家
    // 就不需要单独安装它了:
    // include modImplementation("maven.modrinth:pane:<version>")
}

API 在两个加载器上是相同的,因此切换加载器不会影响你的代码。

文档(入门指南、组件目录、数据绑定、PML/PSS 参考)位于 Pane wiki。

Pane 驱动了 Luminary 的整个编辑器,这是我的场景光照工具:三个工具窗口、关键帧时间轴和绘画画布,全部在游戏实时运行。这也是它接受测试的地方。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源