documentation:yarn
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
documentation:yarn [2023/09/13 18:50] – removed - external edit (Unknown date) 127.0.0.1 | documentation:yarn [2023/09/13 18:50] (current) – ↷ Links adapted because of a move operation nebelnidas | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Yarn ====== | ||
+ | A minecraft mapping. | ||
+ | |||
+ | See [[https:// | ||
+ | |||
+ | Yarn depends on [[documentation: | ||
+ | |||
+ | ===== Usage ===== | ||
+ | |||
+ | See [[documentation: | ||
+ | |||
+ | ==== Contributing mappings ==== | ||
+ | |||
+ | Run | ||
+ | < | ||
+ | and the enigma user interface will appear. Edit the mappings; when you are ready, save it in enigma, commit in git (preferably in a custom branch), and submit a pull request. | ||
+ | |||
+ | If you have changes done manually/ | ||
+ | |||
+ | ==== Using mappings in mods ==== | ||
+ | |||
+ | See [[tutorial: | ||
+ | |||
+ | ==== Looking at Minecraft javadoc ==== | ||
+ | |||
+ | Existing yarn builds approximately after 20w14a (1.16) have javadoc generated. They are accessible at | ||
+ | < | ||
+ | For example, the javadoc for yarn 21w05b+build.8 is available at https:// | ||
+ | |||
+ | Run | ||
+ | < | ||
+ | to generate javadoc from yarn's mappings. They will be built in the | ||
+ | < | ||
+ | directory relative to the repository root, and you can open index.html to view the docs. | ||
+ | |||
+ | ==== Building mapped jars for decompilers ==== | ||
+ | |||
+ | Though enigma comes with procyon, you may want other decompilers to decompile the Minecraft jar with yarn names. Run | ||
+ | < | ||
+ | After running the gradle task, a < |