Go to file
liach 47bdb3b9e4
Entity stuff, see #1905 (#1967)
* Squash the review stuff

Co-authored-by: Henry <obw@generalprogramming.org>
Co-authored-by: Thalia Nero <chrisvn00@gmail.com>

commit b9e91de684
Author: Henry <obw@generalprogramming.org>
Date:   Fri Jan 1 18:06:37 2021 +0000

    Apply some cleanup from code review

    Also removes some bits not present in 20w51a

    Co-authored-by: YanisBft <doublecraft.official@gmail.com>

commit e9f0cea6e7
Author: Henry Le Grys <henry@legrys.info>
Date:   Wed Dec 9 19:40:28 2020 +0000

    Add javadocs for MessageListener

commit a6fe16a9cd
Author: Henry Le Grys <henry@legrys.info>
Date:   Wed Dec 9 18:31:29 2020 +0000

    Apply some suggestions to clean up

    - Restored missing Entity methods
    - Fixed comment reference
    - Unmapped generic `flagSet`-named methods

commit cbacd58a0a
Author: Henry Le Grys <henry@legrys.info>
Date:   Thu Dec 3 18:56:45 2020 +0000

    Apply some suggestions & map extra names

commit 411b92b91f
Merge: c5287fed0 c0a046c66
Author: Henry Le Grys <henry@legrys.info>
Date:   Thu Dec 3 17:55:40 2020 +0000

    Merge 20w49a into world-entity

commit c5287fed06
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Wed Nov 11 23:18:02 2020 -0500

    listener -> handler

commit 490818513e
Merge: d74d922b0 3465a1132
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Sun Nov 8 14:53:43 2020 -0500

    Merge branch '20w45a' into world-entity

commit d74d922b0b
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Sat Nov 7 15:28:32 2020 -0500

    Update mappings from review.

commit fbb44ecbb9
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Sat Nov 7 01:51:17 2020 -0500

    Some docs and mapping of methods called by the entity stuff.

commit 095711c00a
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Sat Nov 7 01:28:23 2020 -0500

    Some parameters and mappings.

commit caea9fed00
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Sat Nov 7 01:14:33 2020 -0500

    Filter -> TypeFilter

commit 9d82f4bcc4
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Fri Nov 6 20:19:18 2020 -0500

    Map ChunkStatusChangeListener.

commit 4699e0991e
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Fri Nov 6 20:11:11 2020 -0500

    Map more entity loading stuff.

commit 8a30358ef2
Merge: 6d0aa8cff ee05e2b40
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Fri Nov 6 18:10:03 2020 -0500

    Merge branch '20w45a' of github.com:FabricMC/yarn into world-entity

commit 6d0aa8cff7
Author: Thalia Nero <chrisvn00@gmail.com>
Date:   Fri Nov 6 03:43:11 2020 -0500

    Map a lot of entity world interaction shenanigans. Feeling tired might remap later.

* Extra classes

* tweaks

* Revert some refactors

* meh, enigma bad

* move entitylike to world as it's more s/l related than actual entity

* Eliminate the "group"

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

* Bunch renames, should make sense now

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

* Fix javadoc types

Co-authored-by: YanisBft <doublecraft.official@gmail.com>

* Human-friendly name for synthetic fields in case they appear

* rename

Co-authored-by: liach <liach@users.noreply.github.com>
Co-authored-by: YanisBft <doublecraft.official@gmail.com>
2021-02-10 19:35:29 +00:00
.github/workflows Use github actions to publish releases 2020-11-06 23:33:17 +00:00
gradle/wrapper Use github actions to publish releases 2020-11-06 23:33:17 +00:00
mappings Entity stuff, see #1905 (#1967) 2021-02-10 19:35:29 +00:00
.editorconfig Port GLDebug mappings (#1478) 2020-06-18 17:22:25 +01:00
.gitattributes Use eol=lf on *.mapping files to help Windows users (#493) 2019-03-20 00:14:47 +00:00
.gitignore Add unnecessary Eclipse files to .gitignore (#2022) 2021-02-04 22:13:36 +00:00
CONTRIBUTING.md Add CONTRIBUTING.md, mention mojmap being ARR (#1222) 2020-03-26 14:12:00 +00:00
CONVENTIONS.md Add javadocs convention (#1790) 2020-10-13 08:56:22 +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 Add a simple `decompileCFR` task (#1805) 2020-10-31 19:02:53 +00:00
build.gradle 21w06a 2021-02-10 18:42:45 +00:00
enigma_profile.json The Great Intermediary Update, Part 1 2019-06-28 23:55:20 +02:00
gradle.properties Update enigma and javadoc (#1985) 2021-01-26 13:10:08 +00: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 Add a settings.gradle to ensure consistency (#1929) 2020-12-22 20:27:34 +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.

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

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.

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.

setupYarn

download and mergeJars