体素界面

体素界面

用于Minecraft NeoForge的现代UI框架,支持XML布局、MCSS样式、可复用组件、主题化和开发者工具。

基础库

VoxelUI

VoxelUI 是一个面向 Minecraft NeoForge 1.21.1 的现代 UI 框架。

它专为希望创建丰富、可维护、原生 Minecraft 界面而不依赖大型基于 PNG 的 UI 图集的模组开发者而构建。

Beta 版本发布说明

VoxelUI 目前处于公开测试阶段。

此版本旨在:

  • 在真实模组开发用例中验证框架
  • 收集错误报告
  • 识别 API 和组件系统中的薄弱环节
  • 在未来的稳定版本发布前稳定引擎

您应预期:

  • 存在错误
  • 部分组件行为不完整或粗糙
  • Beta 版本之间可能发生 API 变更
  • 边缘情况下出现布局或渲染回归

如果您测试 VoxelUI 并报告问题,这对推动项目达到稳定版本极为有用。

VoxelUI 提供的内容

  • 基于 XML 的屏幕布局
  • 支持级联的 MCSS 样式系统
  • 可复用的 UI 组件
  • 集中式主题管理
  • 现代布局容器
  • Minecraft 专属 UI 组件
  • 用于检查和迭代的开发者工具

核心功能

布局与组合

  • Panel
  • Grid
  • Stack
  • Tabs
  • ScrollPanel
  • ListView

交互组件

  • Button
  • TextInput
  • Checkbox
  • Slider
  • Dropdown

面向 Minecraft 的组件

  • ItemStackView
  • InventoryGrid
  • ItemSlot

样式与工具

  • XML UI 加载器
  • 内联和外部 MCSS 样式表
  • 带计算样式的样式级联
  • UI 检查器
  • 开发环境中的热重载
  • 安全的 XML 错误回退面板
  • 动画 UI 过渡,如悬停和流畅滚动

使用场景

VoxelUI 设计用于构建以下类型的界面:

  • 配置屏幕
  • 任务日志
  • 自定义物品栏
  • 商店
  • 管理面板
  • HUD 叠加层
  • 数据驱动的 UI 屏幕

设计理念

VoxelUI 不会 尝试在 Minecraft 中嵌入浏览器。

相反,它为原生 Minecraft 渲染带来了更现代的 UI 工作流:

  • 声明式
  • 模块化
  • 可主题化
  • 可复用
  • 渲染器原生

当前状态

VoxelUI 是一个 框架/库模组,而非独立的内容模组。

发布构建默认禁用内部展示和调试工具。开发构建则保留它们以供迭代和检查。

此项目目前尚未完全稳定。此 Beta 阶段的目标是通过真实世界的反馈来加固框架,然后再锁定更稳定的 API 表面。

兼容性

  • Minecraft: 1.21.1
  • 加载器: NeoForge
  • Java: 21

面向开发者

VoxelUI 旨在作为需要结构化 UI 系统的其他模组的基础。

它包含:

  • 一个 measure -> layout -> render 管线
  • XML 驱动的屏幕构建
  • 可复用的运行时绑定
  • MCSS 样式
  • 原生 Minecraft 渲染集成

期望的反馈

如果您使用此 Beta 版本,最有用的反馈是:

  • 可复现的错误
  • 损坏的布局
  • 渲染问题
  • 不清晰或令人沮丧的 API 设计
  • 阻碍实际使用的缺失功能
  • XML、MCSS 和运行时绑定之间的意外行为

许可证

Apache License 2.0