Lexiconfig Mod untuk Minecraft 1.20.1, 1.21.1

Ikhtisar

Ini adalah API konfigurasi yang dimaksudkan untuk menyediakan kompatibilitas di antara berbagai pustaka konfigurasi lain sekaligus mudah digunakan dalam pengaturan proyek multiloader, terutama untuk digunakan di mod saya.

Ini menampilkan sintaks berbasis anotasi yang mudah digunakan, untuk membuat pembuatan file konfigurasi baru semudah mungkin.

Jika Anda seorang pengguna mod, informasi ini kemungkinan tidak terlalu berguna bagi Anda. Namun jika Anda seorang pengembang mod, dan Anda ingin menggunakan Lexiconfig di proyek Anda sendiri, gulir lebih jauh ke bagian Development.

Saat ini belum memiliki dukungan untuk pustaka konfigurasi lain, tetapi seiring saya terus memperbaruinya, saya akan menambahkan lebih banyak kompatibilitas ke masing-masing pustaka untuk memastikan bahwa ia tidak bertentangan dengan yang lain dan sebaliknya dapat terintegrasi dengan mulus di antara mereka.

Berikut adalah daftar integrasi saat ini serta yang direncanakan di berbagai pustaka/API konfigurasi:

❌ - Belum Terintegrasi ✅ - Terintegrasi ❓ - Sedang Diproses

Status Mod

❌ Cloth Config

❌ oωo config

✅ Configured

❌ Forge Config Screens

Development

Mod ini berisi API yang dapat digunakan untuk menyimpan lexicon baru, mendengarkan event, dan lain-lain.

Depending

build.gradle

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

Anda dapat mengunjungi https://versions.codinglitch.com untuk melihat versi API terbaru.

Usage

Untuk menyimpan lexicon Anda sendiri, Anda harus terlebih dahulu membuat Library Anda sendiri. Ini dapat dilakukan dengan cukup membuat kelas baru yang memperluas kelas Library, dan menganotasinya dengan anotasi LexiconLibrary.

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

Dalam pengaturan Forge, tidak ada perubahan lebih lanjut yang perlu dilakukan. Namun, jika Anda mengembangkan untuk Fabric, Anda harus menambahkan kelas ini sebagai entrypoint di fabric.mod.json Anda.

fabric.mod.json

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

Langkah berikutnya adalah akhirnya membuat dan menyimpan lexicon Anda. Anda dapat melakukan ini dengan cukup membuat kelas lain untuk lexicon tersebut, dan memberinya anotasi yang sesuai, seperti berikut:

@Lexicon(name = MYLEXICONTITLE) // sebaiknya gunakan mod id Anda sebagai nama 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; } }

Langkah berikutnya dan terakhir adalah menyimpan lexicon tersebut, yang dapat dilakukan dengan cukup menambahkan instance-nya sebagai field di library dan menyimpannya dalam metode yang diberikan.

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