CraftUI
一个用于在 Minecraft 中使用 Dear ImGui 的框架
在过去几年里,我注意到像 Flashback 这类实用模组中越来越多地使用 ImGui。然而,由于技术限制,这些模组之间无法互相兼容(即使能兼容,体验也极其糟糕)。
CraftUI 是一个旨在解决此问题的框架。作为 Dear ImGui 的 Minecraft 专用封装,它负责挂载和渲染 ImGui 原生代码、实现跨模组兼容,并提供一套额外的、针对 Minecraft 特定的实用系统。
注意:该框架仍处于开发阶段,公共 API 功能可能会发生变化。 此外,目前它尚不支持所有 Minecraft 版本。
示例

特性
CraftUI 基于 ImGui Java 构建,因此包含其所有特性。 在此基础上,它还额外包括:
- 基于资源包的字体加载
- 用户可定义的主题(同样基于资源包)
- 通过 Dock Space 调整游戏视口大小
- 原生文件浏览器访问权限
- 其他各种实用工具
入门指南
首先,在使用此库之前,重要的是要具备对 Dear ImGui 及其特定分支 ImGui Java 的基本理解。 任何关于 ImGui 本身的问题都将引导至相关文档。
接下来,要在你的 buildscript 的 repositories 部分添加以下内容以进行安装:
repositories {
// ...
maven { url = 'https://jitpack.io' }
}
然后,在你的 dependencies 部分添加以下内容,将 [version] 替换为你想要的版本:
dependencies {
// ...
modImplementation 'com.github.Igrium:CraftUI:[version]'
}
别忘了在 fabric.mod.json 中添加依赖!
一旦框架安装并构建完成,你可以通过扩展 CraftApp 来创建一个新的 UI 应用:
public class ExampleApp extends CraftApp {
@Override
protected void render(MinecraftClient client) {
// 在此处编写 ImGui 渲染代码
}
}
现在,要打开 UI,请调用:
AppManager.openApp(new ExampleApp());
该应用将在游戏之上渲染,直到通过 exampleApp.close() 关闭为止。有关更深入的示例,请参阅 testmod。
重要提示:
- 由于包含的原生库体积较大,不建议将该框架本身打包到你的模组中。
com.igrium.craftui.impl包 不属于 公共 API 的一部分,且可能在不通知的情况下发生变化!
CraftUI
A framework to use Dear ImGui in Minecraft
Over the past few years, I've noticed a growing use of ImGui in utility mods such as Flashback. However, due to technical constraints, none of these mods can be compatible with each other (and if they are, they're extremely jank).
CraftUI is a framework that attempts to fix this. Being a minecraft-specific wrapper for Dear ImGui, it handles mounting and rendering the ImGui native code, cross-mod compatibility, as well as providing a set of extra, Minecraft-specific utility systems.
Note: This framework is still in development, and public API functionality might change. It also doesn't support all Minecraft versions right now.
Examples

Features
CraftUI is built on ImGui Java, and by extension, contains all its features. On top of that, it also includes:
- Resource-pack-based font loading
- User-definable themes (also resource-pack-based)
- Game viewport resizing via dock-space
- Native file browser access
- Other various utilities
Getting Started
To preface, it's important to have a basic understanding of Dear ImGui, and specifically ImGui Java, before using this library. Any questions pertaining ImGui on its own will be redirected there.
With that said, to install, add the following to the repositories section of your buildscript:
repositories {
// ...
maven { url = 'https://jitpack.io' }
}
Then, in your dependencies section, add the following, replacing [version] with the desired version:
dependencies {
// ...
modImplementation 'com.github.Igrium:CraftUI:[version]'
}
And don't forget to add it as a dependency in fabric.mod.json!
Once you have the framework installed and building, you can create a new UI application by extending CraftApp:
public class ExampleApp extends CraftApp {
@Override
protected void render(MinecraftClient client) {
// ImGui rendering code here
}
}
Now, to open the UI, call:
AppManager.openApp(new ExampleApp());
The app will now render atop the game until it is closed with exampleApp.close(). See testmod for a more in-depth example.
Important Notes:
- Due to the size of the included native libraries, it is not recommended to bundle the framework itself with your mod.
- The package
com.igrium.craftui.implis not considered part of the public API, and could change without warning!
下载 CraftUI
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 CraftUI
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 CraftUI
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 CraftUI
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 CraftUI
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 CraftUI
下载 CraftUI
下载 CraftUI
这是自 1.0 版本以来的首次重大 API/内容更新。它与之前的版本向后兼容,但增加了新功能,因此你需要在模组属性中更新最低版本要求。
新增功能
行业标准视口控件
新增的 ViewportControlHelper 类支持行业标准的、类似 3D 编辑器的轨道旋转(Orbit)、平移(Pan)和缩放(Zoom)导航。其默认控制方案如下:
Alt + M1:轨道旋转Alt + M3:平移M3:缩放
可以通过重写辅助类来更改这些设置。同时也支持滚动缩放。
编辑器 Gizmos(辅助工具)
现在原生支持 ImGuizmo。虽然此前通过手动初始化也能实现此功能,但 CraftUI 现在会自动管理投影矩阵。
要使用它,请在绘制视口窗口时调用 GizmoHelper.setupGizmos(),然后照常使用 ImGuizmo。为了方便起见,提供了使用 JOML 矩阵而非原始浮点数组的封装方法。
注意,由于在世界坐标较大时存在浮点数精度误差的风险,Gizmos 始终相对于相机进行绘制。
摄像机状态缓存
CraftUI 每帧都会缓存世界渲染状态的各个元素,例如摄像机位置和投影矩阵。这些值由 Gizmos 和视口射线检测内部使用,并可通过以下方式访问:
CraftUI.getCameraPos()CraftUI.getCameraRot()CraftUI.getViewRotationMatrix()CraftUI.getRawProjectionMatrix()CraftUI.getProjectionMatrix()(针对 ImGuizmo 和其他标准数学计算进行了 Y 轴反转)CraftUI.getTickDelta()
CraftUI 渲染事件
添加了各种基于事件的回调(CraftUIRenderEvents),以便接入 CraftUI 渲染管线。这些功能非常强大,但可能会干扰其他模组,请谨慎使用:
PRE_RENDERCOMPUTE_VIEWPORT_BOUNDS(可覆盖计算出的边界)UPDATE_STYLEPOST_COMPOSITEBEGIN_FRAME和END_FRAMEBEFORE_RENDER和AFTER_RENDERBEGIN_RENDER和END_RENDER
每个事件都会接收一个上下文对象,该对象暴露了已打开的应用程序、视口边界以及是否为清理帧。
修复
- 文本输入现在通过 Minecraft 的
TextInputManager正确启动和停止。 - 当 ImGui 需要鼠标控制权时,鼠标按键释放不再被吞没,从而避免按钮处于“按下”状态。(由 MCJEModder2026 修复)
- NBT 编辑器中的选择项现在使用
NoAutoClosePopups,因此 NBT 编辑器现在可以在应用程序提供的弹出窗口中使用。 - LWJGL 核心库现在已从传递依赖中排除,这样 CraftUI 就不会强制消费者使用特定版本。这仅在开发环境中是一个问题。
- 从
inter.json中移除了未使用的font-awesome-brands图标字体。 - 停止了 Gson 每次加载样式时向控制台发出警告的行为。
1.0 的 26.2 版本修复了一些小问题:
- 修复了意外引入的对错误版本 lwjgl 的传递性依赖
- 修复了对不存在的 font-awesome-brands ttf 文件的引用
关于这个资源的讨论、问题反馈与使用心得
还没有讨论,来发第一帖吧
你是这个资源的作者?登录后可认领此资源。
相似资源
模组
一个用于收集生物掉落物的多区块模组。
模组
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
模组
查看物品与配方
模组
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
模组
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
模组
适用于 MC 1.18+ 的 Effekseer 加载器
评论 0
登录后参与评分
还没有评论,来抢沙发吧