CraftUI

Платформа для интеграции Dear ImGui в Minecraft

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

CraftUI представляет собой решение этой проблемы. Будучи специализированной обёрткой Dear ImGui для Minecraft, система берёт на себя подключение и отрисовку нативного кода ImGui, обеспечивает кросс-модовую совместимость и включает набор дополнительных инструментов, адаптированных специально для игры.

Внимание: Платформа находится в стадии активной разработки, поэтому публичное API может меняться. Также сейчас поддерживаются не все версии Minecraft.

Возможности системы

CraftUI создана на базе ImGui Java и наследует все её функции. В дополнение к этому предлагаются:

2. Загрузка шрифтов через ресурспаки — позволяет использовать пользовательские гарнитуры

3. Настраиваемые темы оформления — также работают через ресурспаки

4. Изменение размера игрового окна — реализовано через систему dock-space

5. Доступ к нативному файловому браузеру — удобная работа с файлами

6. Различные вспомогательные инструменты — дополнительные утилиты для разработчиков

Быстрый старт

Перед использованием рекомендуется освоить базовые принципы работы с Dear ImGui и specifically 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 размещается здесь
    }
}

Для открытия интерфейса вызовите:

AppManager.openApp(new ExampleApp());

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

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

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