Go to file
liach ce3f15c1e2 Add proposed field names to the mapped named jar
Changed old named jar to yarn jar
Beautify readme and added groups to gradle tasks
always indent with tabs

Signed-off-by: liach <liach@users.noreply.github.com>
2019-06-17 22:11:28 +08:00
gradle/wrapper Update method calls for player's tiny remapper update (#624) 2019-04-15 16:39:14 +02:00
mappings TranslatableBuiltInExceptions (#742) 2019-06-15 11:51:37 +02:00
.editorconfig more random mappings and other changes (#192) 2018-11-15 17:57:32 +01:00
.gitattributes Use eol=lf on *.mapping files to help Windows users (#493) 2019-03-20 00:14:47 +00:00
.gitignore 19w12a 2019-03-20 17:56:26 +00:00
.travis.yml Hotfix for #696 and fix travis 2019-05-13 16:48:16 +01:00
Jenkinsfile Decrease build time by not building twice 2018-12-13 09:28:54 +00:00
LICENSE first commit 2016-08-12 15:28:17 +02:00
MAINTAINERS add maintainer list for lgtm 2016-08-19 23:19:08 +02:00
README.md Add proposed field names to the mapped named jar 2019-06-17 22:11:28 +08:00
build.gradle Add proposed field names to the mapped named jar 2019-06-17 22:11:28 +08:00
gradle.properties Hotfix for #696 and fix travis 2019-05-13 16:48:16 +01:00
gradlew Update method calls for player's tiny remapper update (#624) 2019-04-15 16:39:14 +02:00
gradlew.bat Update method calls for player's tiny remapper update (#624) 2019-04-15 16:39:14 +02:00

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 targetted, check the branch name!

Contributing

Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP) is completely forbidden without explicit permission from the owners of said mappings. 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!

Getting Started

  1. Fork and clone the repo
  2. Run ./gradlew yarn (Linux, macOS) or gradlew yarn (Windows)
  3. 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.

setupYarn

download and mergeJars