mirrors/yarn
mirrors
/
yarn
mirror of https://github.com/FabricMC/yarn.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
2,413 Commits 364 Branches 287 Tags 92 MiB
Java 100%
Go to file
liach 0d0a71ba96
More comprehensive javadoc conventions (#2051) 
* Squashed commit of the following:

commit b66d5953cdd5a671af8aa93b05c63584d7d5ffec
Merge: a517a6fab4 7f65f51654
Author: liach <7806504+liach@users.noreply.github.com>
Date:   Thu Apr 22 10:55:59 2021 +0700

    Merge branch '21w16a' into 21w06a-2

commit a517a6fab4a648153d2af91cccf165618fb4cdeb
Merge: ae8afb008e 232a1e0b9f
Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Thu Apr 8 00:07:28 2021 +0000

    Merge branch '21w14a' into 21w06a-2

commit ae8afb008e0edfb005f8fc4d0ef65fc601c82ab7
Merge: ee10f51f18 e15349595d
Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Wed Mar 31 23:35:18 2021 +0000

    Merge branch '21w13a' into 21w06a-2

commit ee10f51f189cac5f6aa59fb000ada2a989fcf14b
Merge: 0218c2a387 bf4d6850bd
Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Thu Mar 18 02:29:22 2021 +0000

    Merge branch '21w11a' into 21w06a-2

commit 0218c2a387a8cca390743a04974db257bcd5e5f8
Merge: 45ca6452b4 252ad11d0a
Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Wed Mar 10 19:32:17 2021 +0000

    Merge branch '21w10a' into 21w06a-2

commit 45ca6452b4d329eed9cdefd1737f22e15e175616
Author: liach <7806504+liach@users.noreply.github.com>
Date:   Mon Feb 22 07:07:17 2021 -0600

    Update CONVENTIONS.md

    Co-authored-by: haykam821 <24855774+haykam821@users.noreply.github.com>

commit e99c08f313cf21d9cd4076acb9b889126214e031
Author: liach <liach@users.noreply.github.com>
Date:   Sun Feb 21 19:19:19 2021 -0600

    Address player's concerns

    Signed-off-by: liach <liach@users.noreply.github.com>

commit 112ad37d74efb585eaf212a820a527608acdfe06
Author: liach <7806504+liach@users.noreply.github.com>
Date:   Mon Feb 15 22:40:31 2021 -0600

    Update CONVENTIONS.md

commit d029970d8be3aa49aa52d05618cae01c50ac7eb6
Author: liach <liach@users.noreply.github.com>
Date:   Mon Feb 15 18:08:55 2021 -0600

    Fixes a few problems from haykam's suggestions

    Signed-off-by: liach <liach@users.noreply.github.com>

commit 30930a7298832090a3c06581631d4f453a8632f1
Author: liach <7806504+liach@users.noreply.github.com>
Date:   Mon Feb 15 17:45:26 2021 -0600

    Apply suggestions from code review

    Still needs furnishing

    Co-authored-by: haykam821 <24855774+haykam821@users.noreply.github.com>

commit b06652dc3f0b22876907a5e4457fdd1f42cc79fe
Author: liach <7806504+liach@users.noreply.github.com>
Date:   Fri Feb 12 16:39:37 2021 -0600

    Update CONVENTIONS.md

    Co-authored-by: enbrain <69905075+enbrain@users.noreply.github.com>

commit 8cb65e7a0d36cf4633501ff526eaccdbc60969fd
Author: liach <liach@users.noreply.github.com>
Date:   Fri Feb 12 15:18:42 2021 -0600

    More comprehensive javadoc conventions

    Signed-off-by: liach <liach@users.noreply.github.com>

* Modernize information and my notes

Signed-off-by: liach <liach@users.noreply.github.com>

* Update CONVENTIONS.md

Co-authored-by: enbrain <69905075+enbrain@users.noreply.github.com>

Co-authored-by: liach <liach@users.noreply.github.com>
Co-authored-by: enbrain <69905075+enbrain@users.noreply.github.com>
 		2021-05-14 15:25:02 +00:00
.github/workflows Build javadoc against java 16 2021-05-12 20:59:27 +01:00
gradle/wrapper Build javadoc against java 16 2021-05-12 20:59:27 +01:00
mappings Fix GameModeCommand.setGameMode (#2396) 2021-05-13 19:50:49 +00:00
src Entity flags and other constant fields (#2331) 2021-04-18 13:02:39 +00:00
unpick-definitions Unpick entity flags and pufferfish states (#2368) 2021-05-04 08:47:02 +00:00
.editorconfig Unpick biome IDs (#2258) 2021-04-02 19:01:56 +01:00
.gitattributes Use eol=lf on *.mapping files to help Windows users (#493) 2019-03-20 00:14:47 +00:00
.gitignore Update Dependencies (#2343) 2021-04-24 10:07:59 +01:00
CONTRIBUTING.md Add CONTRIBUTING.md, mention mojmap being ARR (#1222) 2020-03-26 14:12:00 +00:00
CONVENTIONS.md More comprehensive javadoc conventions (#2051) 2021-05-14 15:25:02 +00:00
HEADER Minor javadoc updates around unpick (#2200) 2021-03-28 20:33:12 +01: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 Update readme Java req note to Java 16 2021-05-13 06:12:21 +00:00
build.gradle Fixes #2399 (#2400) 2021-05-14 16:00:29 +01:00
enigma_profile.json The Great Intermediary Update, Part 1 2019-06-28 23:55:20 +02:00
gradle.properties Fixes #2399 (#2400) 2021-05-14 16:00:29 +01:00
gradlew Use github actions to publish releases 2020-11-06 23:33:17 +00:00
gradlew.bat Use github actions to publish releases 2020-11-06 23:33:17 +00:00
settings.gradle Build javadoc against java 16 2021-05-12 20:59:27 +01:00
unpick-logging.properties Fix unpick log spamming (#2189) 2021-03-25 12:45:12 +00: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 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.

Please note to run the yarn build script Java 16 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) 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

  1. Fork and clone the repo
  2. Run ./gradlew yarn (Linux, macOS) or gradlew yarn (Windows) to open Enigma, a user interface to easily edit the mappings
  3. Commit and push your work to your fork
  4. Open a pull request with your changes

Gradle

Yarn uses Gradle to provide a number of utility tasks for working with the mappings.

yarn

Setup 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.

yarnUnpicked

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

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.

decompileCFR

Decompile the mapped source code. Note: This is not designed to be recompiled.

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.