Minecraft 1.20.1, 1.21.1 için Mod Menu

Mod Menüsü

Mod Menüsü, yüklü olduğunuz modları görüntülemenizi sağlar ve mod tarafından destekleniyorsa modun yapılandırma ekranlarına hızlı ve kolay erişim sağlar.

Mod Menüsü ayrıca çevrilebilir mod adları ve açıklamaları, Patbox'un Text Placeholder API'si sayesinde mod açıklamalarında QuickText biçimlendirme desteği, kitaplık modlarını normal modlardan filtreleme, Modrinth'te barındırılan veya kendi güncelleme kaynaklarını sağlayan modlar için bir mod güncelleme denetleyicisi ve sunduğumuz tüm özellikler için derin yapılandırma gibi bazı daha gelişmiş özellikleri destekler.

Desteklenen Platformlar

Mod Menüsü şu anda Minecraft: Java Edition 1.14 veya daha yeni sürümlerde Fabric veya Quilt için mevcuttur.

Geliştiriciler

Mod Menüsü, geliştiricilerin modlarının Mod Menüsü'nde nasıl göründüğünü iyileştirmeleri için bir dizi API içerir. Bunlar dil anahtarları, JSON meta verileri ve hatta bir Java API'si biçiminde gelir.

Çeviri API'si

Modunuzun adını, özetini ve açıklamasını herhangi bir Java koduna dokunmadan çevirebilirsiniz. İstediğiniz herhangi bir dile desteklenen biçimde çeviri anahtarları eklemeniz yeterlidir.

Çeviri API'si Belgeleri

İşte Mod Menüsü'nün Korsan Dili'ne çevirilerinden bir örnek. Kendi çevirinizi oluşturmak için, çeviri anahtarının sonundaki modmenu'yü (başındakini DEĞİL) kendi mod kimliğinizle değiştirmeniz yeterlidir, örneğin 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!"

Özet çevirisi burada gereksizdir ve açıklamayla aynı olduğu için eklenmesine gerek yoktur, ancak özeti (modun kısa, tek cümlelik açıklaması) açıklamadan ayrı olarak, hatta İngilizce olarak bile çevirebileceğinizi göstermek için eklenmiştir!

Fabric Meta Veri API'si

fabric.mod.json dosyanızdaki meta verilerle yalnızca bir dizi şey ekleyebilirsiniz.

Bunların tümü, Mod Menüsü'nün meta verileri için fabric.mod.json dosyanızdaki özel bir bloğa eklenir. İşte bu API'nin sağladığı özelliklerin çoğunun örnek bir kullanımı:

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

Fabric Meta Veri API'si Belgeleri

Rozetler ("badges": [ ])

İstemci rozeti, yalnızca istemci tarafı olarak ayarlanan modlara otomatik olarak eklenirken (bunu yapmak için fabric.mod.json dosyasında "environment": "client" ayarlayın), Kitaplık ve Kullanımdan Kaldırıldı gibi diğer rozetler burada tanımlanmayı gerektirir.

Desteklenen değerler:

• library - yalnızca diğer modlar için bağımlılık olan ve kullanıcı tarafından varsayılan olarak etkinleştirilmedikçe gösterilmemesi gereken modlara atanmalıdır.
• deprecated - yalnızca eski nedenlerle var olan modlara atanmalıdır, örneğin eski bir API modülü gibi.

Diğerleri yok sayılacaktır ve Mod Menüsü kendi rozetlerinizi eklemeyi desteklemez. Yeni bir rozet için zorlayıcı bir kullanım durumunuz varsa buradan bir sorun açabilirsiniz.

Bağlantılar ("links": { })

links nesnesi, mod yazarlarının açıklamalarının sonuna özel köprüler eklemesine olanak tanır. Resmi fabric.mod.json meta verilerinde bir sources iletişimi belirtirseniz, bu da bağlantılar bölümüne dahil edilir.

links nesnesindeki herhangi bir anahtar, anahtar çeviri anahtarı olarak kullanılarak bağlantılar bölümüne dahil edilir. Örneğin, bu:

fabric.mod.json

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

"Discord" metniyle bir bağlantı olarak görünecektir, çünkü "Discord", Mod Menüsü tarafından sağlanan "modmenu.discord" ifadesinin İngilizce çevirisidir.

Mod Menüsü, bağlantılar için kullanılabilecek birkaç varsayılan çeviri sağlar. Tam liste Mod Menüsü'nün dil dosyasında burada görülebilir. Tüm varsayılan bağlantı çeviri anahtarları modmenu. biçimini alır.

Özel bağlantılar eklemek isterseniz kendi çevirilerinizi de sağlayabilirsiniz. Herhangi bir özel anahtar için kendi ad alanınızı (modmenu yerine) kullandığınızdan emin olun.

Üst Öğeler ("parent": "modid" veya { })

Üst öğeler, bir modu başka bir modun alt öğesi olarak görüntülemek için kullanılır. Bu, farklı modüllere ayrılmış modlar için kullanılmak üzere tasarlanmıştır. fabric.mod.json dosyasındaki aşağıdaki öğe, modu 'flamingo' modunun alt öğesi olarak tanımlayacaktır:

fabric.mod.json

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

Ancak, modları bir üst öğe altında gruplamak istiyorsanız, ancak üst öğe gerçek bir mod değilse, bunu da yapabilirsiniz. Aşağıdaki örnekte, bir mod bir üst öğe için meta veri tanımlıyor. Bu meta verilerin sahte/kukla üst öğeyi kullanan tüm alt öğelere dahil edildiğinden emin olun. Bu aynı zamanda isteğe bağlı bir üst öğe için yedek olarak da kullanılabilir, varsa modun gerçek meta verileriyle değiştirilecektir.

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

Kukla üst öğe modları yalnızca aşağıdaki meta verileri destekler:

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

Güncelleme denetleyicisini devre dışı bırak ("updatechecker": false)

Varsayılan olarak, Mod Menüsü'nün güncelleme denetleyicisi, Modrinth'teki en son sürümü aramak için modunuzun jar dosyasının karmasını kullanır. Eşleşen bir proje bulursa, mod yükleyicinizi ve Minecraft sürümünüzü destekleyen en son sürümü kontrol eder ve mevcut dosyanızdan farklı bir karmaya sahipse kullanıcıya bir güncelleme olduğunu bildirir.

Güncelleme denetleyicisini, Mod Menüsü meta verilerinizde updatechecker'ı false olarak ayarlayarak şu şekilde devre dışı bırakabilirsiniz:

fabric.mod.json

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

Quilt Meta Veri API'si

Mod Menüsü Quilt'i de desteklediğinden, Fabric Meta Veri API'si bölümündeki aynı API'ler Quilt modları için de mevcuttur, ancak özel meta verilerin biçimi biraz farklıdır.

Bir "custom" bloğunun içindeki "modmenu" bloğu yerine, "modmenu" bloğunu kök nesnede bir öğe olarak koyarsınız. Yani şöyle görünmelidir:

quilt.mod.json

{ ... "modmenu": { // Bağlantılarınızın, rozetlerinizin vb. şeylerinizin olduğu yer burasıdır } }

Java API'si

Java API'sini kullanmak için, Mod Menüsü'nü gradle projenize derleme zamanı bağımlılığı olarak eklemeniz gerekir. Bu, modunuzun Mod Menüsü'nü gerektirmesini sağlamaz, ancak test etmeniz için ortamınızda bulunur.

build.gradle

// Terraformers maven deposunu repositories bloğunuza ekleyin repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } }

// Mod Menüsü'nü ortamınıza bağımlılık olarak ekleyin dependencies { // Minecraft 26.x'ten önce "modImplementation" yerine bunu kullanın implementation("com.terraformersmc:modmenu:${project.modmenuversion}") }

Ardından, gradle.properties dosyanızda kullandığınız Mod Menüsü sürümünü tanımlayın. En son sürüm numarasını buradan alabilirsiniz, ancak en son Minecraft sürümünü kullanmıyorsanız farklı bir sürüme ihtiyacınız olabilir. Tam sürüm listesi için sürümler sayfasına bakın.

gradle.properties

modmenuversion=VERSIONNUMBERHERE

Test için ortamınızda istemiyorsanız ancak Java API'sini kullanmak için yine de Mod Menüsü'ne karşı derlemek istiyorsanız, modImplementation yerine modCompileOnly kullanabilirsiniz (bu, Mod Menüsü çalıştırdığınız Minecraft sürümüne güncellenmemiş olsa bile çalışır).

Java API'si Belgeleri

Başlarken

API'yi kullanmak için, bir sınıfta ModMenuApi arabirimini uygulayın ve bunu fabric.mod.json dosyanızda "modmenu" türünde bir giriş noktası olarak şu şekilde ekleyin:

fabric.mod.json

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

Mod Yapılandırma Ekranları

Modlar, yapılandırma düğmesiyle açılacak özel bir yapılandırma ekranı sağlamak için bir Screen fabrikası sağlayabilir. Bunu yapmak için API uygulamanızda getModConfigScreenFactory yöntemini uygulayın.

Bunun amaçlanan kullanım durumu, modların kendi yapılandırma ekranlarını sağlamasıdır. Yapılandırma ekranının mod kimliği, giriş noktasının kaynaklandığı kaynak mod kapsayıcısı tarafından otomatik olarak belirlenir.

Sağlanan Yapılandırma Ekranları

Modlar, diğer modlar için de yapılandırma düğmeleriyle açılacak özel yapılandırma ekranları sağlamak üzere Screen fabrikaları sağlayabilir. Bunun için API uygulamanızda getProvidedConfigScreenFactories yöntemini uygulayın.

Bunun amaçlanan kullanım durumu, Cloth Config gibi bir modun API'sini kullanan modlar için yapılandırma ekranları sağlamasıdır.

Modpaketi Rozetleri

Modlar, attachModpackBadges yöntemini uygulayarak diğer modlara Modpaketi rozetini verebilir, örneğin aşağıdaki gibi:

@Override public void attachModpackBadges(Consumer consumer) { consumer.accept("modmenu"); // 'modmenu'nün modpaketinin bir parçası olduğunu belirtir }

Minecraft'ın kendisi ve mod yükleyici gibi 'dahili' modlara modpaketi rozetinin verilemeyeceğini unutmayın, çünkü bunlar tipik bir modpaketi içinde dağıtılmaz.

Statik Yardımcı Yöntemler

ModMenuApi ayrıca, Mod Menüsü ile daha iyi çalışmak isteyen modlar için, kendi Modlar düğmelerini oluşturmak gibi birkaç yardımcı yöntem sunar.

Bir Modlar ekranı örneği oluşturma

Modlar ekranının bir örneğini almak için bu yöntemi çağırabilirsiniz:

Screen createModsScreen(Screen previous)

Bir Modlar düğmesi Metni oluşturma

Bir Mod Menüsü Modlar düğmesinde görüntülenecek Metni almak için bu yöntemi çağırabilirsiniz:

Text createModsButtonText()