Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a display name extension to KeyMapping #1826

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

Matyrobbrt
Copy link
Member

@Matyrobbrt Matyrobbrt commented Jan 5, 2025

This PR adds a getDisplayName method to IKeyMappingExtension, allowing custom key mapping implementations to show users a name in the keybindings GUI that is not a translatable component of their ID.
This method can be used, for instance, by generated key mappings that are not statically known at build-time and therefore have no translations for their names. I am working on a mod which allows users to create their own key bundles on-demand to disambiguate keymappings and I need to display the name they gave to the bundle in the bindings UI instead of an untranslated translation key.

@Matyrobbrt Matyrobbrt added enhancement New (or improvement to existing) feature or request 1.21.4 Targeted at Minecraft 1.21.4 labels Jan 5, 2025
@neoforged-pr-publishing
Copy link

neoforged-pr-publishing bot commented Jan 5, 2025

  • Publish PR to GitHub Packages

Last commit published: ceb012199462d167645e7e1ba4fcd169f3dec951.

PR Publishing

The artifacts published by this PR:

Repository Declaration

In order to use the artifacts published by the PR, add the following repository to your buildscript:

repositories {
    maven {
        name 'Maven for PR #1826' // https://github.com/neoforged/NeoForge/pull/1826
        url 'https://prmaven.neoforged.net/NeoForge/pr1826'
        content {
            includeModule('net.neoforged', 'neoforge')
            includeModule('net.neoforged', 'testframework')
        }
    }
}

MDK installation

In order to setup a MDK using the latest PR version, run the following commands in a terminal.
The script works on both *nix and Windows as long as you have the JDK bin folder on the path.
The script will clone the MDK in a folder named NeoForge-pr1826.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1826
cd NeoForge-pr1826
curl -L https://prmaven.neoforged.net/NeoForge/pr1826/net/neoforged/neoforge/21.4.51-beta-pr-1826-keymapping-display-name/mdk-pr1826.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zip

To test a production environment, you can download the installer from here.

Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine. I was looking at KeybindContents to see if something needs to be done for the resolver, but since it only uses the translation key when no key mapping is registered, there shouldn't be an issue.

@Matyrobbrt Matyrobbrt merged commit 5e4bfbf into neoforged:1.21.x Jan 13, 2025
7 checks passed
@neoforged-releases
Copy link

🚀 This PR has been released as NeoForge version 21.4.54-beta.

@Matyrobbrt Matyrobbrt deleted the keymapping-display-name branch January 13, 2025 09:04
Matyrobbrt added a commit to Matyrobbrt/NeoForge that referenced this pull request Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.21.4 Targeted at Minecraft 1.21.4 enhancement New (or improvement to existing) feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants