Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SimplyProgrammer authored Sep 2, 2021
1 parent 60739c6 commit d0333b1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,19 @@ It also has more user-friendly UI with tooltips, logging console and other thing
3. Now you need to decompile your mods jar! For this, I recommend to use Procyon on this online [Java decompiler](http://www.javadecompilers.com/).
4. After decompiling your mod, all what you need to do is select the path of the downloaded zip into the second text field and hit "Deobfuscate" button that supposed to be active by this time. If it is not there is most likely something wrong with deobfuscation mappings path or mods zip path. In this case the path in the text area will be red otherwise there should be no problem!
5. After clicking on "Deobfuscate" button program will take a while to deobfuscate the selected mod using selected mappings. Unzipped folder with deobfuscated mod sources will appear on your desktop. Now you have decompiled and deobfuscated mod sources to work with.
## Since 1.2.0
Since application was wrapped into installer and procyon decompiler was implemented using procedure is now far easier!
1. Select deobfuscation mappings!
2. Select your mods .jar file and make sure that the checkbox is checked!
3. Click on deobfuscate, wait for it to finish and you are basically done (decompiled and deobfuscate mod sources will appear in the same folder as you mod jar)!

# Decompiler
1.2.0 has implemented Procyon decompiler together with deobfuscator however it cant deal with nested classes yet and also it's pretty slow which I am currently discussing with its developers in [issues](https://github.com/mstrobel/procyon/issues/25)! If you know how to fix it please answer my issue on their issues page!
But until all problems are fixed I would recommend using [external decompiler](http://www.javadecompilers.com/) as before 1.2.0!

# Valid deobfuscation mappings composition
Deobfuscation mappings are instructions for deobfuscator! They supposed to be a .csv (excel format) file or group of 3 files, the fields, methods, and params (each is optional since 1.0.5 but must be at least one of them) in one folder! Inside these files there supposed to be some sort of map with keys and values! These keys supposed to be in the first column of excel file and must contains at last one "\_" or since 1.1.0, can alternatively starts with "#" and then do not need to contains "\_"! And second column in excel file supposed to be the values for the keys. These values can be anything, there are no limits! But value should not be the same as key is and also should not be empty!

# Info
If your mods files were not deobfuscated correctly it is most likely not the deobfuscators fault but invalid mappings! Make sure your mappings are for same minecraft version as your mod is! If you have encountered some other issues please feel free to report it! Also always download the latest version of deobfuscator!
1. If your mods files were not deobfuscated correctly it is most likely not the deobfuscators fault but invalid mappings! Make sure your mappings are for same minecraft version as your mod is! If you have encountered some other issues please feel free to report it! Also always download the latest version of deobfuscator!
2. Deobfuscator will unzip your .jar files while creating folders in process and during deobfuscation it will be editing created files in your system or even changing their extensions (.class -> .java) which is something that your antivirus might not like! In that case, I would recommend disabling your antivirus or add Deobfuscator app as scan exception!

0 comments on commit d0333b1

Please sign in to comment.