Initial Commit

This commit is contained in:
Eli Orona 2021-10-22 17:29:47 -07:00
commit 09efe5193c
9 changed files with 517 additions and 0 deletions

3
.gitignore vendored Normal file
View file

@ -0,0 +1,3 @@
/.gradle/
/.idea/
/build/

41
README.md Normal file
View file

@ -0,0 +1,41 @@
# Quilt Mappings on Loom
## **The time has finally arrived! Quilt Mappings are now usable in Loom!**
Ever wanted to use mappings other than Yarn or MojMap?
[Quilt Mappings](https://github.com/QuiltMC/quilt-mappings) is a Yarn derivative that allows inspiration from MojMap, which allows Quilt Mappings to map the obscure constants in Minecraft code and more.
This gradle plugin allows Quilt Mappings to be used in Loom and Fabric environments.
Currently, 1.17.1+ is only has support, with no plans of backporting to earlier versions.
## **Benefits of Quilt Mappings:**
1. Faster turn around.
- For the past couple weeks, Quilt Mappings has been out before intermediary. While this doesn't help too much in loom, it is something to look forward to in the future.
2. Consistent names.
- Quilt Mapping names are never mismatched, meaning you won't find issues where names swap between versions.
3. Familiarity of Yarn with the completeness of MojMap.
- While not complete, Quilt Mappings has the goal of 100% mapping coverage for Minecraft. Any help toward this goal would be appreciated as well!
## **How to use Quilt Mappings:**
`settings.gradle`:
```groovy
pluginManagement {
repositories {
maven { url = "https://maven.oroarmor.com" }
}
}
```
`build.gradle`
```groovy
plugins {
// ...
plugin "com.oroarmor.quilt-mappings-on-loom" version "1.0.0"
}
// ...
dependencies {
mappings quiltmappings.mappings("org.quiltmc:quilt-mappings:${minecraft_version}", true)
}
```

54
build.gradle.kts Normal file
View file

@ -0,0 +1,54 @@
plugins {
java
`java-gradle-plugin`
`maven-publish`
}
group = "com.oroarmor"
version = "1.0.0"
repositories {
mavenCentral()
maven {
url = uri("https://maven.fabricmc.net/")
}
}
dependencies {
implementation("net.fabricmc:fabric-loom:0.10-SNAPSHOT")
implementation("net.fabricmc:mapping-io:0.2.1")
implementation("net.fabricmc:lorenz-tiny:4.0.2")
implementation("net.fabricmc:tiny-mappings-parser:0.2.2.14")
implementation("net.fabricmc:stitch:0.6.1")
}
gradlePlugin {
plugins {
create("quiltMappingsLoom") {
id = "quilt-mappings-on-loom"
implementationClass = "com.oroarmor.quiltmappings.loom.QuiltMappingsOnLoomPlugin"
}
}
}
publishing {
publications {
create<MavenPublication>("mavenJava") {
artifact(tasks.jar)
}
}
repositories {
mavenLocal()
if (System.getenv("MAVEN_URL") != null) {
maven {
setUrl(System.getenv("MAVEN_URL"))
credentials {
username = System.getenv("MAVEN_USERNAME")
password = System.getenv("MAVEN_PASSWORD")
}
name = "OroArmorMaven"
}
}
}
}

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

View file

@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

185
gradlew vendored Normal file
View file

@ -0,0 +1,185 @@
#!/usr/bin/env sh
#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
exec "$JAVACMD" "$@"

89
gradlew.bat vendored Normal file
View file

@ -0,0 +1,89 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

11
settings.gradle.kts Normal file
View file

@ -0,0 +1,11 @@
pluginManagement {
repositories {
mavenCentral()
maven {
url = uri("https://maven.fabricmc.net/")
}
mavenLocal()
}
}
rootProject.name = "quilt-mappings-on-loom"

View file

@ -0,0 +1,129 @@
package com.oroarmor.quiltmappings.loom;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Collections;
import java.util.Objects;
import java.util.Set;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Dependency;
import org.gradle.util.GFileUtils;
import net.fabricmc.loom.api.LoomGradleExtensionAPI;
import net.fabricmc.loom.api.mappings.layered.MappingContext;
import net.fabricmc.loom.api.mappings.layered.MappingLayer;
import net.fabricmc.loom.api.mappings.layered.MappingsNamespace;
import net.fabricmc.loom.api.mappings.layered.spec.MappingsSpec;
import net.fabricmc.mappingio.MappingVisitor;
import net.fabricmc.mappingio.MappingWriter;
import net.fabricmc.mappingio.adapter.MappingDstNsReorder;
import net.fabricmc.mappingio.adapter.MappingNsRenamer;
import net.fabricmc.mappingio.adapter.MappingSourceNsSwitch;
import net.fabricmc.mappingio.format.MappingFormat;
import net.fabricmc.mappingio.format.Tiny2Reader;
import net.fabricmc.mappingio.tree.MemoryMappingTree;
@SuppressWarnings("UnstableApiUsage")
public class QuiltMappingsOnLoomPlugin implements Plugin<Project> {
@Override
public void apply(Project target) {
target.getExtensions().create("quiltmappings", QuiltMappingsOnLoomExtension.class, target);
target.getRepositories().maven(repo -> {
repo.setName("Quilt Releases");
repo.setUrl("https://maven.quiltmc.org/repository/release");
});
target.getRepositories().maven(repo -> {
repo.setName("Quilt Snapshots");
repo.setUrl("https://maven.quiltmc.org/repository/snapshot");
});
}
public static class QuiltMappingsOnLoomExtension {
private final Project project;
public QuiltMappingsOnLoomExtension(Project project) {
this.project = project;
}
public Dependency mappings(String quiltMappings, boolean snapshot) {
return project.getExtensions().getByType(LoomGradleExtensionAPI.class).layered(layeredMappingSpecBuilder -> {
layeredMappingSpecBuilder.addLayer(new MappingsSpec<>() {
@Override
public MappingLayer createLayer(MappingContext context) {
return new QuiltMappingsLayer(context, project, quiltMappings, snapshot);
}
@Override
public int hashCode() {
return Objects.hash(quiltMappings, snapshot);
}
});
});
}
}
private record QuiltMappingsLayer(MappingContext context, Project project, String quiltMappings,
boolean snapshot) implements MappingLayer {
@Override
public void visit(MappingVisitor mappingVisitor) throws IOException {
String minecraftVersion = context.minecraftProvider().minecraftVersion();
File intermediaryToQm = project.file(".gradle/qm/qm_to_intermediary_" + minecraftVersion + ".tiny");
if (!intermediaryToQm.exists()) {
Set<File> quiltmappings = project.getConfigurations().detachedConfiguration(project.getDependencies().create(quiltMappings)).resolve();
Set<File> hashedFiles = project.getConfigurations().detachedConfiguration(project.getDependencies().create("org.quiltmc:hashed:" + minecraftVersion + (snapshot ? "-SNAPSHOT" : ""))).resolve();
File hashedFile = project.file(".gradle/qm/hashed_" + minecraftVersion + ".tiny");
downloadFile(hashedFiles, hashedFile);
File quiltMappingsFile = project.file(".gradle/qm/qm_" + minecraftVersion + ".tiny");
downloadFile(quiltmappings, quiltMappingsFile);
MemoryMappingTree mappings = new MemoryMappingTree();
MemoryMappingTree qm = new MemoryMappingTree();
Tiny2Reader.read(new FileReader(quiltMappingsFile), qm);
MemoryMappingTree intermediary = new MemoryMappingTree();
Tiny2Reader.read(new FileReader(context.mappingsProvider().intermediaryTinyFile()), intermediary);
qm.accept(mappings);
intermediary.accept(new MappingNsRenamer(mappings, Collections.singletonMap("obfuscated", "official")));
mappings.accept(new MappingSourceNsSwitch(new MappingDstNsReorder(MappingWriter.create(new FileWriter(intermediaryToQm), MappingFormat.TINY_2), "named"), "intermediary"));
}
Tiny2Reader.read(new FileReader(intermediaryToQm), mappingVisitor);
}
private void downloadFile(Set<File> dependency, File output) {
if (!output.exists()) {
GFileUtils.copyFile(project
.zipTree(dependency.stream().iterator().next())
.getFiles()
.stream()
.filter(file -> file.getName().endsWith("mappings.tiny"))
.findFirst()
.get(), output);
}
}
@Override
public MappingsNamespace getSourceNamespace() {
return MappingsNamespace.INTERMEDIARY;
}
@Override
public int hashCode() {
return quiltMappings.hashCode();
}
}
}