Mod Menu za Minecraft 1.20.1, 1.21.1

Mod meni

Mod meni vam omogućava da vidite modove koje ste instalirali i, ako mod to podržava, omogućava brz i jednostavan pristup ekranima za konfiguraciju moda.

Mod meni takođe podržava neke naprednije funkcije, kao što su prevodiva imena i opisi modova, podrška za QuickText formatiranje u opisima modova zahvaljujući Patbox-ovom Text Placeholder API-ju, filtriranje bibliotečkih modova iz redovnih modova, proveru ažuriranja za modove hostovane na Modrinth-u ili one koji pružaju sopstvene izvore ažuriranja, i dubinsku konfiguraciju za sve funkcije koje pružamo.

Podržane platforme

Mod meni je trenutno dostupan za Fabric ili Quilt na Minecraft: Java Edition 1.14 ili novijim verzijama.

Programeri

Mod meni uključuje brojne API-je za programere kako bi poboljšali kako se njihov mod prikazuje u Mod meniju. Oni dolaze u obliku jezičkih ključeva, JSON metapodataka, pa čak i Java API-ja.

API za prevod

Možete prevesti ime, sažetak i opis svog moda bez ikakvog dodirivanja Java koda. Jednostavno dodajte ključeve prevoda u podržanom formatu na bilo koji jezik koji želite.

Dokumentacija API-ja za prevod

Evo primera prevoda Mod menija na Pirate Speak. Da biste napravili svoj, jednostavno zamenite modmenu na kraju (NE onaj na početku) ključa prevoda svojim ID-om moda, na primer 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!"

Prevod sažetka je ovde suvišan i ne mora se uključiti jer je isti kao opis, ali je uključen da pokaže da možete prevesti sažetak (kratak opis moda u jednoj rečenici) odvojeno od opisa, čak i na engleskom!

Fabric API za metapodatke

Postoji niz stvari koje možete dodati samo pomoću metapodataka u vašem fabric.mod.json.

Sve ove se dodaju u prilagođeni blok u vašem fabric.mod.json za metapodatke Mod menija. Evo primera upotrebe mnogih funkcija koje ovaj API pruža:

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 } } }

Dokumentacija Fabric API-ja za metapodatke

Značke ("badges": [ ])

Dok se značka Client automatski dodaje modovima koji su postavljeni kao samo za klijentsku stranu (postavite "environment": "client" u fabric.mod.json da biste to uradili.), druge značke kao što su Library i Deprecated zahtevaju definisanje ovde.

Podržane vrednosti:

• library - treba dodeliti modovima koji su isključivo zavisnosti za druge modove i koji ne bi trebalo da se prikazuju korisniku podrazumevano osim ako ih ne uključi.
• deprecated - treba dodeliti modovima koji postoje isključivo iz nasleđenih razloga, kao što je stari API modul ili slično.

Sve ostale će biti ignorisane, a Mod meni ne podržava dodavanje sopstvenih znački. Možete otvoriti issue ovde ako imate ubedljiv slučaj upotrebe za novu značku.

Linkovi ("links": { })

Objekat links omogućava autorima modova da dodaju prilagođene hiperveze na kraj svog opisa. Ako navedete sources kontakt u zvaničnim metapodacima fabric.mod.json, on će takođe biti uključen u sekciju linkova.

Svaki ključ u objektu links biće uključen u sekciju linkova, a ključ će se koristiti kao ključ prevoda. Na primer, ovo:

fabric.mod.json

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

prikazaće se kao link sa tekstom "Discord", jer je "Discord" engleski prevod za "modmenu.discord" koji pruža Mod meni.

Mod meni pruža nekoliko podrazumevanih prevoda koji se mogu koristiti za linkove. Kompletna lista se može videti u jezičkom fajlu Mod menija ovde. Svi podrazumevani ključevi prevoda za linkove imaju oblik modmenu..

Takođe možete pružiti sopstvene prevode ako želite da dodate prilagođene linkove. Obavezno koristite sopstveni namespace (za razliku od modmenu) za sve prilagođene ključeve.

Roditelji ("parent": "modid" ili { })

Roditelji se koriste za prikazivanje moda kao deteta drugog moda. Ovo je namenjeno za modove podeljene na različite module. Sledeći element u fabric.mod.json definisaće mod kao dete moda 'flamingo':

fabric.mod.json

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

Međutim, ako želite da grupišete modove pod roditeljem, ali roditelj nije stvarni mod, to takođe možete uraditi. U primeru ispod, mod definiše metapodatke za roditelja. Uverite se da su ovi metapodaci uključeni u sve potomke koji koriste lažnog/nepravog roditelja. Ovo se takođe može koristiti kao rezerva za opcionalnog roditelja, biće zamenjeno stvarnim metapodacima moda ako su prisutni.

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" ] } } }

Nepravi roditeljski modovi podržavaju samo sledeće metapodatke:

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

Onemogući proveru ažuriranja ("updatechecker": false)

Podrazumevano, provera ažuriranja Mod menija koristiće hash vašeg moda jar da pronađe najnoviju verziju na Modrinth-u. Ako pronađe odgovarajući projekat, proveriće najnoviju verziju koja podržava vaš mod loader i Minecraft verziju, i ako ima drugačiji hash od vašeg postojećeg fajla, obavestiće korisnika da je dostupno ažuriranje.

Možete onemogućiti proveru ažuriranja postavljanjem updatechecker na false u vašim metapodacima Mod menija ovako:

fabric.mod.json

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

Quilt API za metapodatke

Pošto Mod meni podržava i Quilt, isti API-ji iz sekcije Fabric API za metapodatke su takođe dostupni za Quilt modove, ali je format za prilagođene metapodatke malo drugačiji.

Umesto bloka "modmenu" unutar bloka "custom", stavljate blok "modmenu" kao element u korenski objekat. Dakle, trebalo bi da izgleda ovako:

quilt.mod.json

{ ... "modmenu": { // Ovde idu vaši linkovi, značke, itd. } }

Java API

Da biste koristili Java API, moraćete da dodate Mod meni kao zavisnost u vreme kompajliranja u vašem gradle projektu. Ovo neće učiniti da vaš mod zahteva Mod meni, ali će biti prisutan u vašem okruženju za testiranje.

build.gradle

// Dodajte Terraformers maven repo u vaš blok repositories repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } }

// Dodajte Mod meni kao zavisnost u vaše okruženje dependencies { // Pre Minecraft 26.x, koristite "modImplementation" umesto toga implementation("com.terraformersmc:modmenu:${project.modmenuversion}") }

Zatim, definišite verziju Mod menija koju koristite u vašem gradle.properties. Najnoviji broj verzije možete dobiti ovde, ali možda će vam trebati drugačija verzija ako ne koristite najnoviju Minecraft verziju. Pogledajte stranicu verzija za kompletnu listu verzija.

gradle.properties

modmenuversion=VERSIONNUMBERHERE

Ako ne želite da bude u vašem okruženju za testiranje, ali i dalje želite da kompajlirate uz Mod meni za korišćenje Java API-ja, možete koristiti modCompileOnly umesto modImplementation (ovo će raditi čak i ako Mod meni nije ažuriran na verziju Minecraft-a koju pokrećete).

Dokumentacija Java API-ja

Početak rada

Da biste koristili API, implementirajte ModMenuApi interfejs na klasi i dodajte je kao ulaznu tačku tipa "modmenu" u vašem fabric.mod.json ovako:

fabric.mod.json

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

Ekrani za konfiguraciju moda

Modovi mogu pružiti Screen fabriku za pružanje prilagođenog ekrana za konfiguraciju koji se otvara pomoću dugmeta za konfiguraciju. Implementirajte metodu getModConfigScreenFactory u vašoj implementaciji API-ja da biste to uradili.

Namena ovoga je da modovi pruže sopstvene ekrane za konfiguraciju. ID moda ekrana za konfiguraciju se automatski određuje od strane izvornog kontejnera moda iz kojeg je ulazna tačka potekla.

Pruženi ekrani za konfiguraciju

Modovi mogu pružiti Screen fabrike za pružanje prilagođenih ekrana za konfiguraciju koji se otvaraju pomoću dugmadi za konfiguraciju i za druge modove. Implementirajte metodu getProvidedConfigScreenFactories u vašoj implementaciji API-ja za ovo.

Namena ovoga je da mod kao što je Cloth Config pruži ekrane za konfiguraciju za modove koji koriste njegov API.

Značke modpack-a

Modovi mogu dati drugim modovima značku Modpack implementiranjem metode attachModpackBadges, kao na primer kroz sledeće:

@Override public void attachModpackBadges(Consumer consumer) { consumer.accept("modmenu"); // Označava da je 'modmenu' deo modpack-a }

Imajte na umu da 'interni' modovi kao što su sam Minecraft i mod loader ne mogu dobiti značku modpack-a, jer se ne distribuiraju unutar tipičnog modpack-a.

Statičke pomoćne metode

ModMenuApi takođe nudi nekoliko pomoćnih metoda za modove koji žele bolje da rade sa Mod menijem, kao što je pravljenje sopstvenih dugmadi Mods.

Kreiranje instance ekrana Mods

Možete pozvati ovu metodu da dobijete instancu ekrana Mods:

Screen createModsScreen(Screen previous)

Kreiranje teksta dugmeta Mods

Možete pozvati ovu metodu da dobijete Text koji bi bio prikazan na dugmetu Mods u Mod meniju:

Text createModsButtonText()