Feather is a set of open, unencumbered Minecraft mappings, free for everyone to use under the Creative Commons Zero license. The intention is to let everyone mod Minecraft freely and openly, while also being able to innovate and process the mappings as they see fit.
To see the current version being targeted, check the branch name!
To use feather-deobfuscated Minecraft for Minecraft modding or as a dependency in a Java project, you can use loom Gradle plugin. See fabric wiki tutorial for more information.
To obtain a deobfuscated Minecraft jar, ./gradlew mapNamedJar will generate a jar named like <minecraft version>-named.jar, which can be sent to a decompiler for deobfuscated code.
You can also directly generate a mapped jar and decompile the code using one of the following commands (no need to run ./gradlew mapNamedJar first):
- CFR:
./gradlew decompileCFR - Quiltflower:
./gradlew decompileQuiltflower - Procyon:
./gradlew decompileProcyon
Our goal is to provide high-quality names that make intuitive sense. In our experience, this goal is best achieved through contribution of original names, rather than copying names from other mappings projects. While we believe that discussions relating to the names used by other mappings projects can be useful, those names must stand up to scrutiny on their own - we won't accept names on the grounds that they're present in other mappings projects.
We recommend discussing your contribution with other members of the community - either directly in your pull request, or in our other community spaces. We're always happy to help if you need us
Please have a look at the naming conventions before submitting mappings.
- Fork and clone the repo
- Run
./gradlew feather(Linux, macOS) orgradlew feather(Windows) to open Enigma, a user interface to easily edit the mappings - Commit and push your work to your fork
- Open a pull request with your changes
Feather uses Gradle to provide a number of utility tasks for working with the mappings.
setupFeather and download and launch the latest version of Enigma automatically configured to use the merged jar and the mappings.
Compared to launching Enigma externally, the gradle task adds a name guesser plugin that automatically map enums and a few constant field names.
Build a GZip'd archive containing a tiny mapping between official (obfuscated), intermediary, and feather names ("named") and packages enigma mappings into a zip archive..
Builds a deobfuscated jar with feather mappings and automapped fields (enums, etc.). Unmapped names will be filled with intermediary names.
Decompile the mapped source code. Note: This is not designed to be recompiled.
Downloads the client and server Minecraft jars for the current Minecraft version to .gradle/minecraft
Merges the client and server jars into one merged jar, located at VERSION-merged.jar in the mappings directory where VERSION is the current Minecraft version.