YetAnotherConfigLib v3 1.21.4: полное руководство по установке и настройке

Что такое YetAnotherConfigLib (YACL)

YetAnotherConfigLib (YACL) — это лёгкая библиотека конфигурации для Minecraft, построенная на основе билдера. Она создана для того, чтобы заполнить пробел в области моддинга, связанный с управлением настройками. В отличие от многих других библиотек, YACL не содержит дополнительных функций, кроме генерации экрана конфигурации. Это делает её компактной и узкоспециализированной.

YACL оставляет управление конфигурацией на усмотрение разработчика мода — в ней нет встроенной автоконфигурации или аналогичных механизмов. Основная задача библиотеки — предоставить удобный и стилизованный интерфейс для изменения параметров модов.

Библиотека доступна для нескольких загрузчиков модов: Fabric, Forge, NeoForge и Quilt. Версия v3 для Minecraft 1.21.4 является одной из актуальных и поддерживает все современные возможности.

Основные возможности YACL v3

YACL v3 предлагает широкий набор функций для создания конфигурационных экранов:

• Пользовательские виджеты управления: можно создавать собственные контроллеры, если стандартного набора недостаточно.
• Богатые описания: поддерживаются кликабельные и наводимые тексты на основе ванильной системы текстовых компонентов Minecraft.
• Предпросмотр изображений: поддержка WebP (включая анимированные) и пользовательских рендеров для замены изображений.
• Множество контроллеров для одного типа данных: например, для чисел можно использовать ползунки или поля ввода, для строк — выпадающие списки, циклические переключатели или текстовые поля, для булевых значений — флажки или отображение ON/OFF.
• Полноценный выбор цвета: встроенный цветовой пикер.
• Доступность: полная поддержка управления с клавиатуры, оптимизированная для использования с Controlify.
• Организация: вкладки (категории) и сворачиваемые группы для удобной навигации.
• Встроенная сериализация/десериализация: позволяет избежать ошибок при написании кода конфигурации.
• Альтернативный Kotlin DSL: для разработчиков, предпочитающих Kotlin.

Сравнение с другими библиотеками конфигурации

YACL был создан из-за недостатков существующих библиотек:

• Cloth Config API: разработчик заявил, что библиотека находится в замороженном состоянии и новые функции добавляться не будут.
• SpruceUI: изначально не предназначена для конфигурации, из-за чего интерфейс кажется загромождённым.
• OwoLib: содержит множество других функций помимо конфигурации, что увеличивает размер и сложность.

YACL, в отличие от них, сфокусирован исключительно на конфигурации, использует современный подход и вдохновлён внутренней библиотекой Sodium. Это позволяет ему быть лёгким, стилизованным под Minecraft и легко расширяемым.

Установка YACL v3 1.21.4 на Fabric

Для установки YACL v3 на Minecraft 1.21.4 с загрузчиком Fabric выполните следующие шаги:

1. Установите Fabric Loader и Fabric API. Fabric API — обязательная зависимость для работы многих модов, включая YACL.
2. Скачайте файл yet_another_config_lib_v3-3.8.1+1.21.4-fabric.jar. Размер файла составляет около 1.08 МБ.
3. Переместите скачанный JAR-файл в папку .minecraft/mods. Если папка отсутствует, создайте её.
4. Запустите игру с профилем Fabric.

После установки YACL будет доступен для использования другими модами, которые зависят от этой библиотеки. Сама по себе библиотека не добавляет никаких видимых изменений в игру — она служит только как инструмент для других модов.

Установка YACL v3 1.21.4 на NeoForge и Forge

YACL также поддерживает NeoForge и Forge. Процесс установки аналогичен Fabric:

NeoForge:

1. Установите NeoForge для версии 1.21.4.
2. Скачайте соответствующую версию YACL для NeoForge (например, yet another config lib v3-3.8.1+1.21.4-neoforge.jar).
3. Поместите файл в папку mods.

Forge:

1. Установите Forge для 1.21.4.
2. Скачайте версию для Forge (например, yet-another-config-lib-forge-3.1.1+1.19.4.jar — для более старых версий; для 1.21.4 доступна соответствующая сборка).
3. Переместите файл в папку mods.

Важно: версии для разных загрузчиков не взаимозаменяемы. Используйте только тот файл, который соответствует вашему загрузчику.

Установка YACL на Quilt

Quilt — это форк Fabric, и YACL также поддерживает этот загрузчик. Для установки:

1. Установите Quilt Loader и QSL (Quilt Standard Libraries).
2. Скачайте версию YACL для Fabric (Quilt использует те же файлы, что и Fabric, при условии совместимости).
3. Поместите JAR-файл в папку mods.

На практике для Quilt часто подходят те же файлы, что и для Fabric, но рекомендуется проверять совместимость в описании мода.

Версии YACL и совместимость с Minecraft

YACL v3 выпускается для широкого диапазона версий Minecraft. Вот некоторые из них:

• 1.21.4: версия 3.8.1 (Fabric, NeoForge)
• 1.21.1: версия 3.8.1
• 1.20.6: версия 3.6.6
• 1.20.1: версия 3.6.6
• 1.19.4: версия 3.1.1
• 1.19.2: версия 2.2.0

Важно: версии YACL строго привязаны к версии Minecraft. Не пытайтесь установить файл для 1.20.6 на 1.21.4 — это приведёт к ошибкам. Всегда скачивайте файл, соответствующий вашей версии игры и загрузчику.

Размер файлов варьируется от 200 КБ для старых версий до 1.08 МБ для новых.

Как использовать YACL в своих модах

YACL предоставляет API для разработчиков модов. Основные шаги:

1. Добавьте YACL как зависимость в ваш проект (например, через Gradle).
2. Используйте билдер для создания экрана конфигурации. Пример на Java:

   YetAnotherConfigLib.createBuilder()
       .title(yourTitle)
       .category(yourCategory)
       .build();

1. Зарегистрируйте экран конфигурации в вашем моде.

YACL поддерживает Kotlin DSL, что упрощает написание конфигурации для разработчиков, использующих Kotlin. Полная документация доступна в вики проекта.

Библиотека автоматически обрабатывает сериализацию и десериализацию, что снижает вероятность ошибок.

Частые проблемы и их решение

При установке YACL могут возникнуть следующие проблемы:

• Игра вылетает при запуске: проверьте, что версия YACL соответствует версии Minecraft и загрузчику. Убедитесь, что установлены все зависимости (Fabric API, Forge, NeoForge или QSL).
• Мод не видит YACL: убедитесь, что файл YACL находится в папке mods, а не в mods/1.21.4 или другой подпапке.
• Конфликт с другими библиотеками: YACL может конфликтовать с другими библиотеками конфигурации, если они используют те же классы. Рекомендуется использовать только одну библиотеку конфигурации.
• Проблемы с русским языком: YACL поддерживает Unicode, поэтому кириллица отображается корректно. Если текст не отображается, проверьте настройки шрифта в игре.

Если проблема не решается, обратитесь к сообществу мода на Discord или в раздел Issues на Modrinth.

Заключение: стоит ли использовать YACL

YetAnotherConfigLib — это современная, лёгкая и функциональная библиотека конфигурации для Minecraft. Она решает проблемы, присущие другим библиотекам, и предлагает удобный API для разработчиков. Для пользователей YACL незаметен — он работает в фоне, обеспечивая настройку модов.

Если вы разрабатываете мод и ищете библиотеку конфигурации, YACL — отличный выбор. Она активно поддерживается, имеет подробную документацию и совместима с основными загрузчиками.

Для игроков установка YACL обычно требуется только как зависимость для других модов. В этом случае достаточно скачать правильную версию и поместить её в папку mods.

Вопросы и ответы