Forge Config API Port — Minecraft Java Edition

Ванільний Minecraft не містить вбудованих інструментів для зручного налаштування параметрів гри чи модифікацій, що змушує розробників самостійно створювати системи збереження конфігурацій. Мод-лоадер Forge пропонує готове рішення у вигляді власної системи конфігурування, але Fabric історично не має єдиного стандарту для цього. Через це творцям крос-платформних модів доводиться писати окремий код налаштувань для кожного лоадера, витрачаючи багато часу на рутину. Бібліотека Forge Config API Port вирішує цю проблему, переносячи перевірений часом конфігураційний інтерфейс Forge на Fabric та Quilt.

Як працює бібліотека

Forge Config API Port виступає посередником між кодом модифікації та файловою системою гри. Вона повністю відтворює оригінальні пакети net.minecraftforge.common.ForgeConfigSpec та net.neoforged.fml.config у середовищі Fabric. Розробник пише опис конфігурації лише один раз, використовуючи стандартний синтаксис Forge, а бібліотека автоматично створює відповідні файли на диску та керує їх завантаженням.

Формат конфігураційних файлів TOML

Бібліотека зберігає всі налаштування у форматі TOML. Цей формат пропонує зручну структуру для читання та редагування за допомогою звичайного текстового редактора. Кожен параметр може містити коментарі, значення за замовчуванням, а також чіткі межі допустимих значень (мінімальне та максимальне число). Файли конфігурації автоматично з'являються у папці config всередині кореневого каталогу гри після першого запуску модифікації. Вони мають розширення .toml та назву, яку вказав розробник моди.

Автоматична синхронізація та динамічне перезавантаження

Однією з найважливіших особливостей Forge Config API Port є вбудована підтримка синхронізації та динамічного перезавантаження конфігурацій:

• Синхронізація між сервером та клієнтом (Sync): коли гравець підключається до сервера, сервер автоматично надсилає свої налаштування клієнту. Це запобігає виникненню конфліктів через різні версії конфігурацій у гравців на сервері.

• Динамічне перезавантаження (Reload): бібліотека відстежує зміни у TOML-файлах у реальному часі. Якщо ти відредагуєш та збережеш файл конфігурації під час гри, Forge Config API Port негайно оновить параметри в оперативній пам'яті без потреби перезапускати клієнт Minecraft.

Ці механізми працюють автоматично, позбавляючи розробників необхідності самостійно кодувати мережеву взаємодію для синхронізації значень конфігурації.

Значення для гравців та розробників

Для звичайних гравців Forge Config API Port не додає жодного видимого контенту, нових блоків чи предметів. Її роль полягає в забезпеченні працездатності інших модифікацій. Без встановлення цієї бібліотеки гра просто не запуститься, якщо інші моди посилаються на її класи. Модифікація потрібна здебільшого користувачам Fabric, оскільки Forge та NeoForge мають ці функції за замовчуванням у своїй структурі.

Для розробників бібліотека є незамінним інструментом при створенні крос-платформних проєктів. Вона дозволяє:

1. Заощаджувати сотні рядків коду, які раніше йшли на розробку окремої логіки збереження налаштувань для різних лоадерів.

2. Забезпечувати однаковий досвід адміністрування модів для кінцевих користувачів, оскільки конфігураційні файли мають ідентичну структуру на Fabric та Forge.

3. Використовувати потужний інструментарій валідації значень Forge, який автоматично виправляє помилкові введення користувачів, повертаючи параметри до значень за замовчуванням при збоях.

Популярні залежні модифікації

Розробник бібліотеки, відомий під ніком Fuzs (або Fuzs_), використовує її в усіх своїх популярних модах. Ось кілька відомих прикладів:

• Easy Magic: мод, що змінює механіку столу чарування, дозволяючи зберігати предмети всередині інвентарю столу та додаючи нові способи покращення чарів.

• Trading Post: блок, який об'єднує торгові пропозиції всіх навколишніх жителів села в одному інтерфейсі.

• Visuality: мод на візуальні ефекти, який додає реалістичні частинки бруду, іскор та бризок води від різних дій мобів.

• Easy Shulker Boxes: дозволяє взаємодіяти з шалкеровими скринями безпосередньо з інвентарю без їхнього встановлення на землю.

Окрім проєктів від Fuzs, сотні інших розробників використовують Forge Config API Port для перенесення своїх напрацювань з Forge на Fabric, завдяки чому гравці отримують доступ до величезної бібліотеки якісного контенту.