User Tools

Site Tools


tutorial:mappings

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
tutorial:mappings [2021/11/18 00:59]
liach [Remapping]
tutorial:mappings [2022/05/22 08:38] (current)
daomephsta Clarify correct build task
Line 20: Line 20:
 By changing the mappings in your development environment,​ you can expect that names of classes, methods and fields in Minecraft and any included mods have changed, and that your code might have to be updated to reference the changed names. [[tutorial:​migratemappings|This process can be partially automated]]. You will also have to run ''​genSources''​ to access Minecraft sources with the updated mappings. By changing the mappings in your development environment,​ you can expect that names of classes, methods and fields in Minecraft and any included mods have changed, and that your code might have to be updated to reference the changed names. [[tutorial:​migratemappings|This process can be partially automated]]. You will also have to run ''​genSources''​ to access Minecraft sources with the updated mappings.
  
-Loom's ''​remapJar''​ task will produce the primary mod artifact, which is a built jar using intermediary names. Additionally,​ if a ''​sourcesJar''​ task is present, ''​remapSourcesJar''​ will produce a sources jar using intermediary names. These jars can be installed as mods or included in a development environment with the ''​modCompile''​ dependency configuration.+Loom's ''​remapJar''​ task will produce the primary mod artifact, which is a built jar using intermediary names. However it does not perform testing or validation, ''​build''​ should always be used to produce JARs for end user use. Additionally,​ if a ''​sourcesJar''​ task is present, ''​remapSourcesJar''​ will produce a sources jar using intermediary names. These jars can be installed as mods or included in a development environment with the ''​modCompile''​ dependency configuration.
  
   * **The '​-dev'​ jar (the ''​jar''​ task output) does not use intermediary names, and is therefore not useful.** It cannot be installed as a mod outside a development environment and will only work in a development environment with matching mappings. The regular jar (the ''​remapJar''​ task output) should be used instead and installed in development environments using mod-augmented dependency configurations like ''​modCompile''​.   * **The '​-dev'​ jar (the ''​jar''​ task output) does not use intermediary names, and is therefore not useful.** It cannot be installed as a mod outside a development environment and will only work in a development environment with matching mappings. The regular jar (the ''​remapJar''​ task output) should be used instead and installed in development environments using mod-augmented dependency configurations like ''​modCompile''​.
tutorial/mappings.txt ยท Last modified: 2022/05/22 08:38 by daomephsta