Deimos

Мод Deimos для Minecraft — библиотека для конфигурации и генерации рецептов

Deimos — это библиотека для Minecraft, предназначенная для упрощения разработки модов через централизованную систему конфигурации и генерации рецептов. Она позволяет создавать настраиваемые файлы конфигурации, отображаемые в игре, и динамически менять рецепты крафта (например, плавки или формы) на основе этих настроек. Поддерживает Forge, NeoForge, Fabric и Quilt.

Deimos решает проблему управления конфигурацией в модификациях. Вместо того чтобы каждый автор вынужден был поддерживать разные форматы файлов (JSON, YAML) или писать сложную логику чтения настроек, библиотека предоставляет единый класс DeimosConfig. Разработчик описывает параметры в коде, а библиотека автоматически генерирует файл конфигурации, который игрок может редактировать через GUI внутри игры. Это избавляет от необходимости вручную создавать и поддерживать JSON-файлы в папке config.

Одной из ключевых особенностей Deimos является возможность динамической генерации рецептов. Традиционно рецепты крафта хранятся в статических JSON-файлах, что делает их изменение при обновлении игры или модов сложным процессом. С Deimos вы можете определить логику создания рецептов в коде. Если игрок изменит значение в конфиге (например, включить или выключить определённый рецепт), библиотека пересоздаст соответствующие рецепты при перезапуске игры. Это работает даже для модифицированных предметов и включает в себя все основные типы крафта: форму, бесформенную, плавку, копчение, взрыв и рубку камня.

Техническая реализация библиотеки базируется на MidnightLib от автора Motschen. Это позволяет использовать проверенные механизмы работы с конфигами. Поддержка Fabric реализована через интеграцию с Mod Menu, что обеспечивает нативное отображение настроек без необходимости в дополнительных модификациях интерфейса. Библиотека работает как на клиенте, так и на сервере (опционально), что удобно для модов, требующих синхронизации логики крафта между игроками.

Для разработчиков Deimos предоставляет чистый API на Java. Настройка проекта начинается с добавления библиотеки в зависимости сборки (Gradle). Для Forge и NeoForge используется implementation, а для Fabric — modImplementation. Если требуется функционал Mod Menu для Fabric, необходимо добавить соответствующий репозиторий и зависимость. Библиотека поддерживает миксины, что позволяет ей взаимодействовать с внутренними системами игры на глубоком уровне.

Использование библиотеки начинается с создания класса, наследуемого от DeimosConfig. В нём объявляются статические переменные с аннотацией @Entry, которые будут доступны в конфиге игрока. Например, можно задать список материалов или числовой параметр. Затем в методе инициализации модификации вызывается DeimosConfig.init, передавая ID мода и ссылку на класс конфигурации. Все изменения, внесенные игроком в конфиг, автоматически применяются к рецептам крафта при следующем запуске игры.

Генерация рецептов осуществляется через статические методы класса DeimosRecipeGenerator. Доступны методы для создания рецептов различных типов: createSmeltingJson для плавки, createShapedRecipeJson для форменного крафта и другие. В качестве параметров можно передавать значения из конфигурации, что делает логику крафта полностью настраиваемой. Например, можно сделать так, чтобы рецепт плавки определённого предмета зависел от значения, выбранного в конфиге игрока. Это дает огромную гибкость при создании модов с уникальной механикой крафта.

Библиотека распространяется под лицензией MIT, что позволяет использовать её в коммерческих и бесплатных проектах без ограничений. Она не требует обязательных зависимостей от других модов и работает на множестве версий игры, начиная с 1.18 и включая последние версии 1.21.x. Архив библиотеки компактен, содержит миксины и не требует дополнительных файлов для установки, что упрощает интеграцию в существующие проекты.

Связанные материалы

• Fabric API — похожий мод
• Cloth Config API — похожий мод
• YetAnotherConfigLib (YACL) — похожий мод
• Fabric Language Kotlin — похожий мод
• Architectury API — похожий мод
• Just Enough Items (JEI) — похожий мод

Автор: MarsThePlanet · Лицензия: MIT