diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..fb79dfc --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,29 @@ +# This workflow will build a Java project with Gradle +# For more information see: https://docs.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle + +name: Java CI with Gradle +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v7 + - name: Set up JDK 25 + uses: actions/setup-java@v5 + with: + java-version: '25' + distribution: 'microsoft' + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v6 + - name: Build + run: ./gradlew build + - name: Store failure reports + if: failure() + uses: actions/upload-artifact@v7 + with: + name: reports + path: | + **/build/reports/ + **/build/test-results/ \ No newline at end of file diff --git a/LICENSE b/LICENSE index 42efa0c..1ea8e73 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ The MIT License (MIT) -Copyright (c) 2020 Andrew Steinborn -Copyright (c) 2020 Velocity Contributors +Copyright (c) 2020-2026 Andrew Steinborn +Copyright (c) 2020-2026 Velocity Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index e17db49..2a41af9 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ -# CrossStitch +# CrossStitch [![Discord](https://img.shields.io/discord/289587909051416579.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/papermc) CrossStitch is a Minecraft mod designed to improve Minecraft proxy compatibility with other Minecraft mods. -This mod is supported by the [Velocity](https://velocitypowered.com/) team and is developed against Velocity +This mod is supported by the [Velocity](https://papermc.io/software/velocity) team and is developed against Velocity and Fabric, but the principles used are intended to be generic enough to apply to any Minecraft proxy and to any Minecraft modding platform. (Once we have modern Forge support in Velocity, for instance, we'll have a version for Forge, for instance.) ## Installation -Download the mod from [CurseForge](https://www.curseforge.com/minecraft/mc-mods/crossstitch) or from -the releases section here. +Download the mod from [Modrinth](https://modrinth.com/mod/crossstitch) or [CurseForge](https://www.curseforge.com/minecraft/mc-mods/crossstitch). CrossStitch needs to be installed on the Fabric server itself - Velocity supports CrossStitch as of Velocity 1.1.2. @@ -17,6 +16,10 @@ of Velocity 1.1.2. Once installed, make sure to only use Velocity to connect to your server, as CrossStitch isn't available client-side - it's designed to work only with Velocity. +## Additional Components + +To support Velocity's modern player information forwarding, you need to install and configure [FabricProxy-Lite](https://modrinth.com/mod/fabricproxy-lite) + ## Why? Mojang has been increasing the opportunities that mod developers have to add new content to the game. diff --git a/build.gradle b/build.gradle deleted file mode 100644 index a46fd89..0000000 --- a/build.gradle +++ /dev/null @@ -1,55 +0,0 @@ -plugins { - id 'fabric-loom' version "${loom_version}" - id 'maven-publish' -} - -sourceCompatibility = JavaVersion.VERSION_21 -targetCompatibility = JavaVersion.VERSION_21 - -archivesBaseName = project.archives_base_name -version = project.mod_version -group = project.maven_group - -dependencies { - //to change the versions see the gradle.properties file - minecraft "com.mojang:minecraft:${project.minecraft_version}" - mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2" - modImplementation "net.fabricmc:fabric-loader:${project.loader_version}" -} - -processResources { - inputs.property "version", project.version - - filesMatching("fabric.mod.json") { - expand "version": project.version - } -} - -// ensure that the encoding is set to UTF-8, no matter what the system default is -// this fixes some edge cases with special characters not displaying correctly -// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html -tasks.withType(JavaCompile) { - options.encoding = "UTF-8" -} - -jar { - from "LICENSE" -} - -// configure the maven publication -publishing { - publications { - mavenJava(MavenPublication) { - // add all the jars that should be included when publishing to maven - artifact(remapJar) { - builtBy remapJar - } - } - } - - // select the repositories you want to publish to - repositories { - // uncomment to publish to the local maven - // mavenLocal() - } -} diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..bfabf62 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,52 @@ +plugins { + id("maven-publish") + alias(libs.plugins.fabric.loom) +} + +group = "com.velocitypowered" +version = libs.versions.project.get() + +fabricApi { + configureTests { + createSourceSet = true + modId = "crossstitch-test" + enableClientGameTests = false + eula = true + } +} + +dependencies { + minecraft(libs.minecraft) + implementation(libs.fabric.loader) + + "gametestImplementation"(libs.fabric.api) +} + +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(libs.versions.java.get())) + } +} + +tasks.named("jar") { + from("LICENSE") +} + +tasks.named("processResources") { + filteringCharset = "UTF-8" + + val props = mapOf( + "version" to libs.versions.project.get(), + "java" to libs.versions.java.get(), + "minecraft" to libs.versions.minecraft.get(), + "fabric_loader" to libs.versions.fabric.loader.get() + ) + + props.forEach { (key, value) -> + inputs.property(key, value) + } + + filesMatching("fabric.mod.json") { + expand(props) + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties deleted file mode 100644 index b294b22..0000000 --- a/gradle.properties +++ /dev/null @@ -1,16 +0,0 @@ -# Done to increase the memory available to gradle. -org.gradle.jvmargs=-Xmx1G -# Fabric Properties -# check these on https://modmuss50.me/fabric.html -minecraft_version=1.21.8 -yarn_mappings=1.21.8+build.1 -loader_version=0.17.2 -loom_version=1.11-SNAPSHOT - -#Fabric api -fabric_version=0.69.1+1.19.3 -# Mod Properties -mod_version=0.1.7 -maven_group=com.velocitypowered -archives_base_name=crossstitch - diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..d1eb79c --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,17 @@ +[versions] +project = "0.1.8" +java = "25" +minecraft = "26.1.2" + +fabric_loom="1.17-SNAPSHOT" +fabric_loader="0.19.3" +# used for gametests +fabric_api="0.155.2+26.1.2" + +[plugins] +fabric_loom = { id = "net.fabricmc.fabric-loom", version.ref = "fabric_loom" } + +[libraries] +minecraft = { module = "com.mojang:minecraft", version.ref = "minecraft" } +fabric-loader = { module = "net.fabricmc:fabric-loader", version.ref = "fabric_loader" } +fabric-api = { module = "net.fabricmc.fabric-api:fabric-api", version.ref = "fabric_api" } \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 62d4c05..d997cfc 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 0b55a3b..a351597 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index fbd7c51..739907d 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -15,81 +15,114 @@ # See the License for the specific language governing permissions and # limitations under the License. # +# SPDX-License-Identifier: Apache-2.0 +# ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/2d6327017519d23b96af35865dc997fcb544fb40/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # 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 +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac 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"' +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # 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 - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,88 +131,118 @@ 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. + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + 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 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 +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac 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 +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # 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 +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # 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\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg 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" +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index 5093609..c4bdd3a 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -13,8 +13,10 @@ @rem See the License for the specific language governing permissions and @rem limitations under the License. @rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem -@if "%DEBUG%" == "" @echo off +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -25,7 +27,8 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,13 +43,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if %ERRORLEVEL% equ 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. +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 goto fail @@ -54,49 +57,35 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +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. +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :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 %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* :end @rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd +if %ERRORLEVEL% equ 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 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/settings.gradle b/settings.gradle deleted file mode 100644 index 5b60df3..0000000 --- a/settings.gradle +++ /dev/null @@ -1,10 +0,0 @@ -pluginManagement { - repositories { - jcenter() - maven { - name = 'Fabric' - url = 'https://maven.fabricmc.net/' - } - gradlePluginPortal() - } -} diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..542fc84 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,10 @@ +pluginManagement { + repositories { + maven { + name = "Fabric" + url = uri("https://maven.fabricmc.net/") + } + mavenCentral() + gradlePluginPortal() + } +} \ No newline at end of file diff --git a/src/gametest/java/com/velocitypowered/crossstitch/CrossStitchGameTest.java b/src/gametest/java/com/velocitypowered/crossstitch/CrossStitchGameTest.java new file mode 100644 index 0000000..4b2ff87 --- /dev/null +++ b/src/gametest/java/com/velocitypowered/crossstitch/CrossStitchGameTest.java @@ -0,0 +1,69 @@ +package com.velocitypowered.crossstitch; + +import com.mojang.brigadier.arguments.ArgumentType; +import com.mojang.brigadier.arguments.StringArgumentType; +import com.velocitypowered.crossstitch.arguments.TestArgumentType; +import com.velocitypowered.crossstitch.mixin.ClientboundCommandsPacket$ArgumentNodeStubAccessor; +import io.netty.buffer.Unpooled; +import java.lang.reflect.Method; +import net.fabricmc.fabric.api.gametest.v1.CustomTestMethodInvoker; +import net.fabricmc.fabric.api.gametest.v1.GameTest; +import net.minecraft.commands.arguments.AngleArgument; +import net.minecraft.commands.synchronization.ArgumentTypeInfo; +import net.minecraft.commands.synchronization.ArgumentTypeInfos; +import net.minecraft.gametest.framework.GameTestHelper; +import net.minecraft.network.FriendlyByteBuf; +import org.jspecify.annotations.NullMarked; + +@NullMarked +public class CrossStitchGameTest implements CustomTestMethodInvoker { + + private static final int MOD_ARGUMENT_INDICATOR = -256; + + @GameTest + public void brigadierArgumentType_isNotWrapped(GameTestHelper context) { + builtInArgumentType_isNotWrapped(context, StringArgumentType.word()); + } + + @GameTest + public void minecraftArgumentType_isNotWrapped(GameTestHelper context) { + builtInArgumentType_isNotWrapped(context, AngleArgument.angle()); + } + + @GameTest + public void testArgumentType_isWrapped(GameTestHelper context) { + modArgumentType_isWrapped(context, TestArgumentType.test()); + } + + private void builtInArgumentType_isNotWrapped(GameTestHelper context, ArgumentType argType) { + ArgumentTypeInfo, ?> info = ArgumentTypeInfos.byClass(argType); + ArgumentTypeInfo.Template> template = info.unpack(argType); + + FriendlyByteBuf buf = new FriendlyByteBuf(Unpooled.buffer()); + ClientboundCommandsPacket$ArgumentNodeStubAccessor.invokeSerializeCap(buf, template); + + int firstInt = buf.readVarInt(); + context.assertFalse(firstInt == MOD_ARGUMENT_INDICATOR, + "Built-in argument type %s should not be wrapped".formatted(argType.getClass().getSimpleName())); + context.succeed(); + } + + private void modArgumentType_isWrapped(GameTestHelper context, ArgumentType argType) { + ArgumentTypeInfo, ?> info = ArgumentTypeInfos.byClass(argType); + ArgumentTypeInfo.Template> template = info.unpack(argType); + + FriendlyByteBuf buf = new FriendlyByteBuf(Unpooled.buffer()); + ClientboundCommandsPacket$ArgumentNodeStubAccessor.invokeSerializeCap(buf, template); + + int firstInt = buf.readVarInt(); + context.assertValueEqual(firstInt, MOD_ARGUMENT_INDICATOR, + "Modded argument type %s should be wrapped".formatted(argType.getClass().getSimpleName())); + context.succeed(); + } + + @Override + public void invokeTestMethod(GameTestHelper context, Method method) throws ReflectiveOperationException { + method.invoke(this, context); + } + +} diff --git a/src/gametest/java/com/velocitypowered/crossstitch/CrossStitchTestMod.java b/src/gametest/java/com/velocitypowered/crossstitch/CrossStitchTestMod.java new file mode 100644 index 0000000..42a9fb4 --- /dev/null +++ b/src/gametest/java/com/velocitypowered/crossstitch/CrossStitchTestMod.java @@ -0,0 +1,25 @@ +package com.velocitypowered.crossstitch; + +import com.velocitypowered.crossstitch.arguments.TestArgumentType; +import net.fabricmc.api.ModInitializer; +import net.fabricmc.fabric.api.command.v2.ArgumentTypeRegistry; +import net.minecraft.commands.synchronization.SingletonArgumentInfo; +import net.minecraft.resources.Identifier; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class CrossStitchTestMod implements ModInitializer { + + public static Logger LOGGER = LoggerFactory.getLogger("CrossStitch-Test"); + + @Override + public void onInitialize() { + LOGGER.info("Registering test argument"); + ArgumentTypeRegistry.registerArgumentType( + Identifier.fromNamespaceAndPath("crossstitch_gametest", "test_arg"), + TestArgumentType.class, + SingletonArgumentInfo.contextFree(TestArgumentType::test) + ); + } + +} diff --git a/src/gametest/java/com/velocitypowered/crossstitch/arguments/TestArgumentType.java b/src/gametest/java/com/velocitypowered/crossstitch/arguments/TestArgumentType.java new file mode 100644 index 0000000..8f66fdf --- /dev/null +++ b/src/gametest/java/com/velocitypowered/crossstitch/arguments/TestArgumentType.java @@ -0,0 +1,20 @@ +package com.velocitypowered.crossstitch.arguments; + +import com.mojang.brigadier.StringReader; +import com.mojang.brigadier.arguments.ArgumentType; +import com.mojang.brigadier.exceptions.CommandSyntaxException; + +public class TestArgumentType implements ArgumentType { + + public static TestArgumentType test() { + return new TestArgumentType(); + } + + private TestArgumentType() {} + + @Override + public String parse(StringReader reader) throws CommandSyntaxException { + return reader.readString(); + } + +} diff --git a/src/gametest/java/com/velocitypowered/crossstitch/mixin/ClientboundCommandsPacket$ArgumentNodeStubAccessor.java b/src/gametest/java/com/velocitypowered/crossstitch/mixin/ClientboundCommandsPacket$ArgumentNodeStubAccessor.java new file mode 100644 index 0000000..57c5769 --- /dev/null +++ b/src/gametest/java/com/velocitypowered/crossstitch/mixin/ClientboundCommandsPacket$ArgumentNodeStubAccessor.java @@ -0,0 +1,17 @@ +package com.velocitypowered.crossstitch.mixin; + +import com.mojang.brigadier.arguments.ArgumentType; +import net.minecraft.commands.synchronization.ArgumentTypeInfo; +import net.minecraft.network.FriendlyByteBuf; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.gen.Invoker; + +@Mixin(targets = "net.minecraft.network.protocol.game.ClientboundCommandsPacket$ArgumentNodeStub") +public interface ClientboundCommandsPacket$ArgumentNodeStubAccessor { + + @Invoker("serializeCap") + static > void invokeSerializeCap(FriendlyByteBuf output, ArgumentTypeInfo.Template argumentType) { + throw new AssertionError(); + } + +} \ No newline at end of file diff --git a/src/gametest/resources/crossstitch-test.accesswidener b/src/gametest/resources/crossstitch-test.accesswidener new file mode 100644 index 0000000..370763d --- /dev/null +++ b/src/gametest/resources/crossstitch-test.accesswidener @@ -0,0 +1,3 @@ +accessWidener v2 official + +accessible class net/minecraft/network/protocol/game/ClientboundCommandsPacket$ArgumentNodeStub \ No newline at end of file diff --git a/src/gametest/resources/crossstitch-test.mixins.json b/src/gametest/resources/crossstitch-test.mixins.json new file mode 100644 index 0000000..e206f1b --- /dev/null +++ b/src/gametest/resources/crossstitch-test.mixins.json @@ -0,0 +1,9 @@ +{ + "required": true, + "minVersion": "0.8", + "package": "com.velocitypowered.crossstitch.mixin", + "compatibilityLevel": "JAVA_25", + "mixins": [ + "ClientboundCommandsPacket$ArgumentNodeStubAccessor" + ] +} \ No newline at end of file diff --git a/src/gametest/resources/fabric.mod.json b/src/gametest/resources/fabric.mod.json new file mode 100644 index 0000000..99c3a8a --- /dev/null +++ b/src/gametest/resources/fabric.mod.json @@ -0,0 +1,12 @@ +{ + "schemaVersion": 1, + "id": "crossstitch-test", + "version": "1.0.0", + "environment": "server", + "entrypoints": { + "main": [ "com.velocitypowered.crossstitch.CrossStitchTestMod" ], + "fabric-gametest": [ "com.velocitypowered.crossstitch.CrossStitchGameTest" ] + }, + "mixins": [ "crossstitch-test.mixins.json" ], + "accessWidener": "crossstitch-test.accesswidener" +} \ No newline at end of file diff --git a/src/main/java/com/velocitypowered/crossstitch/mixin/command/CommandTreeSerializationMixin.java b/src/main/java/com/velocitypowered/crossstitch/mixin/command/CommandTreeSerializationMixin.java index 05fb00f..35227c8 100644 --- a/src/main/java/com/velocitypowered/crossstitch/mixin/command/CommandTreeSerializationMixin.java +++ b/src/main/java/com/velocitypowered/crossstitch/mixin/command/CommandTreeSerializationMixin.java @@ -2,48 +2,53 @@ import com.mojang.brigadier.arguments.ArgumentType; import io.netty.buffer.Unpooled; -import net.minecraft.command.argument.serialize.ArgumentSerializer; -import net.minecraft.network.PacketByteBuf; -import net.minecraft.registry.Registries; -import net.minecraft.registry.RegistryKey; +import java.util.Optional; +import java.util.Set; +import net.minecraft.commands.synchronization.ArgumentTypeInfo; +import net.minecraft.core.registries.BuiltInRegistries; +import net.minecraft.network.FriendlyByteBuf; +import net.minecraft.resources.ResourceKey; +import org.jspecify.annotations.NullMarked; import org.spongepowered.asm.mixin.Mixin; import org.spongepowered.asm.mixin.Unique; import org.spongepowered.asm.mixin.injection.At; import org.spongepowered.asm.mixin.injection.Inject; import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; -import java.util.Optional; -import java.util.Set; - -@Mixin(targets = "net.minecraft.network.packet.s2c.play.CommandTreeS2CPacket$ArgumentNode") +@NullMarked +@Mixin(targets = "net.minecraft.network.protocol.game.ClientboundCommandsPacket$ArgumentNodeStub") public class CommandTreeSerializationMixin { + @Unique private static final Set BUILT_IN_REGISTRY_KEYS = Set.of("minecraft", "brigadier"); @Unique private static final int MOD_ARGUMENT_INDICATOR = -256; - @Inject(method = "write(Lnet/minecraft/network/PacketByteBuf;Lnet/minecraft/command/argument/serialize/ArgumentSerializer;Lnet/minecraft/command/argument/serialize/ArgumentSerializer$ArgumentTypeProperties;)V", + @Inject(method = "serializeCap(Lnet/minecraft/network/FriendlyByteBuf;Lnet/minecraft/commands/synchronization/ArgumentTypeInfo;Lnet/minecraft/commands/synchronization/ArgumentTypeInfo$Template;)V", at = @At("HEAD"), cancellable = true) - private static , T extends ArgumentSerializer.ArgumentTypeProperties> void writeNode$wrapInVelocityModArgument(PacketByteBuf buf, ArgumentSerializer serializer, ArgumentSerializer.ArgumentTypeProperties properties, CallbackInfo ci) { - Optional>> entry = Registries.COMMAND_ARGUMENT_TYPE.getKey(serializer) - .filter(keyed -> !BUILT_IN_REGISTRY_KEYS.contains(keyed.getValue().getNamespace())); + private static , T extends ArgumentTypeInfo.Template> void writeArgumentNode$wrapInVelocityModArgument( + FriendlyByteBuf buf, ArgumentTypeInfo info, T template, CallbackInfo ci) { + Optional>> entry = BuiltInRegistries.COMMAND_ARGUMENT_TYPE.getResourceKey(info) + .filter(resourceKey -> !BUILT_IN_REGISTRY_KEYS.contains(resourceKey.identifier().getNamespace())); if (entry.isPresent()) { // Not a standard Minecraft argument type - so we need to wrap it ci.cancel(); - serializeWrappedArgumentType(buf, serializer, properties); + serializeWrappedArgumentType(buf, info, template); } } @Unique - private static , T extends ArgumentSerializer.ArgumentTypeProperties> void serializeWrappedArgumentType(PacketByteBuf packetByteBuf, ArgumentSerializer serializer, ArgumentSerializer.ArgumentTypeProperties properties) { + private static , T extends ArgumentTypeInfo.Template> void serializeWrappedArgumentType( + FriendlyByteBuf packetByteBuf, ArgumentTypeInfo info, T template) { packetByteBuf.writeVarInt(MOD_ARGUMENT_INDICATOR); - packetByteBuf.writeVarInt(Registries.COMMAND_ARGUMENT_TYPE.getRawId(serializer)); + packetByteBuf.writeVarInt(BuiltInRegistries.COMMAND_ARGUMENT_TYPE.getId(info)); - PacketByteBuf extraData = new PacketByteBuf(Unpooled.buffer()); - serializer.writePacket((T) properties, extraData); + FriendlyByteBuf extraData = new FriendlyByteBuf(Unpooled.buffer()); + info.serializeToNetwork(template, extraData); packetByteBuf.writeVarInt(extraData.readableBytes()); packetByteBuf.writeBytes(extraData); } + } diff --git a/src/main/resources/crossstitch.mixins.json b/src/main/resources/crossstitch.mixins.json index 83c93ad..75392fc 100644 --- a/src/main/resources/crossstitch.mixins.json +++ b/src/main/resources/crossstitch.mixins.json @@ -2,12 +2,10 @@ "required": true, "minVersion": "0.8", "package": "com.velocitypowered.crossstitch.mixin", - "compatibilityLevel": "JAVA_8", - "mixins": [ + "compatibilityLevel": "JAVA_25", + "server": [ "command.CommandTreeSerializationMixin" ], - "client": [ - ], "injectors": { "defaultRequire": 1 } diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json index 0dcc55b..d961263 100644 --- a/src/main/resources/fabric.mod.json +++ b/src/main/resources/fabric.mod.json @@ -9,16 +9,15 @@ "Velocity Contributors" ], "contact": { - "website": "https://velocitypowered.com" + "homepage": "https://papermc.io/software/velocity", + "sources": "https://github.com/PaperMC/CrossStitch" }, "license": "MIT", - "icon": "assets/crossstitch/icon.png", "environment": "server", - "mixins": [ - "crossstitch.mixins.json" - ], + "mixins": [ "crossstitch.mixins.json" ], "depends": { - "fabricloader": ">=0.11", - "minecraft": ">=1.19.3" + "fabricloader": ">=${fabric_loader}", + "minecraft": ">=${minecraft}", + "java": ">=${java}" } }