Mod Menu untuk Minecraft 1.20.1, 1.21.1

Mod Menu

Mod Menu memungkinkan Anda melihat mod yang telah terpasang dan, jika didukung oleh mod tersebut, menyediakan akses cepat dan mudah ke layar konfigurasi mod.

Mod Menu juga mendukung beberapa fitur yang lebih canggih, seperti nama dan deskripsi mod yang dapat diterjemahkan, dukungan untuk pemformatan QuickText dalam deskripsi mod berkat Text Placeholder API dari Patbox, menyaring mod pustaka dari mod biasa, pemeriksa pembaruan mod untuk mod yang dihosting di Modrinth atau yang menyediakan sumber pembaruan sendiri, serta konfigurasi mendalam untuk semua fitur yang kami sediakan.

Platform yang Didukung

Mod Menu saat ini tersedia untuk Fabric atau Quilt pada Minecraft: Java Edition 1.14 atau yang lebih baru.

Pengembang

Mod Menu menyertakan sejumlah API bagi pengembang untuk meningkatkan tampilan mod mereka di Mod Menu. Ini tersedia dalam bentuk kunci bahasa, metadata JSON, dan bahkan API Java.

API Terjemahan

Anda dapat menerjemahkan nama, ringkasan, dan deskripsi mod Anda tanpa menyentuh kode Java sama sekali. Cukup tambahkan kunci terjemahan dalam format yang didukung ke bahasa apa pun yang Anda inginkan.

Dokumentasi API Terjemahan

Berikut contoh terjemahan Mod Menu ke Pirate Speak. Untuk membuat milik Anda sendiri, cukup ganti modmenu di akhir (BUKAN yang di awal) kunci terjemahan dengan ID mod Anda sendiri, misalnya modmenu.descriptionTranslation.traverse.

enpt.json

"modmenu.nameTranslation.modmenu": "Menu o' mods!", "modmenu.descriptionTranslation.modmenu": "Menu o' mods ye installed matey!", "modmenu.summaryTranslation.modmenu": "Menu o' mods ye installed matey!"

Terjemahan ringkasan di sini berlebihan dan tidak perlu disertakan karena sama dengan deskripsi, tetapi disertakan untuk menunjukkan bahwa Anda dapat menerjemahkan ringkasan (deskripsi singkat satu kalimat tentang mod) secara terpisah dari deskripsi, bahkan dalam bahasa Inggris!

API Metadata Fabric

Ada sejumlah hal yang dapat Anda tambahkan hanya dengan metadata di fabric.mod.json Anda.

Semua ini ditambahkan ke blok khusus di fabric.mod.json Anda untuk metadata Mod Menu. Berikut contoh penggunaan banyak fitur yang disediakan API ini:

fabric.mod.json

{ ... "custom": { "modmenu": { "links": { "modmenu.discord": "https://discord.gg/jEGF5fb" }, "badges": [ "library", "deprecated" ], "parent": { "id": "example-api", "name": "Example API", "description": "Modular example library", "icon": "assets/example-api-module-v1/parenticon.png", "badges": [ "library" ] }, "updatechecker": true } } }

Dokumentasi API Metadata Fabric

Lencana ("badges": [ ])

Meskipun lencana Client ditambahkan secara otomatis ke mod yang ditetapkan hanya untuk sisi klien (atur "environment": "client" di fabric.mod.json untuk melakukan ini.), lencana lain seperti lencana Library dan Deprecated memerlukan definisi di sini.

Nilai yang didukung:

• library - harus ditetapkan ke mod yang murni merupakan dependensi untuk mod lain yang tidak boleh ditampilkan kepada pengguna secara default kecuali mereka mengaktifkannya.
• deprecated - harus ditetapkan ke mod yang ada murni karena alasan lama, seperti modul API lama atau semacamnya.

Nilai lainnya akan diabaikan, dan Mod Menu tidak mendukung penambahan lencana Anda sendiri. Anda dapat membuka issue di sini jika Anda memiliki kasus penggunaan yang kuat untuk lencana baru.

Tautan ("links": { })

Objek links memungkinkan penulis mod menambahkan hyperlink khusus di akhir deskripsi mereka. Jika Anda menentukan kontak sources di metadata resmi fabric.mod.json, itu juga akan disertakan di bagian links.

Kunci apa pun di objek links akan disertakan di bagian links, dengan kunci tersebut digunakan sebagai kunci terjemahan. Misalnya, ini:

fabric.mod.json

"custom": { "modmenu": { "links": { "modmenu.discord": "https://discord.gg/jEGF5fb" } } }

akan tampil sebagai tautan dengan teks "Discord", karena "Discord" adalah terjemahan bahasa Inggris dari "modmenu.discord" yang disediakan oleh Mod Menu.

Mod Menu menyediakan beberapa terjemahan default yang dapat digunakan untuk tautan. Daftar lengkapnya dapat dilihat di file bahasa Mod Menu di sini. Semua kunci terjemahan tautan default berbentuk modmenu..

Anda juga dapat menyediakan terjemahan Anda sendiri jika ingin menambahkan tautan khusus. Pastikan untuk menggunakan namespace Anda sendiri (bukan modmenu) untuk kunci khusus apa pun.

Induk ("parent": "modid" atau { })

Induk digunakan untuk menampilkan mod sebagai anak dari mod lain. Ini dimaksudkan untuk digunakan pada mod yang dibagi menjadi beberapa modul berbeda. Elemen berikut di fabric.mod.json akan mendefinisikan mod sebagai anak dari mod 'flamingo':

fabric.mod.json

"custom": { "modmenu": { "parent": "flamingo" } }

Namun, jika Anda ingin mengelompokkan mod di bawah induk, tetapi induk tersebut bukan mod yang sebenarnya, Anda juga dapat melakukannya. Pada contoh di bawah, sebuah mod mendefinisikan metadata untuk induk. Pastikan metadata ini disertakan di semua anak yang menggunakan induk palsu/dummy tersebut. Ini juga dapat digunakan sebagai cadangan untuk induk opsional, ini akan digantikan oleh metadata asli mod jika ada.

fabric.mod.json

"custom": { "modmenu": { "parent": { "id": "this-mod-isnt-real", "name": "Fake Mod", "description": "Do cool stuff with this fake mod", "icon": "assets/real-mod/fake-mod-icon.png", "badges": [ "library" ] } } }

Mod induk dummy hanya mendukung metadata berikut:

• id (String)
• name (String)
• description (String)
• icon (String)
• badges (Array of Strings)

Nonaktifkan pemeriksa pembaruan ("updatechecker": false)

Secara default, pemeriksa pembaruan Mod Menu akan menggunakan hash jar mod Anda untuk mencari versi terbaru di Modrinth. Jika menemukan proyek yang cocok, ia akan memeriksa versi terbaru yang mendukung mod loader dan versi Minecraft Anda, dan jika hash-nya berbeda dari file Anda yang ada, ia akan memberi tahu pengguna bahwa ada pembaruan yang tersedia.

Anda dapat menonaktifkan pemeriksa pembaruan dengan mengatur updatechecker ke false di metadata Mod Menu Anda seperti ini:

fabric.mod.json

"custom": { "modmenu": { "updatechecker": false } }

API Metadata Quilt

Karena Mod Menu juga mendukung Quilt, API yang sama di bagian API Metadata Fabric juga tersedia untuk mod Quilt, tetapi format untuk metadata khusus sedikit berbeda.

Alih-alih blok "modmenu" di dalam blok "custom", Anda menempatkan blok "modmenu" sebagai elemen di objek root. Jadi seharusnya terlihat seperti:

quilt.mod.json

{ ... "modmenu": { // Di sinilah tautan, lencana, dll. Anda diletakkan } }

API Java

Untuk menggunakan API Java, Anda perlu menambahkan Mod Menu sebagai dependensi waktu kompilasi di proyek gradle Anda. Ini tidak akan membuat mod Anda memerlukan Mod Menu, tetapi akan tersedia di lingkungan Anda untuk Anda uji.

build.gradle

// Add the Terraformers maven repo to your repositories block repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } }

// Add Mod Menu as a dependency in your environment dependencies { // Prior to Minecraft 26.x, use "modImplementation" instead implementation("com.terraformersmc:modmenu:${project.modmenuversion}") }

Kemudian, tentukan versi Mod Menu yang Anda gunakan di gradle.properties Anda. Anda bisa mendapatkan nomor versi terbaru di sini, tetapi Anda mungkin memerlukan versi yang berbeda jika Anda tidak menggunakan versi Minecraft terbaru. Lihat halaman versi untuk daftar lengkap versi.

gradle.properties

modmenuversion=VERSIONNUMBERHERE

Jika Anda tidak menginginkannya di lingkungan Anda untuk pengujian tetapi tetap ingin mengompilasi terhadap Mod Menu untuk menggunakan API Java, Anda dapat menggunakan modCompileOnly alih-alih modImplementation (ini akan berfungsi bahkan jika Mod Menu belum diperbarui ke versi Minecraft yang Anda jalankan).

Dokumentasi API Java

Memulai

Untuk menggunakan API, implementasikan antarmuka ModMenuApi pada sebuah kelas dan tambahkan itu sebagai entry point bertipe "modmenu" di fabric.mod.json Anda seperti ini:

fabric.mod.json

"entrypoints": { "modmenu": [ "com.example.mod.ExampleModMenuApiImpl" ] }

Layar Konfigurasi Mod

Mod dapat menyediakan factory Screen untuk menyediakan layar konfigurasi khusus yang dibuka dengan tombol konfigurasi. Implementasikan metode getModConfigScreenFactory di implementasi API Anda untuk melakukan ini.

Kasus penggunaan yang dimaksudkan untuk ini adalah agar mod menyediakan layar konfigurasi mereka sendiri. ID mod dari layar konfigurasi ditentukan secara otomatis oleh kontainer mod sumber tempat entry point berasal.

Layar Konfigurasi yang Disediakan

Mod dapat menyediakan factory Screen untuk menyediakan layar konfigurasi khusus yang dibuka dengan tombol konfigurasi untuk mod lain juga. Implementasikan metode getProvidedConfigScreenFactories di implementasi API Anda untuk ini.

Kasus penggunaan yang dimaksudkan untuk ini adalah agar mod seperti Cloth Config menyediakan layar konfigurasi untuk mod yang menggunakan API-nya.

Lencana Modpack

Mod dapat memberikan lencana Modpack kepada mod lain dengan mengimplementasikan metode attachModpackBadges, seperti melalui berikut:

@Override public void attachModpackBadges(Consumer consumer) { consumer.accept("modmenu"); // Indicates that 'modmenu' is part of the modpack }

Perhatikan bahwa mod 'internal' seperti Minecraft itu sendiri dan mod loader tidak dapat diberikan lencana modpack, karena mereka tidak didistribusikan dalam modpack pada umumnya.

Metode Helper Statis

ModMenuApi juga menawarkan beberapa metode helper untuk mod yang ingin bekerja lebih baik dengan Mod Menu, seperti membuat tombol Mods mereka sendiri.

Membuat instance layar Mods

Anda dapat memanggil metode ini untuk mendapatkan instance layar Mods:

Screen createModsScreen(Screen previous)

Membuat Text tombol Mods

Anda dapat memanggil metode ini untuk mendapatkan Text yang akan ditampilkan pada tombol Mods Mod Menu:

Text createModsButtonText()