yarn/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](https://github.com/fabricmc/fabric-loom) Gradle plugin. See [fabric wiki tutorial](https://fabricmc.net/wiki/tutorial:setup) for more information.

To obtain a deobfuscated Minecraft jar, [`./gradlew mapNamedJar`](#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) 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!

Please have a look at the [naming conventions](/CONVENTIONS.md) before submitting mappings.

### 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`](#setupYarn) and download and launch the latest version of [Enigma](https://github.com/FabricMC/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](https://github.com/FabricMC/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](https://github.com/FabricMC/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`](#download) and [`mergeJars`](#mergeJars)
nothing to see here, move right along 2018-12-09 16:14:34 -05:00			`# Yarn`
first commit 2016-08-12 09:28:17 -04:00
nothing to see here, move right along 2018-12-09 16:14:34 -05:00			`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`
update README 2016-08-14 14:44:42 -04:00			`everyone mod Minecraft freely and openly, while also being able to innovate and process the mappings as they see fit.`
first commit 2016-08-12 09:28:17 -04:00
Rendering mappings (#985) * Rendering mappings * Undo ColorResolver -> ColorProvider, it's an unobfuscated class! * Update mappings/net/minecraft/client/render/debug/BeeDebugRenderer.mapping Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Update mappings/net/minecraft/client/render/debug/BeeDebugRenderer.mapping Co-Authored-By: liach <7806504+liach@users.noreply.github.com> * Fixes by liach * Fix 2019-11-26 18:53:20 -05:00			`To see the current version being targeted, check the branch name!`
add version note 2016-08-12 09:28:52 -04:00
Update README.md 2019-06-19 01:08:54 -04:00			`## Usage`
			`To use yarn-deobfuscated Minecraft for Minecraft modding or as a dependency in a Java project, you can use [loom](https://github.com/fabricmc/fabric-loom) Gradle plugin. See [fabric wiki tutorial](https://fabricmc.net/wiki/tutorial:setup) for more information.`

			To obtain a deobfuscated Minecraft jar, [`./gradlew mapNamedJar`](#mapNamedJar) will generate a jar named like `<minecraft version>-named.jar`, which can be sent to a decompiler for deobfuscated code.

first commit 2016-08-12 09:28:17 -04:00			`## Contributing`

update README.md 2016-08-17 17:23:55 -04:00			`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`
update README 2018-12-09 06:46:48 -05:00			`owners of said mappings. Discussing the naming approaches used in said projects is also not welcome - you have been warned.`
typofix 2018-12-09 06:47:36 -05:00			`However, it is a good idea to consult name changes with other people - use pull requests or our community spaces to ask questions!`
Update README.md 2016-08-17 15:28:42 -04:00
Mention CONVENTIONS.md in README.md (#771) 2019-07-11 16:47:52 -04:00			`Please have a look at the [naming conventions](/CONVENTIONS.md) before submitting mappings.`

Update README.md 2016-08-17 15:28:42 -04:00			`### Getting Started`
typofix 2018-12-09 06:47:36 -05:00
Update README.md 2016-08-17 15:28:42 -04:00			`1. Fork and clone the repo`
nothing to see here, move right along 2018-12-09 16:14:34 -05:00			2. Run `./gradlew yarn` (Linux, macOS) or `gradlew yarn` (Windows)
Update README.md 2016-08-17 15:28:42 -04:00			`3. Profit`

			`## Gradle`
nothing to see here, move right along 2018-12-09 16:14:34 -05:00			`Yarn uses Gradle to provide a number of utility tasks for working with the mappings.`
Update README.md 2016-08-17 15:28:42 -04:00
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-05-12 21:45:52 -04:00			### `yarn`
			[`setupYarn`](#setupYarn) and download and launch the latest version of [Enigma](https://github.com/FabricMC/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](https://github.com/FabricMC/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](https://github.com/FabricMC/Intermediary) names.`

Update README.md 2016-08-17 15:28:42 -04:00			### `download`
			Downloads the client and server Minecraft jars for the current Minecraft version to `.gradle/minecraft`

			### `mergeJars`
nothing to see here, move right along 2018-12-09 16:14:34 -05:00			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.
Update README.md 2016-08-17 15:28:42 -04:00
nothing to see here, move right along 2018-12-09 16:14:34 -05:00			### `setupYarn`
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-05-12 21:45:52 -04:00			[`download`](#download) and [`mergeJars`](#mergeJars)