Parchment Mappings

Welcome to the Parchment mappings repository!

Parchment is an open community-sourced modloader-neutral set of mappings of parameter names and javadocs, to augment the official names released by Mojang. This repository contains the files which make up the Parchment mapping set, with the build tool to manage the mappings and generate exports for publishing.

Want to use Parchment in your workspace? See the Getting Started page at the website.

Contributing

See the docs/CONTRIBUTING.md file for information on contributing. Also look at the repository wiki for more information, such as links to the mapping standards and PR review process documents.

Tools and Libraries

Our mappings system makes use of the following open-source tools and libraries:

• Compass, the Gradle plugin powering the validation and input systems.
• Feather, a data object and parsing library used by ParchmentMC projects.
• Enigma, a tool for deobfuscation and mapping of Java bytecode.
• Moshi, a modern JSON parsing library.

Support

Want to ask a question? Get help on how to use these mappings? Or tips on contributing to the mappings? Head over to our public Discord server!

Licensing

Parchment mappings are released under the terms of the CC0 1.0 Universal (CC0 1.0), see the LICENSE.txt for the full legal text.