fabric

API Kain

Kait penting untuk modding dengan Fabric.

Fabric API adalah perpustakaan untuk hook penting dan mekanisme interoperabilitas untuk mod Fabric. Contohnya meliputi:

• Mengekspos fungsionalitas yang berguna tetapi sulit diakses untuk banyak mod seperti partikel, bioma, dan dimensi
• Menambahkan acara, kait, dan API untuk meningkatkan interopabilitas antar mod.
• Fitur penting seperti sinkronisasi registri dan menambahkan informasi ke laporan kerusakan.
• API rendering tingkat lanjut yang dirancang untuk kompatibilitas dengan mod pengoptimalan dan mod perombakan grafis.

Periksa juga Fabric Loader, pemuat mod (kebanyakan) yang tidak bergantung pada versi yang mendukung Fabric. Fabric API adalah mod seperti mod Fabric lainnya yang memerlukan instalasi Fabric Loader.

Untuk dukungan dan diskusi bagi pengembang dan pengguna, kunjungi server Fabric Discord.

Menggunakan Fabric API untuk bermain dengan mod

Pastikan Anda telah menginstal fabric loader terlebih dahulu. Informasi lebih lanjut tentang menginstal Fabric Loader dapat ditemukan di sini.

Untuk menggunakan Fabric API, unduh dari CurseForge, GitHub Releases, atau Modrinth.

File jar yang diunduh harus ditempatkan di folder mods Anda.

Menggunakan Fabric API untuk mengembangkan mod

Untuk menyiapkan lingkungan pengembangan Fabric, lihat mod contoh Fabric dan ikuti petunjuk di sana. Contoh mod sudah bergantung pada Fabric API.

Untuk menyertakan API Fabric lengkap dengan semua modul di lingkungan pengembangan, tambahkan kode berikut ke blok dependencies Anda di skrip build gradle:

DSL yang asyik

modImplementation " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION "

DSL Kotlin

modImplementation( " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION " )

Alternatifnya, modul dari Fabric API dapat ditentukan satu per satu seperti yang ditunjukkan di bawah ini (termasuk jar modul ke jar mod Anda):

DSL yang asyik

 // Make a collection of all api modules we wish to use
Set< String > apiModules = [
    " fabric-api-base " ,
    " fabric-command-api-v1 " ,
    " fabric-lifecycle-events-v1 " ,
    " fabric-networking-api-v1 "
]

// Add each module as a dependency
apiModules . forEach {
    include(modImplementation(fabricApi . module(it, FABRIC_API_VERSION )))
}

DSL Kotlin

 // Make a set of all api modules we wish to use
setOf (
    " fabric-api-base " ,
    " fabric-command-api-v1 " ,
    " fabric-lifecycle-events-v1 " ,
    " fabric-networking-api-v1 "
).forEach {
    // Add each module as a dependency
    modImplementation(fabricApi.module(it, FABRIC_API_VERSION ))
}

Daripada melakukan hardcoding pada konstanta versi di seluruh skrip build, properti Gradle dapat digunakan untuk menggantikan konstanta ini. Properti ditentukan dalam file gradle.properties di akar proyek. Informasi lebih lanjut tersedia di sini.

Berkontribusi

Lihat sesuatu yang tidak didukung oleh Fabric API, bug atau sesuatu yang mungkin berguna? Kami menyambut baik kontribusi untuk meningkatkan Fabric API. Pastikan untuk membaca pedoman pengembangan.

Modul

Fabric API dirancang bersifat modular untuk kemudahan pembaruan. Ini juga memiliki keuntungan dalam membagi basis kode menjadi bagian-bagian yang lebih kecil.

Setiap modul berisi README.md * masing-masing yang menjelaskan tujuan modul dan info tambahan tentang penggunaan modul.

* README untuk setiap modul sedang dikerjakan; tidak setiap modul memiliki README saat ini