CraftUI

CraftUI

Фреймворк для использования Dear ImGui в Minecraft

За последние несколько лет я заметил растущее использование ImGui в утилитарных модах вроде Flashback. Однако из-за технических ограничений ни один из этих модов не совместим с другими (а если и совместим, то работает крайне криво). CraftUI — это фреймворк, который пытается это исправить. Будучи обёрткой Dear ImGui специально для Minecraft, он берёт на себя монтирование и рендеринг нативного кода ImGui, кросс-модовую совместимость, а также предоставляет набор дополнительных утилит, специфичных для Minecraft.

Примечание: фреймворк всё ещё в разработке, и функциональность публичного API может меняться. К тому же сейчас он поддерживает не все версии Minecraft.

Примеры

Возможности

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! Когда фреймворк установлен и собирается, вы можете создать новое UI-приложение, унаследовавшись от CraftApp:

public class ExampleApp extends CraftApp {
    @Override
    protected void render(MinecraftClient client) {
        // ImGui rendering code here
    }
}

Теперь, чтобы открыть интерфейс, вызовите:

AppManager.openApp(new ExampleApp());

Приложение будет рендериться поверх игры, пока не будет закрыто через exampleApp.close(). Более подробный пример смотрите в testmod.

Важные замечания:

• Из-за размера включённых нативных библиотек не рекомендуется включать сам фреймворк в ваш мод.
• Пакет com.igrium.craftui.impl не считается частью публичного API и может меняться без предупреждения!