Minecraft 1.20.1, 1.21.1용 Mod Menu

모드 메뉴

모드 메뉴를 사용하면 설치한 모드를 확인할 수 있으며, 모드가 지원하는 경우 모드의 설정 화면에 빠르고 쉽게 접근할 수 있습니다.

모드 메뉴는 번역 가능한 모드 이름과 설명, Patbox의 Text Placeholder API 덕분에 모드 설명에서 QuickText 서식 지원, 일반 모드에서 라이브러리 모드를 필터링하는 기능, Modrinth에 호스팅되거나 자체 업데이트 소스를 제공하는 모드를 위한 모드 업데이트 확인 기능, 그리고 저희가 제공하는 모든 기능에 대한 심층적인 설정 등 좀 더 고급 기능도 지원합니다.

지원 플랫폼

모드 메뉴는 현재 Minecraft: Java Edition 1.14 이상에서 Fabric 또는 Quilt용으로 사용할 수 있습니다.

개발자

모드 메뉴에는 개발자가 자신의 모드가 모드 메뉴에 표시되는 방식을 개선할 수 있도록 여러 API가 포함되어 있습니다. 이들은 언어 키, 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": [ ])

클라이언트 배지는 클라이언트 전용으로 설정된 모드(fabric.mod.json에서 "environment": "client"로 설정하면 됩니다)에 자동으로 추가되지만, 라이브러리 및 사용 중단됨과 같은 다른 배지는 여기에서 정의해야 합니다.

지원되는 값:

• library - 기본적으로 사용자가 켜지 않는 한 표시되지 않아야 하는 다른 모드의 순수한 의존성인 모드에 할당해야 합니다.
• deprecated - 오래된 API 모듈 등과 같이 레거시 이유로만 존재하는 모드에 할당해야 합니다.

그 외의 값은 무시되며, 모드 메뉴는 자신만의 배지를 추가하는 것을 지원하지 않습니다. 새로운 배지에 대한 설득력 있는 사용 사례가 있다면 여기에 이슈를 열어주세요.

링크 ("links": { })

links 객체를 사용하면 모드 작성자가 설명 끝에 사용자 정의 하이퍼링크를 추가할 수 있습니다. 공식 fabric.mod.json 메타데이터에 sources 연락처를 지정하면 링크 섹션에도 포함됩니다.

links 객체의 모든 키는 링크 섹션에 포함되며, 키는 번역 키로 사용됩니다. 예를 들어 다음과 같습니다:

fabric.mod.json

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

는 "modmenu.discord"에 대해 모드 메뉴가 제공하는 영어 번역이 "Discord"이므로 "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)

기본적으로 모드 메뉴의 업데이트 확인은 모드 jar의 해시를 사용하여 Modrinth에서 최신 버전을 조회합니다. 일치하는 프로젝트를 찾으면 모드 로더와 Minecraft 버전을 지원하는 최신 버전을 확인하고, 기존 파일과 다른 해시를 가지고 있으면 사용자에게 업데이트가 있음을 알립니다.

다음과 같이 모드 메뉴 메타데이터에서 updatechecker를 false로 설정하여 업데이트 확인을 비활성화할 수 있습니다:

fabric.mod.json

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

Quilt 메타데이터 API

모드 메뉴는 Quilt도 지원하므로, Fabric 메타데이터 API 섹션의 동일한 API를 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를 사용하는 모드에 설정 화면을 제공하는 것입니다.

모드팩 배지

모드는 attachModpackBadges 메서드를 구현하여 다른 모드에 모드팩 배지를 부여할 수 있습니다. 예를 들어 다음과 같습니다:

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

Minecraft 자체와 모드 로더 같은 '내부' 모드는 일반적인 모드팩 내에 배포되지 않으므로 모드팩 배지를 부여할 수 없습니다.

정적 도우미 메서드

ModMenuApi는 또한 자체 Mods 버튼을 만드는 등 모드 메뉴와 더 잘 연동하고자 하는 모드를 위한 몇 가지 도우미 메서드를 제공합니다.

Mods 화면 인스턴스 생성

이 메서드를 호출하여 Mods 화면의 인스턴스를 얻을 수 있습니다:

Screen createModsScreen(Screen previous)

Mods 버튼 Text 생성

이 메서드를 호출하여 모드 메뉴 Mods 버튼에 표시될 Text를 얻을 수 있습니다:

Text createModsButtonText()