Skip to content

Commit b3062d1

Browse files
authored
Revise mappings explanation for the new unobfuscated era (#201)
1 parent 9589e3f commit b3062d1

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

tags/faq/mappings.ytag

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,14 @@ type: text
22

33
---
44

5-
Mappings are an essential part of modding Minecraft with any tool.
6-
Mappings change the fields, methods, classes, and parameters from unusable nonsense like `cdr.a` into more readable code like `net.minecraft.Block.Blocks.AIR`.
7-
The mappings Fabric uses are created and maintained by the Fabric community and are called "yarn mappings".
5+
Prior to the unobfuscated versions of Minecraft, mappings were required to mod Minecraft, as without them the game's fields, methods, classes, and parameters were unusable nonsense like `cdr.a`. Mappings were used to transform that into more readable code like `net.minecraft.block.Blocks.AIR`.
86

9-
Fabric mappings are used on top of intermediaries so that the mappings generally work from version to version.
10-
Intermediaries are also a type of mapping that stays consistent through versions.
11-
So if a variable was named `cdr.a` in one version but the next one it was named `cer.b`, the intermediary name of class_2246.field_10124 will stay the same.
7+
There are two common human-readable mapping sets - the community-made "Yarn Mappings" developed by Fabric, and the official Mojang Mappings, also known as Mojmap. Yarn Mappings were the default for all Fabric mods and documentation until 1.21.10, when the announcement was made that future versions of Minecraft would not be obfuscated, and there would be no need for mappings. Older versions can use Mojang Mappings as well to make migrating to unobfuscated versions easier.
8+
9+
Published Fabric mods (prior to the unobfuscated versions of Minecraft) made use of a different set of mappings, Intermediary. Intermediary Mappings were also developed by Fabric with the goal to maintain consistency through versions. So, if a variable was named `cdr.a` in one version but the next one it was named `cer.b`, the intermediary name of class_2246.field_10124 will stay the same.
1210

13-
There are a variety of different mappings people have made, such as Spigot mappings, Mojang mappings, and MCP mappings.
1411
You do not necessarily need to know what mappings are in order to mod the game with Fabric, but it certainly does help.
15-
The mappings that Fabric uses are available here, with every version that we have mapped being under a separate branch: <https://github.com/FabricMC/yarn>.
12+
Fabric's Yarn Mappings are available here, with every version that we have mapped being under a separate branch: <https://github.com/FabricMC/yarn>.
1613

17-
A more in-depth explanation can be found at <https://fabricmc.net/wiki/tutorial:mappings>.
14+
A more in-depth explanation can be found on the [Fabric Wiki](<https://fabricmc.net/wiki/tutorial:mappings>), and you can learn how to migrate from Yarn Mappings to Mojang Mappings on the [Docs](<https://docs.fabricmc.net/develop/migrating-mappings/>).
1815
---

0 commit comments

Comments
 (0)