ca79a51a1a
* Begin refactor work: Sand -> Aggregate Underwater Plant -> Aquatic Plant Bamboo Sapling -> Bamboo Shoot Part -> Decoration Packed Ice -> Dense Ice Organic -> Fodder Pumpkin -> Gourd Clay -> Mob Derived Anvil -> Repair Station Seagrass -> Replaceable Aquatic Plant Snow -> Snow Layer Earth -> Topsoil * Undo Sapling -> Shoot * AQUATIC -> UNDERWATER to account for lily pad being under PLANT * Add javadocs for material names * Update javadoc based on comments * Update JD based on feedback Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Update JD based on feedback Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Update JD based on feedback Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Update JD based on feedback Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Remove errant comment Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Add missing punctuation Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Fix errant JD Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Remove unneeded javadoc Added previous name to javadoc * Remove old names JD * Remove missed old name Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Fix link format Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Implement feedback * FODDER -> SOLID_ORGANIC * update JD * Fix JD typo Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * SUB -> Partial Update stone JD * Fix outdated JD * Fix JD link for ICE Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Add missing punctuation Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Explicitly state block in JD 1 Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Explicitly state block in JD Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Add skulls to JD for PARTIAL_BLOCK Co-Authored-By: Yanis48 <doublecraft.official@gmail.com> * Update JD names on NETHER_WOOD Adds hyphae Co-Authored-By: Yanis48 <doublecraft.official@gmail.com> * MOB_DERIVED -> ORGANIC_PRODUCT * PARTIAL_BLOCK -> SUPPORTED * TOPSOIL -> SOIL * Simplify organic product JD Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: Yanis48 <doublecraft.official@gmail.com> |
||
---|---|---|
gradle/wrapper | ||
mappings | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
CONTRIBUTING.md | ||
CONVENTIONS.md | ||
Jenkinsfile | ||
LICENSE | ||
MAINTAINERS | ||
README.md | ||
build.gradle | ||
enigma_profile.json | ||
gradle.properties | ||
gradlew | ||
gradlew.bat |
README.md
Yarn
Yarn 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!
Usage
To use yarn-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.
Contributing
Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP or Mojang's obfuscation maps) is completely forbidden without explicit permission from the owners of said mappings to distribute the names under the CC0 license. This includes using the names from those mappings for inspiration. Discussing the naming approaches used in said projects is also not welcome - you have been warned. However, it is a good idea to consult name changes with other people - use pull requests or our community spaces to ask questions!
Please have a look at the naming conventions before submitting mappings.
Getting Started
- Fork and clone the repo
- Run
./gradlew yarn
(Linux, macOS) orgradlew yarn
(Windows) - Profit
Gradle
Yarn uses Gradle to provide a number of utility tasks for working with the mappings.
yarn
setupYarn
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
Build a GZip'd archive containing a tiny mapping between official (obfuscated), intermediary, and yarn names ("named") and packages enigma mappings into a zip archive..
mapNamedJar
Builds a deobfuscated jar with yarn mappings and automapped fields (enums, etc.). Unmapped names will be filled with intermediary names.
download
Downloads the client and server Minecraft jars for the current Minecraft version to .gradle/minecraft
mergeJars
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.