Mod Menu cho Minecraft 1.20.1, 1.21.1

Mod Menu

Mod Menu cho phép bạn xem các mod đã cài đặt và, nếu mod hỗ trợ, mở nhanh và dễ dàng màn hình cấu hình của mod đó.

Mod Menu cũng hỗ trợ một số tính năng nâng cao hơn, như tên và mô tả mod có thể dịch được, hỗ trợ định dạng QuickText trong mô tả mod nhờ Text Placeholder API của Patbox, lọc các mod thư viện ra khỏi mod thông thường, trình kiểm tra cập nhật mod cho các mod được lưu trữ trên Modrinth hoặc tự cung cấp nguồn cập nhật, và cấu hình sâu cho tất cả các tính năng chúng tôi cung cấp.

Nền tảng được hỗ trợ

Mod Menu hiện có sẵn cho Fabric hoặc Quilt trên Minecraft: Java Edition 1.14 trở lên.

Nhà phát triển

Mod Menu bao gồm một số API để nhà phát triển cải thiện cách mod của họ hiển thị trong Mod Menu. Chúng bao gồm các khóa ngôn ngữ, siêu dữ liệu JSON và cả Java API.

API dịch thuật

Bạn có thể dịch tên, tóm tắt và mô tả mod của mình mà không cần chạm vào bất kỳ mã Java nào. Chỉ cần thêm các khóa dịch theo định dạng được hỗ trợ vào bất kỳ ngôn ngữ nào bạn muốn.

Tài liệu API dịch thuật

Đây là ví dụ về bản dịch của Mod Menu sang Pirate Speak. Để tạo bản dịch của riêng bạn, chỉ cần thay thế modmenu ở cuối (KHÔNG phải cái ở đầu) của khóa dịch bằng ID mod của bạn, ví dụ 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!"

Bản dịch tóm tắt ở đây là thừa và không cần đưa vào vì nó giống với mô tả, nhưng nó được đưa vào để cho thấy bạn có thể dịch tóm tắt (mô tả ngắn một câu về mod) riêng biệt với mô tả, kể cả bằng tiếng Anh!

API siêu dữ liệu Fabric

Có một số thứ bạn có thể thêm chỉ với siêu dữ liệu trong fabric.mod.json của mình.

Tất cả những thứ này được thêm vào một khối tùy chỉnh trong fabric.mod.json cho siêu dữ liệu của Mod Menu. Đây là ví dụ sử dụng nhiều tính năng mà API này cung cấp:

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

Tài liệu API siêu dữ liệu Fabric

Huy hiệu ("badges": [ ])

Trong khi huy hiệu Client được tự động thêm vào các mod được đặt là chỉ phía client (đặt "environment": "client" trong fabric.mod.json để làm điều này.), các huy hiệu khác như Library và Deprecated cần được định nghĩa ở đây.

Các giá trị được hỗ trợ:

• library - nên được gán cho các mod thuần túy là phụ thuộc cho các mod khác, không nên hiển thị cho người dùng theo mặc định trừ khi họ bật lên.
• deprecated - nên được gán cho các mod tồn tại thuần túy vì lý do cũ, chẳng hạn như một mô-đun API cũ hay tương tự.

Bất kỳ giá trị nào khác sẽ bị bỏ qua, và Mod Menu không hỗ trợ thêm huy hiệu của riêng bạn. Bạn có thể mở một issue ở đây nếu bạn có trường hợp sử dụng thuyết phục cho một huy hiệu mới.

Liên kết ("links": { })

Đối tượng links cho phép tác giả mod thêm các siêu liên kết tùy chỉnh vào cuối mô tả của họ. Nếu bạn chỉ định liên hệ sources trong siêu dữ liệu fabric.mod.json chính thức, nó cũng sẽ được đưa vào phần liên kết.

Bất kỳ khóa nào trong đối tượng links sẽ được đưa vào phần liên kết, với khóa được dùng làm khóa dịch. Ví dụ, cái này:

fabric.mod.json

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

sẽ hiển thị dưới dạng liên kết với văn bản "Discord", vì "Discord" là bản dịch tiếng Anh của "modmenu.discord" do Mod Menu cung cấp.

Mod Menu cung cấp một số bản dịch mặc định có thể dùng cho liên kết. Danh sách đầy đủ có thể xem trong tệp ngôn ngữ của Mod Menu ở đây. Tất cả các khóa dịch liên kết mặc định đều có dạng modmenu..

Bạn cũng có thể cung cấp bản dịch của riêng mình nếu muốn thêm liên kết tùy chỉnh. Hãy đảm bảo dùng namespace của riêng bạn (thay vì modmenu) cho bất kỳ khóa tùy chỉnh nào.

Parent ("parent": "modid" hoặc { })

Parent được dùng để hiển thị một mod như là con của một mod khác. Điều này nhằm dùng cho các mod được chia thành nhiều mô-đun khác nhau. Phần tử sau trong fabric.mod.json sẽ định nghĩa mod là con của mod 'flamingo':

fabric.mod.json

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

Tuy nhiên, nếu bạn muốn nhóm các mod dưới một parent, nhưng parent không phải là một mod thực sự, bạn cũng có thể làm điều đó. Trong ví dụ dưới đây, một mod đang định nghĩa siêu dữ liệu cho một parent. Hãy đảm bảo rằng siêu dữ liệu này được đưa vào tất cả các con sử dụng parent giả. Điều này cũng có thể dùng làm dự phòng cho một parent tùy chọn, nó sẽ được thay bằng siêu dữ liệu thực của mod nếu có.

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 parent giả chỉ hỗ trợ siêu dữ liệu sau:

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

Tắt trình kiểm tra cập nhật ("updatechecker": false)

Theo mặc định, trình kiểm tra cập nhật của Mod Menu sẽ dùng hash của tệp jar mod của bạn để tra phiên bản mới nhất trên Modrinth. Nếu tìm thấy dự án khớp, nó sẽ kiểm tra phiên bản mới nhất hỗ trợ mod loader và phiên bản Minecraft của bạn, và nếu phiên bản đó có hash khác với tệp hiện có của bạn, nó sẽ thông báo cho người dùng rằng có bản cập nhật.

Bạn có thể tắt trình kiểm tra cập nhật bằng cách đặt updatechecker thành false trong siêu dữ liệu Mod Menu của mình như sau:

fabric.mod.json

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

API siêu dữ liệu Quilt

Vì Mod Menu cũng hỗ trợ Quilt, các API tương tự trong phần API siêu dữ liệu Fabric cũng có sẵn cho mod Quilt, nhưng định dạng cho siêu dữ liệu tùy chỉnh hơi khác một chút.

Thay vì một khối "modmenu" bên trong khối "custom", bạn đặt khối "modmenu" như một phần tử trong đối tượng gốc. Vậy nó sẽ trông như:

quilt.mod.json

{ ... "modmenu": { // Đây là nơi chứa links, badges, v.v. của bạn } }

Java API

Để dùng Java API, bạn cần thêm Mod Menu làm phụ thuộc lúc biên dịch trong dự án gradle của mình. Điều này sẽ không khiến mod của bạn yêu cầu Mod Menu, nhưng nó sẽ có trong môi trường của bạn để bạn thử nghiệm.

build.gradle

// Thêm kho maven Terraformers vào khối repositories của bạn repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } }

// Thêm Mod Menu làm phụ thuộc trong môi trường của bạn dependencies { // Trước Minecraft 26.x, dùng "modImplementation" thay thế implementation("com.terraformersmc:modmenu:${project.modmenuversion}") }

Sau đó, định nghĩa phiên bản Mod Menu bạn đang dùng trong gradle.properties. Bạn có thể lấy số phiên bản mới nhất ở đây, nhưng bạn có thể cần phiên bản khác nếu không dùng phiên bản Minecraft mới nhất. Xem trang versions để có danh sách đầy đủ các phiên bản.

gradle.properties

modmenuversion=VERSIONNUMBERHERE

Nếu bạn không muốn nó trong môi trường để thử nghiệm nhưng vẫn muốn biên dịch với Mod Menu để dùng Java API, bạn có thể dùng modCompileOnly thay vì modImplementation (điều này sẽ hoạt động ngay cả khi Mod Menu chưa được cập nhật lên phiên bản Minecraft bạn đang chạy).

Tài liệu Java API

Bắt đầu

Để dùng API, hãy triển khai giao diện ModMenuApi trên một lớp và thêm nó làm entry point loại "modmenu" trong fabric.mod.json của bạn như sau:

fabric.mod.json

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

Màn hình cấu hình mod

Mod có thể cung cấp một Screen factory để cung cấp màn hình cấu hình tùy chỉnh mở bằng nút cấu hình. Triển khai phương thức getModConfigScreenFactory trong phần triển khai API của bạn để làm điều này.

Trường hợp sử dụng dự kiến cho việc này là để mod tự cung cấp màn hình cấu hình của riêng chúng. ID mod của màn hình cấu hình được tự động xác định bởi container mod nguồn mà entrypoint bắt nguồn từ đó.

Màn hình cấu hình được cung cấp

Mod có thể cung cấp Screen factory để cung cấp màn hình cấu hình tùy chỉnh mở bằng nút cấu hình cho các mod khác nữa. Triển khai phương thức getProvidedConfigScreenFactories trong phần triển khai API của bạn để làm điều này.

Trường hợp sử dụng dự kiến cho việc này là để một mod như Cloth Config cung cấp màn hình cấu hình cho các mod dùng API của nó.

Huy hiệu Modpack

Mod có thể cấp cho các mod khác huy hiệu Modpack bằng cách triển khai phương thức attachModpackBadges, chẳng hạn như qua đoạn sau:

@Override public void attachModpackBadges(Consumer consumer) { consumer.accept("modmenu"); // Cho biết rằng 'modmenu' là một phần của modpack }

Lưu ý rằng các mod 'nội bộ' như chính Minecraft và mod loader không thể được cấp huy hiệu modpack, vì chúng không được phân phối trong một modpack thông thường.

Phương thức trợ giúp tĩnh

ModMenuApi cũng cung cấp một vài phương thức trợ giúp cho các mod muốn hoạt động tốt hơn với Mod Menu, như tạo nút Mods của riêng chúng.

Tạo một instance màn hình Mods

Bạn có thể gọi phương thức này để lấy một instance của màn hình Mods:

Screen createModsScreen(Screen previous)

Tạo Text cho nút Mods

Bạn có thể gọi phương thức này để lấy Text sẽ được hiển thị trên nút Mods của Mod Menu:

Text createModsButtonText()