Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Grayray75 committed Aug 27, 2023
1 parent 78fa2d4 commit 2c63a90
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# Yarn

![Build](https://img.shields.io/github/actions/workflow/status/Legacy-Fabric/yarn/build.yml?label=Build&branch=v2) ![Publish](https://img.shields.io/github/actions/workflow/status/Legacy-Fabric/yarn/publish.yml?label=Publish&branch=v2)
![Build](https://img.shields.io/github/actions/workflow/status/Legacy-Fabric/yarn/publish.yml?label=build&branch=master)
![Publish](https://img.shields.io/github/actions/workflow/status/Legacy-Fabric/yarn/publish.yml?label=publish&branch=master)

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.

Please note to run the yarn build script **Java 17** or higher is required!

## Contributing

Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP, Spigot's or Mojang's obfuscation maps)
Expand All @@ -32,9 +34,15 @@ Please have a look at the [naming conventions](/CONVENTIONS.md) before submittin
Yarn uses Gradle to provide a number of utility tasks for working with the mappings.

### `yarn`
Runs [`setupYarn`](#setupYarn) and downloads and launches [Enigma](https://github.com/FabricMC/Enigma) automatically configured to use the merged jar and the mappings.
Setup 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.
Compared to launching Enigma externally, the gradle task adds a name guesser plugin that automatically maps enums and a few constant field names.

### `yarnUnpicked`
Same as above, but unpicks the constants and launches Enigma with them. Can be a little bit slower to get going.

### `yarnCommon`
Same as `yarn`, but will only show common classes.

### `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..
Expand All @@ -50,6 +58,3 @@ Downloads the client and server Minecraft jars for the current Minecraft version

### `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)

0 comments on commit 2c63a90

Please sign in to comment.