Obfuscation map

Obfuscation maps are ProGuard mappings from old (original) names to new (obfuscated) names for classes and class members that have been renamed.^[1] They have been exported in the client.json for every snapshot and release available in the Launcher since 19w36a, and the client.json for 1.14.4 has been updated slightly after 19w36a's release to include obfuscation maps as well.^[2]

Usage[]

The obfuscation maps can be used to remap obfuscated stack traces (as in crash reports) to readable stack traces.^[3] A tutorial is available.

Dinnerbone and Adrian Östergård have suggested that the obfuscation maps may make modding easier.^[4][5] Searge has implied that the obfuscation maps can replace certain third-party programs such as the Mod Coder Pack.^[6]

On August 12th, 2020, Dinnerbone states that modding projects can switch to official Mojang names provided in the obfuscation maps.^[7]

Third-party usages[]

The obfuscation maps include enough information to deobfuscate Minecraft for decompilation. A tutorial is available.

According to the License, such decompiled source code can only be distributed in a modified version or part of a larger project. This was changed from being available only for internal purposes before August 14th, 2020.

License[]

Every obfuscation map file starts with a line indicating the license of the maps.

This current license has been in use since 21w03a.

# (c) 2020 Microsoft Corporation. These mappings are provided "as-is" and you bear the risk of using them. You may copy and use the mappings for development purposes, but you may not redistribute the mappings complete and unmodified. Microsoft makes no warranties, express or implied, with respect to the mappings provided here.  Use and modification of this document or the source code (in any form) of Minecraft: Java Edition is governed by the Minecraft End User License Agreement available at https://account.mojang.com/documents/minecraft_eula.

Per Dinnerbone, any obfuscation mapping released before the license update on 14th August 2020 would be still available under this older license in addition to being available under the new license.^[8]

History[]

September 3, 2019					Dinnerbone mentions "a small surprise for modders!" for 19w36a.
Java Edition
1.15		19w36a			Downloads to client and server obfuscation maps are now included in client.json.
September 4, 2019					Dinnerbone releases obfuscation mappings for 1.14.4 as well.
August 12, 2020					Dinnerbone indicates the license of the obfuscation maps will be updated and encourages modders to switch to Mojang's obfuscation map, claiming in another tweet that it would "help with compatibility".
					He offered a preview of the updated license as well.
August 14, 2020					The license of obfuscation maps was updated.
					The version_manifest.json was updated to have client.json entries for 1.14.4 and versions since 19w36a to link to updated obfuscation maps.
1.17		21w03a			Altered the wording of the license.

Trivia[]

• Out of all Java Edition versions published after 19w36a (September 4, 2019), Combat Test 3 is yet the only one published without any obfuscation map.

• Unlike previous Combat Tests, the version it forked against, 1.14.4, has obfuscation maps released.
• All subsequent Combat Tests have obfuscation maps released, and are based off versions with obfuscation maps released.

• Before the August 16th, 2020 license update, versions released in year 2020 had # (c) 2019 Microsoft Corporation. in the license notice in the obfuscation map files.

• Despite that Combat Test 8b is published after the license update, it still uses the old license notice and has the 2019 year notice.

• In client obfuscation mappings, one of the first listed functions is called youJustLostTheGame(), an easter egg reference to The Game.

• This function is used to trigger a Java crash after holding the debug key combination F3 + C for ten seconds.

References[]

Minecraft: Java Edition
Versions	Demo Locations PC Gamer Demo (Beta 1.3)
Development	Version history Pre-Classic Classic Early Classic Creative Multiplayer Test Survival Test Late Classic Creative Indev Infdev Alpha Beta Full Release Development versions Removed features Blocks Items Unused features Exclusive features Mentioned features Sky dimension Planned versions
Technical	Known bugs Minecraft Launcher Hardware requirements al_version Block entity Commands Functions Crashes Data values Classic Indev Pre-flattening Data version Debug screen Formatting codes Heightmap Key codes Minecraft Launcher Protocol version Resource location Screenshot Seed Statistics Tick Spawn chunk Coordinates .minecraft client.jar client.json launcher_profiles.json options.txt Development resources Anvil file format Chunk format Command storage format Entity format Generated structures format Level format Loot tables Map item format Model NBT format Obfuscation map Player format raids.dat format Raw JSON text format Region file format Structure block file format Schematic file format Scoreboard format Server list format sounds.json Subtitles villages.dat format Legacy development resources Classic level format Classic server protocol Indev level format Alpha level format Infdev 20100624 level format server_level.dat
Multiplayer	Server Minecraft Realms Server list server.properties Server requirements
Game customization	Skins Capes Resource packs Data packs