制作界面

制作界面

Minecraft 上基于 Dear ImGui 的实现,用于游戏内编辑器。

基础库

CraftUI

一个在 Minecraft 中使用 Dear ImGui 的框架


在过去的几年里,我注意到 ImGui 在 Flashback 等实用模组中的使用越来越多。然而,由于技术限制,这些模组都无法相互兼容(即使有,也极其糟糕)。

CraftUI 是一个试图解决这个问题的框架。作为 Dear ImGui 的 Minecraft 专用封装,它负责挂载和渲染 ImGui 原生代码、跨模组兼容性,并提供一套额外的 Minecraft 专用实用系统。

注意:此框架仍在开发中,公共 API 功能可能会发生变化。 它目前也尚未支持所有 Minecraft 版本。

示例

编辑器 UI 示例 ImGui 提供的一些控件

特性

CraftUI 基于 ImGui Java 构建,因此包含其所有特性。除此之外,它还包括:

  • 基于资源包的字体加载
  • 用户可定义主题(同样基于资源包)
  • 通过停靠空间调整游戏视口大小
  • 原生文件浏览器访问
  • 其他各种实用工具

快速开始

首先需要说明的是,在使用此库之前,对 Dear ImGui(特别是 ImGui Java)有基本了解非常重要。任何仅与 ImGui 本身相关的问题将被重定向至那里。

话虽如此,要安装,请将以下内容添加到构建脚本的 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 的一部分,可能在不事先通知的情况下发生变化!