Differences

This shows you the differences between two versions of the page.

--- tutorial:migratemappings [2019/07/01 20:06] – modmuss50
+++ tutorial:migratemappings [2020/02/22 15:31] – Some structural cleanup, mention that Mixins are not remapped jamieswhiteshirt
@@ Line 1: / Line 1: @@
 ====== Updating Yarn mappings in a Java codebase ======
-===== The Hacky Way =====
+Loom allows semi-automatic updating of the mappings used in a Java codebase. Due to frequent changes in Yarn, this can be a useful tool for keeping a codebase up-to-date with the newest changes.
-==== Requirements ====
+**Note:** This automated process currently only applies to most Java code. It will not automatically migrate mappings for Mixin targets or for code written in other language such as Kotlin or Scala.
-  * Fabric-Loom 0.2.2 or above
+===== Loom 0.2.6 and above =====
-  * A Java codebase - Kotlin and Scala will not, currently, do.
-  * Some assembly required
-==== Instructions ====
+Say you want to migrate from 1.14.4 to 19w46b.
+  - Go [[https://modmuss50.me/fabric.html?&version=19w46b|here]], select ''19w46b'', and copy the ''yarn_mappings'' value, for example ''19w46b+build.1''.  DO NOT modify your gradle.properties or build.gradle yet.
+  - In the root of your gradle project, run ''gradlew migrateMappings %%--%%mappings %%"%%19w46b+build.1%%"%%''
+  - Your migrated sources will appear in ''remappedSrc''. Verify that the migration produced valid migrated code.
+  - Copy the sources from ''remappedSrc'' to the original folder. Keep the original sources backed up just in case.
+  - Update your gradle.properties file according to the instructions in [[https://modmuss50.me/fabric.html?&version=19w46b|this]] site.
+  - Refresh the Gradle project in your IDE.
+  - Check and update any Mixin targets that may be outdated.
+=== Additional customization ===
+  * Specify from where to take your Java files with ''%%--%%input path/to/source''. Default: ''src/main/java''.
+  * Specify where to output the remapped source with ''%%--%%output path/to/output''. Default: 'remappedSrc'.
+  * Specify a custom place to retrieve the mappings from with ''%%--%%mappings some_group:some_artifact:some_version:some_qualifier''. Default: ''net.fabricmc:yarn:<version-you-inputted>:v2''.
+=== Reporting issues ===
+Loom uses [[https://github.com/CadixDev/Mercury|Mercury]] to remap Java source code, for problems with remapping please report issues to their [[https://github.com/CadixDev/Mercury/issues|issue tracker]], or discuss it through their communications channel (irc.esper.net #cadix).
+===== Loom 0.2.2-0.2.5 =====
+Some assembly required.
   - Figure out your target mappings version. For example, "net.fabricmc:yarn:1.14.1 Pre-Release 2+build.2".
@@ Line 17: / Line 35: @@
     * "inputDir" is the input directory, containing Java source code,
     * "outputDir" is the output directory. It will be created if it is missing.
-  - Copy the remapped source code to the input directory, if everything's fine,
+  - Copy the remapped source code to the input directory, if everything's fine.
   - Hope for the best.
@@ Line 24: / Line 42: @@
 This should work across Minecraft versions as well, provided we haven't massively broken Intermediaries or done something equally silly (aka: most of the time).
-===== The Non-Hacky Way =====
-Coming soon! (Hopefully.)