Quilt Mappings 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.

Unlike previous mapping sets, Quilt Mappings allows referencing the official Mojang mappings, which speeds up creating new mappings for Minecraft and improves name quality and accuracy.

To see the current version being targeted, check the branch name!

To use Quilt Mappings in a Fabric or Quilt mod use the official Quilt Mappings on Loom (QMoL) Gradle plugin.

This extra code is only needed if you are using Fabric Loom; the QMoL plugin is applied by default on Quilt.

settings.gradle:

pluginManagement {
    repositories {
        maven { url = "https://maven.quiltmc.org/repository/release" }
    }
}

build.gradle:

plugins {
  // ...
  // Check the Quilt Mappings on Loom README for the correct version to use
  id "org.quiltmc.quilt-mappings-on-loom" version "QMoL_VERSION"
}

See here for the correct QMoL_VERSION to use.

This code is added to your buildscript regardless of if you are using Fabric or Quilt Loom.

dependencies {
   mappings(loom.layered {
      addLayer(quiltMappings.mappings("org.quiltmc:quilt-mappings:${project.minecraft_version}+build.${project.quilt_mappings}:v2"))
   })
}

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 Quilt Mappings build script Java 17 or higher is required!

Our goal is to provide high-quality names that make intuitive sense. In our experience, this goal is best achieved through contribution of original names, rather than copying names from other mappings projects. While we believe that discussions relating to the names used by other mappings projects can be useful, those names must stand up to scrutiny on their own - we won't accept names on the grounds that they're present in other mappings projects.

We recommend discussing your contribution with other members of the community - either directly in your pull request, or in our other community spaces. We're always happy to help if you need us!

Please have a look at the naming conventions before submitting mappings.

1. Fork and clone the repo
2. Run ./gradlew mappings (Linux, macOS) or gradlew mappings (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

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

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 maps enums and a few constant field names.

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

Build a GZip'd archive containing a tiny mapping between official (obfuscated), hashed-mojmap, and Quilt Mappings names ("named") and packages enigma mappings into a zip archive.

Builds a deobfuscated jar with Quilt mappings and automapped fields (enums, etc.). Unmapped names will be filled with hashed-mojmap names.

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

Downloads the client and server Minecraft jars for the current Minecraft version to .gradle/minecraft

Merges the client and server jars into one merged jar, located at VERSION-merged.jar in the project directory where VERSION is the current Minecraft version.