/sparrow-and-raven

Java signature mappings for obfuscated Minecraft jars.

Creative Commons Zero v1.0 UniversalCC0-1.0

Sparrow

Java signature mappings for classes, fields, and methods.

Raven

Java exceptions clause mappings for methods.

Contributing

  1. Fork and clone this repository.
  2. Change the Minecraft version in build.gradle (line 12) to the version you wish to work on.
  3. It is recommended you update from a version with existing exceptions and signatures to lessen the workload. To do this, put this version in place of the brackets on lines 31 and 35.
  4. Run ./gradlew setUpSource.
  5. Import this project into your Java IDE. It will have the deobfuscated Minecraft source in the main sourceset.
  6. Edit the source and add signatures.
  • This means adding generics to classes, fields, or methods, or adding throws clauses to method declarations.
  • Be careful not to change any class names, field names, or method names!
  • You may have to solve compile errors in order to save your work. This is because the decompilation process is imperfect.
  1. Run ./gradlew save. Your progress is now saved in the signatures/ and exceptions/ directories.
  2. Commit and push your work.
  3. Open a pull request with your changes.