Lexiconfig Мод для Minecraft 1.20.1, 1.21.1

Огляд

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

Воно має простий у використанні синтаксис на основі анотацій, щоб зробити створення нових файлів конфігурації якомога простішим.

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

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

Ось список поточних, а також запланованих інтеграцій із різними бібліотеками/API конфігурації:

❌ - Не інтегровано ✅ - Інтегровано ❓ - У процесі

Статус Мод

❌ Cloth Config

❌ oωo config

✅ Configured

❌ Forge Config Screens

Розробка

Цей мод містить API, який можна використовувати для розміщення нових лексиконів, прослуховування подій тощо.

Залежність

build.gradle

dependencies { implementation "com.codinglitch.lexiconfig:lexiconfig-api:APIVERSIONHERE" }

Ви можете перейти на https://versions.codinglitch.com, щоб переглянути найновішу версію API.

Використання

Щоб розмістити власні лексикони, спершу потрібно створити власну Library. Це можна зробити, просто створивши новий клас, що розширює клас Library, і позначивши його анотацією LexiconLibrary.

@LexiconLibrary public class MyNewLibrary extends Library { @Override public void shelveLexicons() { } }

У налаштуванні Forge жодних подальших змін вносити не потрібно. Однак, якщо ви розробляєте для Fabric, вам доведеться додати цей клас як точку входу у вашому fabric.mod.json.

fabric.mod.json

//... "entrypoints": { "lexiconfig": [ "com.path.to.MyNewLibrary" ] } //...

Наступний крок — нарешті створити та розмістити ваші лексикони. Це можна зробити, просто створивши ще один клас для лексикону та надавши йому відповідні анотації, як показано далі:

@Lexicon(name = MYLEXICONTITLE) // preferably use your mod id as a name public class MyLexicon extends LexiconData { @LexiconEntry(comment = "This is a comment for a simple field!") public String mySimpleField = "content"; @LexiconPage(comment = "This is a fancy new comment on the fancy new category!") public MyNewPage myNewPage = new MyNewPage(); public static class MyNewPage extends LexiconPageData { @LexiconEntry(comment = "This field is inside a lexicon page!") public Boolean myPageField = true; } }

Наступний і останній крок — розмістити лексикон, що можна зробити, просто додавши його екземпляр як поле в бібліотеці та розмістивши його в наведеному методі.

@LexiconLibrary public class MyNewLibrary extends Library { public static MyLexicon MYLEXICON = new MyLexicon(); @Override public void shelveLexicons() { LexiconfigApi.shelveLexicon(MYLEXICON); } }