Toolchain - Revision history

ChampionAsh5357: Push changes to main page

2021-08-19T23:48:14Z

Push changes to main page

Show changes

SciWhiz12: Fix formatting of SRG, add a tidbit about Mod Coder Pack, surround type prefixes in code tags

2021-02-15T10:50:11Z

Fix formatting of SRG, add a tidbit about Mod Coder Pack, surround type prefixes in code tags

SciWhiz12: surround the snowman in code tags

2021-02-15T10:39:46Z

surround the snowman in code tags

Curle: SRG->Searge's Retro Guard

2021-01-19T02:09:09Z

SRG->Searge's Retro Guard

Curle at 17:00, 11 January 2021

2021-01-11T17:00:18Z

Curle: Forge side

2021-01-11T16:59:09Z

Forge side

Curle: Undo weirdness from visual editor

2021-01-11T05:34:50Z

Undo weirdness from visual editor

Curle: Fix link to "magic constants"

2021-01-11T05:33:15Z

Fix link to "magic constants"

Curle: Major overhaul. Still have yet to get into the Forge side of things.

2021-01-11T05:29:11Z

Major overhaul. Still have yet to get into the Forge side of things.

Show changes

SciWhiz12: add under construction templatae

2020-11-29T02:10:52Z

add under construction templatae

@@ Line 30: / Line 30: @@
 Some background on what SRG is and how it works:
-'''SRG''' stands for '''S'''earge's ''R'''etro ''G''uard; RetroGuard being an early attempt to reverse the ProGuard obfuscation, and Searge being co-author of the Mod Creator Pack, who created this process.
+'''SRG''' stands for '''S'''earge's '''R'''etro '''G'''uard; RetroGuard being an early attempt to reverse the ProGuard obfuscation, and Searge being co-author of the Mod Coder Pack or MCP<ref>This was previously called the ''Minecraft Coder Pack''</ref>, who created this process.
 Each obfuscated class, method, and field is assigned a unique number by the [[Toolchain:MCPConfig|backend]], via a sequential counter. This unique number is called the '''SRG ID''' of that class/method/field (henceforth called member).
-The SRG name of the member is then derived from its SRG ID, its type (function {given the prefix func_}, field {given the prefix field_}, parameter {given the prefix p_, or p_i if this is the parameter of a constructor}), and (optionally) the obfuscated name of the object at the time it was given its SRG name<ref>The SRG name for a given member is only created once, when it first appears in the code. Therefore, the SRG postfix may be different from the current obf name.</ref>. This inclusion of the SRG ID into the name guarantees that the SRG name for all members are unique, and is the reason the ID is generated.
+The SRG name of the member is then derived from its SRG ID, its type (function {given the prefix <code>func_</code>}, field {given the prefix <code>field_</code>}, or parameter {given the prefix <code>p_</code>, or <code>p_i</code> if this is the parameter of a constructor}), and (optionally) the obfuscated name of the object at the time it was given its SRG name<ref>The SRG name for a given member is only created once, when it first appears in the code. Therefore, the SRG postfix may be different from the current obf name.</ref>. This inclusion of the SRG ID into the name guarantees that the SRG name for all members are unique, and is the reason the ID is generated.
 The actual conversion of obf names to SRG names is done by a tool called [[Toolchain:SpecialSource|SpecialSource]]. More information on how it works can be found on that page.

@@ Line 16: / Line 16: @@
 '''Obfuscation''' is the process of renaming all of the fields, methods, and classes of the compiled code into unreadable, machine-generated names (such as <code>aaa</code>, <code>bC</code>), and removing package structures (this makes everything package-local and makes the obfuscated code smaller somewhat. This is commonly used by companies to prevent external entities from easily decompiling their released binaries/executables and retrieving their source code/intellectual property, though it does have size advantages.
-Additionally, due to the way the Local Variable Table (LVT) of Java bytecode is stored, every function-local variable name is turned to ☃ (that's right, a snowman) in the compiled files. This makes immediate recompilation of the game literally and physically impossible, as every Java compiler currently available requires that local variables have unique names.
+Additionally, due to the way the Local Variable Table (LVT) of Java bytecode is stored, every function-local variable name is turned to <code>☃</code> (that's right, a snowman) in the compiled files. This makes immediate recompilation of the game literally and physically impossible, as every Java compiler currently available requires that local variables have unique names.
 Minecraft is a commercial game, which means the source code is unavailable to all except the developers of Mojang. To prevent piracy and the copying of their intellectual property, Mojang applies this obfuscation process to the game before they release it. They use a tool called [https://www.guardsquare.com/en/products/proguard ProGuard], which is both an optimizer<ref>An optimizer is a program that removes redundant/unused instructions and compacts the code to be faster and smaller.</ref> and an obfuscator.

@@ Line 30: / Line 30: @@
 Some background on what SRG is and how it works:
-'''SRG''' stands for '''S'''ea'''RG'''e, co-author of the Mod Creator Pack, who created this process.
+'''SRG''' stands for '''S'''earge's ''R'''etro ''G''uard; RetroGuard being an early attempt to reverse the ProGuard obfuscation, and Searge being co-author of the Mod Creator Pack, who created this process.
 Each obfuscated class, method, and field is assigned a unique number by the [[Toolchain:MCPConfig|backend]], via a sequential counter. This unique number is called the '''SRG ID''' of that class/method/field (henceforth called member).

@@ Line 205: / Line 205: @@
 These renames can come from any source; as mentioned earlier, the MCP/Crowdsourced naming, the Yarn naming, or the Mojang Obf-map naming. ForgeGradle does not care, as long as there is a valid SRG->names map.
-How ForgeGradle retrieves these mappings is covered in the [[ForgeGradle/mappings appropriate article]].
+How ForgeGradle retrieves these mappings is covered in the [[ForgeGradle/mappings|appropriate article]].
 The process of renaming itself is a simple regex substitution, performed by [https://github.com/MinecraftForge/ForgeGradle/blob/e2ed49546abced95650635f81be071441ec60995/src/common/java/net/minecraftforge/gradle/common/util/McpNames.java#L104 ForgeGradle itself]. This is made possible by the assured uniqueness of SRG names.
@@ Line 213: / Line 213: @@
 At this point, the files are ready to go. We have processed the Minecraft jar such that it can be recompiled, we have applied appropriate access transformers and the Forge patches, and optionally renamed every applicable SRG name to whatever chosen distribution of mappings.
-There is not much left to do but package the code into a jar file, and place it into the gradle cache (so that this process does not occur every single time the project is opened). It calculates this name based on many factors, and this is covered in the [[ForgeGradle#naming]] article.
+There is not much left to do but package the code into a jar file, and place it into the gradle cache (so that this process does not occur every single time the project is opened). It calculates this name based on many factors, and this is covered in the [[ForgeGradle#naming|naming]] article.
 == Some additional Infos ==

@@ Line 43: / Line 43: @@
 In this way, MCPConfig can be thought of the vanilla side of the setup. It does not modify the game.
 === Download and parsing MCPConfig ===
 The first thing that ForgeGradle does upon initialising a first-time setup, is starting the [https://github.com/MinecraftForge/ForgeGradle/blob/e2ed49546abced95650635f81be071441ec60995/src/mcp/java/net/minecraftforge/gradle/mcp/task/SetupMCPTask.java#L91 SetupMCP] task.
 This task then seeks to [https://github.com/MinecraftForge/ForgeGradle/blob/e2ed49546abced95650635f81be071441ec60995/src/mcp/java/net/minecraftforge/gradle/mcp/task/DownloadMCPConfigTask.java#L78 download the MCPConfig.zip jar] for the version you're setting up.
-Once it is acquired, it [https://github.com/MinecraftForge/ForgeGradle/blob/e2ed49546abced95650635f81be071441ec60995/src/mcp/java/net/minecraftforge/gradle/mcp/util/MCPRuntime.java#L74 parses the steps contained within the config.json]. It does this by interpreting the file with the following rules:
+Once it is acquired, it
 * Every key, except for libraries, is interpreted as the name of a step.
 * Steps are executed in order.
@@ Line 103: / Line 107: @@
 It simply searches the jar for files, converts the bytecode into a reasonable best-guess interpretation.
 As you can see by the repository, a lot of work has gone into tuning it for Minecraft's needs, but it is still a far way from perfect. This is why the patches are needed.
@@ Line 167: / Line 172: @@
 It also adjusts abstract functions in some way - after running the program on a jar, the parameters of a default abstract function get renamed, but it is unclear exactly what part of the source code does this.
-== Mappings ==
+There is not much left to do but package the code into a jar file, and place it into the gradle cache (so that this process does not occur every single time the project is opened). It calculates this name based on many factors, and this is covered in the [[ForgeGradle#naming]] article.
 == Some additional Infos ==

@@ Line 148: / Line 148: @@
 These are done trivially, using diffs and [https://github.com/CadixDev/gitpatcher gitpatcher].
-===Clean-up===
+=== Clean-up ===
 Because of the way Proguard (or whatever obfuscator) and ForgeFlower mangle the source code, we need to take some steps to clean it up before we can proceed.
@@ Line 160: / Line 160: @@
 * removing comments that include the phrase <code>GL_[^*]+</code>
 * replacing [[Toolchain:Magic Constants|magic constants]] with their code substitutions
-* replacing <code>Character.valueOf(<character>)</code> with <code><character></code>
+* replacing <code>Character.valueOf(&lt;character&gt;)</code> with <code>&lt;character&gt;</code>
 * replacing OpenGL integer constants with their code representation
 * converting unicode character constants back into integer representation
@@ Line 166: / Line 166: @@
 It also adjusts abstract functions in some way - after running the program on a jar, the parameters of a default abstract function get renamed, but it is unclear exactly what part of the source code does this.
 == Mappings ==

← Older revision		Revision as of 02:10, 29 November 2020
Line 1:		Line 1:
	{{DISPLAYTITLE:Deobfuscation Process}}		{{DISPLAYTITLE:Deobfuscation Process}}
		+	{{Under construction}}

	The toolchain of Forge automatically deobfuscates the base game code, from their obfuscated original names to deobfuscated and human-readable names. This process is done to allow mod developers to write their code based on readable and understandable class/method/field names, which greatly simplifies the modding process.		The toolchain of Forge automatically deobfuscates the base game code, from their obfuscated original names to deobfuscated and human-readable names. This process is done to allow mod developers to write their code based on readable and understandable class/method/field names, which greatly simplifies the modding process.