Testing Instructions

This page documents instructions for testing the contents of this repository, as of May 7, 2021. The repository is set to Minecraft version 1.16.5, as that is the latest Minecraft release as of writing.

First, clone this repository locally.

Initial Generation

To generate the initial mapping data from the version data, run the generateVersionBase task.

To move the newly generated base data from the staging directory to the production directory, run the promoteStagingToProduction task.

Inputs

Enter the following text in the following files under the input folder in the repository root (the names of files do not matter, but the names of the directories do matter):

official/test.txt

package com/mojang/blaze3d
    Root package for the Blaze3D rendering library.

    Yes, a multiline debugging format because I'm not writing JSON over and over again, thank you very much.
package net/minecraft/client
    The client-only classes for Minecraft.
class com/mojang/math/Matrix3f
    A class. I dunno, this is obfuscated. :P
    field m00 F
        A field in this class. Contains a float.
    method <init> (Lcom/mojang/math/Matrix4f;)V
        Copy constructor for this class.
        param 1 other
            The instance to copy from

obf/test.txt

class a
    method a (FF)Lcom/mojang/datafixers/util/Pair;
        Why am I not getting documented
        param 0 float
            first float

srg/test.txt

class net/minecraft/util/math/vector/Matrix4f
    4-wide float matrix
    method func_195879_b (Ljava/nio/FloatBuffer;)V
        A method. Not static
        param 0 buffer
            A float buffer

Then, run the createStagingFromInputs task to generate the staging data from the production data and input files. You may inspect the staging data if you wish. Afterwards, run the promoteStagingToProduction task to move the newly-modified staging data to the production data folder.

Maven Publishing

Run the publishDatedExportPublicationToProjectLocalRepository to publish the Maven export, to the project local repository (which is the repo folder under the repository root). The current maven coordinates is org.parchmentmc.mappings:{mc version}:{date time in yyyyMMdd-HHmmss}[:classifier]@json. The no-classifier version uses Official/Mojmap names and the srg classifier uses SRG names.

The exported files only export entries (package, class, field, method, parameter) which has an associated javadoc (or in the case of parameter, either a name or javadoc). The data within the repository is not stripped like the exports.