Gradle Extension and Tasks

Compass adds the compass extension to the buildscript, along with multiple tasks which manipulate the data within the repository in various ways.

Extension

The compass extension (through the CompassExtension class) provides ways to customize what version is used and where the mapping data is stored.

• manifestURL (Property<String>, defaults to https://piston-meta.mojang.com/mc/game/version_manifest_v2.json)

  The URL of the launcher version manifest file.

• version (Property<String>, required)

  The Minecraft version to use for the environment, such as for the obfuscation maps.

• productionData (DirectoryProperty, defaults to $projectDir/data)

  The directory where the production data are stored by Compass.

• stagingData (DirectoryProperty, defaults to $projectDir/staging)

  The directory where the staging data are stored by Compass.

• inputs (DirectoryProperty, defaults to $projectDir/input)

  The directory where the input files are placed by the user, for consumption by Compass.

Tasks

• displayMinecraftVersions - Prints all known Minecraft versions to the console, according to the launcher version manifest.

• generateVersionBase - Generates the base mapping data, based on the obfuscation maps of the current version, and stores the generated data in the staging directory.

• promoteStagingToProduction - Promotes the data from the staging directory to the production directory, overwriting whatever contents the production directory had previously.

• combineInputData - Combines the current production mapping data with the input files in the inputs directory to produce the modified staging data.

• clearStaging - Clears the staging data directory.

In addition, Compass adds tasks for each registered intermediate provider:

• generate{Provider}Export - Generates an export file based on the production mapping data and the intermediate format provided by the {provider} intermediate provider.

• generate{Provider}StagingExport - Generates an export file based on the staging mapping data and the intermediate format provided by the {provider} intermediate provider.