NeoForge Show modid and raw display name in mod list entries

Show modid and raw display name in mod list entries

Open MattSturgeon opened this issue 4 months ago • 4 comments

Motivation

This PR was inspired by feedback that localised display names can make it hard to identify compatibility issues at a glance from mod-list screenshots.

While that's technically a more fundamental issue with display names, because they can be ambiguous or foreign anyway, translation support certainly has the potential to exacerbate this.

Summary

Mod IDs are now displayed alongside version info in the entry's subheading.
"Raw" display names (from mods.toml) are shown alongside the localized version if different
Formatting is tweaked to (hopefully) make the additional information easy to read at a glance.

Example

Using these test translations while running :tests:runClient renders like this:

Translations

{
  "fml.menu.mods.info.displayname.testframework": "test framework",
  "fml.menu.mods.info.displayname.neotests": "Translation!"
}

Further consideration

Should the modid still be shown when it is similar to the displayname?
- "Minecraft" & minecraft
- "Test Framework" & testframework
- "Foo Bar" & foo_bar
How different should translated display names be to display the raw name?
- Currently any difference is enough
- Should we be case insensitive?
- What about formatting differences?
Is modid and version readable enough when on one line?
Should we consider making the entry bigger?
- It's pretty likely that entry lines will get truncated atm...
Should we consider rendering the mod's icon in the entry?
- This could further help to distinguish similarly named mods.

I've tried to keep the changes here minimal. Hopefully they can act as a starting point, so the above considerations and any feedback can be iterated on; either in this PR or in future work.