Minecraft 1.20.1, 1.21.1 کے لیے Mod Menu

موڈ مینو

موڈ مینو آپ کو یہ دیکھنے دیتا ہے کہ آپ نے کون سے موڈز انسٹال کیے ہیں اور، اگر موڈ کی طرف سے سپورٹ ہو، تو موڈ کے کنفگ اسکرینوں تک فوری اور آسان رسائی ممکن بناتا ہے۔

موڈ مینو کچھ مزید جدید خصوصیات بھی سپورٹ کرتا ہے، جیسے قابل ترجمہ موڈ نام اور تفصیلات، Patbox کی Text Placeholder API کی بدولت موڈ تفصیلات میں QuickText فارمیٹنگ کی سپورٹ، لائبریری موڈز کو عام موڈز سے الگ کرنا، Modrinth پر ہوسٹ کیے گئے یا اپنے اپڈیٹ ذرائع فراہم کرنے والے موڈز کے لیے موڈ اپڈیٹ چیکر، اور ہماری فراہم کردہ تمام خصوصیات کے لیے گہری کنفیگریشن۔

سپورٹ شدہ پلیٹ فارمز

موڈ مینو فی الحال Minecraft: Java Edition 1.14 یا اس سے نئے ورژن پر Fabric یا Quilt کے لیے دستیاب ہے۔

ڈویلپرز

موڈ مینو ڈویلپرز کے لیے متعدد APIs شامل کرتا ہے تاکہ وہ بہتر بنا سکیں کہ ان کا موڈ موڈ مینو میں کیسا دکھائی دیتا ہے۔ یہ زبان کی کلیدوں، JSON میٹاڈیٹا، اور یہاں تک کہ ایک Java API کی شکل میں آتے ہیں۔

ترجمہ API

آپ اپنے موڈ کا نام، خلاصہ اور تفصیل بغیر کسی Java کوڈ کو چھوئے ترجمہ کر سکتے ہیں۔ بس سپورٹ شدہ فارمیٹ میں ترجمہ کی کلیدیں کسی بھی زبان میں شامل کریں جو آپ چاہیں۔

ترجمہ API دستاویزات

یہاں Pirate Speak میں موڈ مینو کے تراجم کی ایک مثال ہے۔ اپنے بنانے کے لیے، بس ترجمہ کلید کے آخر میں modmenu (شروع والا نہیں) کو اپنے موڈ ID سے بدل دیں، مثلاً 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!"

خلاصے کا ترجمہ یہاں زائد ہے اور اسے شامل کرنے کی ضرورت نہیں کیونکہ یہ تفصیل جیسا ہی ہے، لیکن اسے اس لیے شامل کیا گیا تاکہ دکھایا جائے کہ آپ خلاصے (موڈ کی ایک مختصر، ایک جملے کی تفصیل) کا ترجمہ تفصیل سے الگ کر سکتے ہیں، یہاں تک کہ انگریزی میں بھی!

Fabric میٹاڈیٹا API

بہت سی چیزیں ہیں جو آپ صرف اپنے fabric.mod.json میں میٹاڈیٹا کے ذریعے شامل کر سکتے ہیں۔

یہ سب آپ کے fabric.mod.json میں موڈ مینو کے میٹاڈیٹا کے لیے ایک کسٹم بلاک میں شامل کیے جاتے ہیں۔ یہاں اس API کی فراہم کردہ بہت سی خصوصیات کے استعمال کی ایک مثال ہے:

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 میٹاڈیٹا API دستاویزات

بیجز ("badges": [ ])

اگرچہ Client بیج خود بخود ان موڈز میں شامل ہو جاتا ہے جو صرف کلائنٹ سائیڈ کے طور پر سیٹ ہوں (ایسا کرنے کے لیے fabric.mod.json میں "environment": "client" سیٹ کریں۔)، دیگر بیجز جیسے Library اور Deprecated بیجز کے لیے یہاں تعریف درکار ہے۔

سپورٹ شدہ اقدار:

• library - ان موڈز کو تفویض کیا جانا چاہیے جو خالصتاً دوسرے موڈز کے لیے ڈیپنڈنسی ہوں اور جنہیں بطور ڈیفالٹ صارف کو نہ دکھایا جائے جب تک وہ انہیں آن نہ کریں۔
• deprecated - ان موڈز کو تفویض کیا جانا چاہیے جو خالصتاً پرانی وجوہات کی بنا پر موجود ہوں، جیسے کوئی پرانا API ماڈیول وغیرہ۔

کوئی بھی دیگر نظر انداز کر دیے جائیں گے، اور موڈ مینو اپنے بیجز شامل کرنے کی سپورٹ نہیں کرتا۔ اگر آپ کے پاس نئے بیج کے لیے کوئی مضبوط استعمال کی صورت ہو تو آپ یہاں ایشو کھول سکتے ہیں۔

لنکس ("links": { })

links آبجیکٹ موڈ مصنفین کو اجازت دیتا ہے کہ وہ اپنی تفصیل کے آخر میں کسٹم ہائپر لنکس شامل کریں۔ اگر آپ سرکاری fabric.mod.json میٹاڈیٹا میں sources کانٹیکٹ متعین کریں، تو یہ بھی لنکس سیکشن میں شامل ہو جائے گا۔

links آبجیکٹ میں کوئی بھی کلید لنکس سیکشن میں شامل ہو گی، اور کلید کو ترجمہ کلید کے طور پر استعمال کیا جائے گا۔ مثال کے طور پر، یہ:

fabric.mod.json

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

"Discord" متن کے ساتھ ایک لنک کے طور پر دکھائی دے گا، کیونکہ "Discord" موڈ مینو کی فراہم کردہ "modmenu.discord" کا انگریزی ترجمہ ہے۔

موڈ مینو کئی ڈیفالٹ تراجم فراہم کرتا ہے جو لنکس کے لیے استعمال ہو سکتے ہیں۔ مکمل فہرست موڈ مینو کی زبان فائل میں یہاں دیکھی جا سکتی ہے۔ تمام ڈیفالٹ لنک ترجمہ کلیدیں modmenu. کی شکل میں ہوتی ہیں۔

اگر آپ کسٹم لنکس شامل کرنا چاہیں تو آپ اپنے تراجم بھی فراہم کر سکتے ہیں۔ کسی بھی کسٹم کلید کے لیے اپنا نام کی جگہ (modmenu کے برعکس) استعمال کرنا یقینی بنائیں۔

پیرنٹس ("parent": "modid" یا { })

پیرنٹس کا استعمال کسی موڈ کو دوسرے کی ذیلی کے طور پر دکھانے کے لیے کیا جاتا ہے۔ یہ ان موڈز کے لیے ہے جو مختلف ماڈیولز میں تقسیم ہوں۔ fabric.mod.json میں درج ذیل عنصر موڈ کو 'flamingo' موڈ کی ذیلی کے طور پر متعین کرے گا:

fabric.mod.json

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

تاہم، اگر آپ موڈز کو کسی پیرنٹ کے تحت گروپ کرنا چاہتے ہیں، لیکن پیرنٹ کوئی حقیقی موڈ نہیں ہے، تو آپ یہ بھی کر سکتے ہیں۔ نیچے کی مثال میں، ایک موڈ ایک پیرنٹ کے لیے میٹاڈیٹا متعین کر رہا ہے۔ یقینی بنائیں کہ یہ میٹاڈیٹا ان تمام ذیلیوں میں شامل ہو جو فرضی/ڈمی پیرنٹ استعمال کرتے ہیں۔ یہ ایک اختیاری پیرنٹ کے لیے فال بیک کے طور پر بھی استعمال ہو سکتا ہے، اگر موجود ہو تو اسے موڈ کے اصل میٹاڈیٹا سے بدل دیا جائے گا۔

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

ڈمی پیرنٹ موڈز صرف درج ذیل میٹاڈیٹا کو سپورٹ کرتے ہیں:

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

اپڈیٹ چیکر غیر فعال کریں ("updatechecker": false)

بطور ڈیفالٹ، موڈ مینو کا اپڈیٹ چیکر Modrinth پر تازہ ترین ورژن تلاش کرنے کے لیے آپ کے موڈ کے jar کا ہیش استعمال کرے گا۔ اگر اسے کوئی مماثل پروجیکٹ ملتا ہے، تو یہ تازہ ترین ورژن چیک کرے گا جو آپ کے موڈ لوڈر اور Minecraft ورژن کو سپورٹ کرتا ہو، اور اگر اس کا ہیش آپ کی موجودہ فائل سے مختلف ہو، تو یہ صارف کو بتائے گا کہ اپڈیٹ دستیاب ہے۔

آپ اپنے موڈ مینو میٹاڈیٹا میں updatechecker کو false سیٹ کر کے اپڈیٹ چیکر غیر فعال کر سکتے ہیں، اس طرح:

fabric.mod.json

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

Quilt میٹاڈیٹا API

چونکہ موڈ مینو Quilt کو بھی سپورٹ کرتا ہے، Fabric میٹاڈیٹا API سیکشن میں موجود وہی APIs Quilt موڈز کے لیے بھی دستیاب ہیں، لیکن کسٹم میٹاڈیٹا کا فارمیٹ تھوڑا مختلف ہے۔

"custom" بلاک کے اندر "modmenu" بلاک کے بجائے، آپ "modmenu" بلاک کو روٹ آبجیکٹ میں ایک عنصر کے طور پر رکھتے ہیں۔ تو یہ اس طرح دکھائی دینا چاہیے:

quilt.mod.json

{ ... "modmenu": { // Here's where your links, badges, etc. stuff goes } }

Java API

Java API استعمال کرنے کے لیے، آپ کو اپنے gradle پروجیکٹ میں موڈ مینو کو کمپائل ٹائم ڈیپنڈنسی کے طور پر شامل کرنا ہوگا۔ یہ آپ کے موڈ کو موڈ مینو کا محتاج نہیں بنائے گا، لیکن یہ آپ کے ماحول میں ٹیسٹ کرنے کے لیے موجود ہوگا۔

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

پھر، اپنے gradle.properties میں موڈ مینو کا وہ ورژن متعین کریں جو آپ استعمال کر رہے ہیں۔ آپ تازہ ترین ورژن نمبر یہاں سے حاصل کر سکتے ہیں، لیکن اگر آپ تازہ ترین Minecraft ورژن استعمال نہیں کر رہے تو آپ کو مختلف ورژن درکار ہو سکتا ہے۔ ورژنز کی مکمل فہرست کے لیے ورژنز صفحہ دیکھیں۔

gradle.properties

modmenuversion=VERSIONNUMBERHERE

اگر آپ اسے ٹیسٹنگ کے لیے اپنے ماحول میں نہیں چاہتے لیکن پھر بھی Java API استعمال کرنے کے لیے موڈ مینو کے خلاف کمپائل کرنا چاہتے ہیں، تو آپ modImplementation کے بجائے modCompileOnly استعمال کر سکتے ہیں (یہ کام کرے گا چاہے موڈ مینو آپ کے چلائے جانے والے Minecraft ورژن تک اپڈیٹ نہ ہو)۔

Java API دستاویزات

شروعات

API استعمال کرنے کے لیے، ایک کلاس پر ModMenuApi انٹرفیس نافذ کریں اور اسے اپنے fabric.mod.json میں "modmenu" قسم کے انٹری پوائنٹ کے طور پر شامل کریں، اس طرح:

fabric.mod.json

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

موڈ کنفگ اسکرینیں

موڈز کنفگ بٹن کے ساتھ کھولنے کے لیے کسٹم کنفگ اسکرین فراہم کرنے کے لیے ایک Screen فیکٹری فراہم کر سکتے ہیں۔ ایسا کرنے کے لیے اپنے API نفاذ میں getModConfigScreenFactory طریقہ نافذ کریں۔

اس کا مطلوبہ استعمال یہ ہے کہ موڈز اپنی کنفگ اسکرینیں فراہم کریں۔ کنفگ اسکرین کا موڈ id خود بخود اس سورس موڈ کنٹینر سے متعین ہو جاتا ہے جہاں سے انٹری پوائنٹ آیا تھا۔

فراہم کردہ کنفگ اسکرینیں

موڈز Screen فیکٹریاں فراہم کر سکتے ہیں تاکہ دوسرے موڈز کے کنفگ بٹنوں کے ساتھ کھولنے کے لیے کسٹم کنفگ اسکرینیں فراہم کی جا سکیں۔ اس کے لیے اپنے API نفاذ میں getProvidedConfigScreenFactories طریقہ نافذ کریں۔

اس کا مطلوبہ استعمال یہ ہے کہ Cloth Config جیسا موڈ ان موڈز کے لیے کنفگ اسکرینیں فراہم کرے جو اس کی API استعمال کرتے ہیں۔

موڈپیک بیجز

موڈز دوسرے موڈز کو Modpack بیج attachModpackBadges طریقہ نافذ کر کے دے سکتے ہیں، جیسے درج ذیل کے ذریعے:

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

نوٹ کریں کہ 'internal' موڈز جیسے Minecraft خود اور موڈ لوڈر کو موڈپیک بیج نہیں دیا جا سکتا، کیونکہ وہ عام موڈپیک میں تقسیم نہیں کیے جاتے۔

اسٹیٹک ہیلپر طریقے

ModMenuApi ان موڈز کے لیے چند ہیلپر طریقے بھی پیش کرتا ہے جو موڈ مینو کے ساتھ بہتر کام کرنا چاہتے ہیں، جیسے اپنے Mods بٹن بنانا۔

Mods اسکرین کی ایک مثال بنانا

Mods اسکرین کی ایک مثال حاصل کرنے کے لیے آپ یہ طریقہ کال کر سکتے ہیں:

Screen createModsScreen(Screen previous)

Mods بٹن Text بنانا

Mod Menu Mods بٹن پر دکھائے جانے والے Text کو حاصل کرنے کے لیے آپ یہ طریقہ کال کر سکتے ہیں:

Text createModsButtonText()