Differences

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

--- tutorial:migratemappings [2022/07/08 19:20] – external edit 127.0.0.1
+++ tutorial:migratemappings [2025/11/16 00:02] (current) – cassiancc
@@ Line 1: / Line 1: @@
-====== Updating Yarn mappings in a Java codebase ======
+~~REDIRECT>https://docs.fabricmc.net/develop/migrating-mappings~~
-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.
+====== Migrating to Yarn or Mojang Mappings in a Java codebase ======
-**Note:** This automated process currently does not handle Mixins or reflection, instances of these will need to be manually updated.
+Loom allows semi-automatic updating of the mappings used in a Java codebase. This can be a useful tool for users wishing to keep their codebase up-to-date with the new changes in Yarn, or for users wishing to change to different mappings, including Mojang's own mappings. For more information, check out the dedicated [[tutorial:mappings|Mappings]] page.
-===== Loom 0.2.6 and above =====
+Loom does not support migrating code written in Kotlin. [[https://github.com/Deftu/ReplayMod-Remap|Third party tools]] are available.
-Say you want to migrate from 1.16.5 to 1.17.1.
+**Note:** Loom 1.13 is required for this process to handle Mixins.
-  - Go [[https://fabricmc.net/versions.html|here]], select the version to migrate to, and copy the Gradle command under "Mappings Migration", for example ''gradlew migrateMappings %%--%%mappings %%"%%1.17.1+build.40%%"%%''.  DO NOT modify your gradle.properties or build.gradle yet.
-  - Run the command in the root of your Gradle project.
+===== Migrating to Mojang Mappings =====
+These instructions cover migration from Yarn to Mojang Mappings.
+  - You'll need a command to migrate your mappings to Mojang Mappings, for example ''gradlew migrateMappings %%--%%mappings %%"%%net.minecraft:mappings:1.21.10%%"%%''. Replace ''1.21.10'' with the version of Minecraft you are migrating from. This must be the same version of Minecraft you are currently running. DO NOT modify your ''gradle.properties'' or ''build.gradle'' yet.
+  - Run the command in the root of your Gradle project, either through the terminal, or by adding it as a run configuration in IntelliJ Idea.
   - 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://fabricmc.net/versions.html|the first site]].
+  - If you are coming from Yarn, you can now replace your mappings in your ''build.gradle'''s dependencies section with Mojang Mappings (i.e. mappings ''loom.officialMojangMappings()'').
   - Refresh the Gradle project in your IDE.
   - Check and update any Mixin targets that may be outdated.
-=== Additional customization ===
+Your dependencies section should now contain this:
-  * 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'. You can use ''src/main/java'' here to avoid having to copy the remapped classes, but make sure you have a backup.
-  * 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''. Use ''net.minecraft:mappings:<minecraft-version>'' to migrate to official Mojang mappings.
-=== 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 =====
+    dependencies {
+        [...]
+        mappings loom.officialMojangMappings()
+    }
-Some assembly required.
-  - Figure out your target mappings version. For example, "net.fabricmc:yarn:1.14.1 Pre-Release 2+build.2".
-  - Make sure the mappings for this version get created. This is the hacky part, as currently the only way to do it is to edit the "minecraft" and "mappings" fields in a build.gradle to the new version, run any Gradle command ("gradle build" will do, even if it crashes), then **change the fields back**.
-  - Run the following magical wizardry command: ''%%gradle migrateMappings -PtargetMappingsArtifact="net.fabricmc:yarn:1.14.1 Pre-Release 2+build.2" -PinputDir=src/main/java -PoutputDir=remappedSrc%%'', where:
-    * "targetMappingsArtifact" refers to the target mappings version. It is imperative that the build.gradle be set to the current mappings version of the mod when running this command!
-    * "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.
-  - Hope for the best.
-//Note: You may need to specify the full paths in quotes, try this if you get file not found issues.//
+===== Migrating to Yarn =====
-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).
+These instructions cover migration from Mojang Mappings (or an older version of Yarn) to Yarn.
+  - Go [[https://fabricmc.net/develop|to the Fabric Develop Site]], select the version to migrate to, and copy the Gradle command under "Mappings Migration", for example ''gradlew migrateMappings %%--%%mappings %%"%%1.21.10+build.2%%"%%''.  DO NOT modify your ''gradle.properties'' or ''build.gradle'' yet.
+  - Run the command in the root of your Gradle project, either through the terminal, or by adding it as a run configuration in IntelliJ Idea.
+  - 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 or add to your ''gradle.properties'' file with the Yarn version specified on [[https://fabricmc.net/develop|the Develop site]], i.e. ''yarn_mappings=1.21.10+build.2''.
+  - If you are coming from Mojang Mappings, you can now replace your mappings in your ''build.gradle'''s dependency section with Yarn's (i.e. ''mappings "net.fabricmc:yarn${project.yarn_mappings}:v2"'')
+  - Refresh the Gradle project in your IDE.
+  - Check and update any Mixin targets that may be outdated.
+Your dependencies section should now contain this, with the version of Yarn you are using specified in your ''gradle.properties'':
+    dependencies {
+        [...]
+        mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2"
+    }
+=== Migrating Split Sources ===
+At this time, users of split sources currently need to migrate their main source set with the process above, then do the process again, specifying the path to their client source set. As a reference, the command to migrate a client source set to Mojang Mappings is below.
+    migrateMappings --mappings "net.minecraft:mappings:1.21.10" --input src/client/java
+=== 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'. You can use ''src/main/java'' here to avoid having to copy the remapped classes, but make sure you have a backup.
+  * 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''. Use ''net.minecraft:mappings:<minecraft-version>'' to migrate to official Mojang mappings.
+=== Reporting issues ===
+Loom uses a fork of [[https://github.com/FabricMC/Mercury|Mercury]] to remap Java source code, for problems with remapping please report issues to its [[https://github.com/FabricMC/Mercury/issues|issue tracker]].