chylex
/
IntelliJ-Forge-Mapping-Hints
mirror of https://github.com/chylex/IntelliJ-Forge-Mapping-Hints.git
1
0
Fork 0
Code
IntelliJ IDEA plugin that shows inlay hints for SRG mapping development.
8 Commits 1 Branch 2 Tags 218 KiB
Kotlin 100%
Go to file
chylex 7179deecec Increase maximum supported IntelliJ version 2020-08-05 16:50:27 +02:00
.github/readme Add README 2020-07-10 20:24:16 +02:00
gradle/wrapper Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00
src/main Fix settings dialog capitalization & tweak text 2020-07-10 12:16:25 +02:00
.gitignore Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00
LICENSE Initial commit 2020-07-09 17:25:12 +02:00
README.md Add README 2020-07-10 20:24:16 +02:00
build.gradle.kts Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00
detekt-config.yml Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00
gradle.properties Increase maximum supported IntelliJ version 2020-08-05 16:50:27 +02:00
gradlew Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00
gradlew.bat Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00
settings.gradle.kts Initial version w/ hardcoded stuff 2020-07-09 17:41:46 +02:00

README.md

This IntelliJ IDEA plugin adds hints next to SRG names (field_..., func_..., p_...) based on suggestions in a CSV file.

The CSV must follow several rules:

  • Requires header line
  • Columns:
    • validated (TRUE/FALSE)
    • class name (string)
    • unmapped name (string)
    • mapped name (string)
    • comment (string, optional)
  • No quote parsing or escaping, the first 4 commas must be delimiters (comment column contents can include commas)

Then, opening a Java file automatically adds inlay hints of several types:

  • Validated (green/blue) names are those for which the validated property equals TRUE
  • Suggested (yellow) names are those for which the validated property equals something else
  • Empty (gray) are entries which exist in the file but their mapped name is empty
  • Missing (gray) are entries which are SRG names but do not match any unmapped name in the file

Example (Green Highlight)

Example (Blue Highlight)

Settings

View Settings > Editor > Inlay Hints > Java > Minecraft Forge mapping suggestions to access the settings.

Settings