├── .github └── workflows │ └── build.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main ├── java └── net │ └── hypixel │ └── modapi │ └── fabric │ ├── FabricModAPI.java │ ├── event │ ├── HypixelModAPICallback.java │ └── HypixelModAPIErrorCallback.java │ └── payload │ ├── ClientboundHypixelPayload.java │ └── ServerboundHypixelPayload.java └── resources ├── assets └── hypixel-mod-api │ └── icon.png └── fabric.mod.json /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | on: [ pull_request, push ] 3 | 4 | jobs: 5 | build: 6 | strategy: 7 | matrix: 8 | java: [ 21 ] 9 | runs-on: ubuntu-22.04 10 | steps: 11 | - name: checkout repository 12 | uses: actions/checkout@v4 13 | - name: validate gradle wrapper 14 | uses: gradle/wrapper-validation-action@v2 15 | - name: setup jdk ${{ matrix.java }} 16 | uses: actions/setup-java@v4 17 | with: 18 | java-version: ${{ matrix.java }} 19 | distribution: 'microsoft' 20 | - name: make gradle wrapper executable 21 | run: chmod +x ./gradlew 22 | - name: build 23 | run: ./gradlew build 24 | - name: capture build artifacts 25 | if: ${{ matrix.java == '21' }} # Only upload artifacts built from latest java 26 | uses: actions/upload-artifact@v4 27 | with: 28 | name: Artifacts 29 | path: build/libs/ -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # User-specific stuff 2 | .idea/ 3 | 4 | *.iml 5 | *.ipr 6 | *.iws 7 | 8 | # IntelliJ 9 | out/ 10 | # mpeltonen/sbt-idea plugin 11 | .idea_modules/ 12 | 13 | # JIRA plugin 14 | atlassian-ide-plugin.xml 15 | 16 | # Compiled class file 17 | *.class 18 | 19 | # Log file 20 | *.log 21 | 22 | # BlueJ files 23 | *.ctxt 24 | 25 | # Package Files # 26 | *.jar 27 | *.war 28 | *.nar 29 | *.ear 30 | *.zip 31 | *.tar.gz 32 | *.rar 33 | 34 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 35 | hs_err_pid* 36 | 37 | *~ 38 | 39 | # temporary files which can be created if a process still has a handle open of a deleted file 40 | .fuse_hidden* 41 | 42 | # KDE directory preferences 43 | .directory 44 | 45 | # Linux trash folder which might appear on any partition or disk 46 | .Trash-* 47 | 48 | # .nfs files are created when an open file is removed but is still being accessed 49 | .nfs* 50 | 51 | # General 52 | .DS_Store 53 | .AppleDouble 54 | .LSOverride 55 | 56 | # Icon must end with two \r 57 | Icon 58 | 59 | # Thumbnails 60 | ._* 61 | 62 | # Files that might appear in the root of a volume 63 | .DocumentRevisions-V100 64 | .fseventsd 65 | .Spotlight-V100 66 | .TemporaryItems 67 | .Trashes 68 | .VolumeIcon.icns 69 | .com.apple.timemachine.donotpresent 70 | 71 | # Directories potentially created on remote AFP share 72 | .AppleDB 73 | .AppleDesktop 74 | Network Trash Folder 75 | Temporary Items 76 | .apdisk 77 | 78 | # Windows thumbnail cache files 79 | Thumbs.db 80 | Thumbs.db:encryptable 81 | ehthumbs.db 82 | ehthumbs_vista.db 83 | 84 | # Dump file 85 | *.stackdump 86 | 87 | # Folder config file 88 | [Dd]esktop.ini 89 | 90 | # Recycle Bin used on file shares 91 | $RECYCLE.BIN/ 92 | 93 | # Windows Installer files 94 | *.cab 95 | *.msi 96 | *.msix 97 | *.msm 98 | *.msp 99 | 100 | # Windows shortcuts 101 | *.lnk 102 | 103 | .gradle 104 | build/ 105 | 106 | # Ignore Gradle GUI config 107 | gradle-app.setting 108 | 109 | # Cache of project 110 | .gradletasknamecache 111 | 112 | **/build/ 113 | 114 | # Common working directory 115 | run/ 116 | 117 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 118 | !gradle-wrapper.jar 119 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2024 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Fabric Mod API 2 | 3 | This repository contains the implementation of the Hypixel Mod API for the Fabric Mod Loader for end-users. If you are a developer, and are looking to utilise the API you should look at the core [Hypixel Mod API](https://github.com/HypixelDev/ModAPI) repository. -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'fabric-loom' version '1.10-SNAPSHOT' 3 | id 'maven-publish' 4 | } 5 | 6 | version = "${project.mod_version}+mc${project.minecraft_version}" 7 | group = project.maven_group 8 | 9 | base { 10 | archivesName = project.archives_base_name 11 | } 12 | 13 | repositories { 14 | // Add repositories to retrieve artifacts from in here. 15 | // You should only use this when depending on other mods because 16 | // Loom adds the essential maven repositories to download Minecraft and libraries from automatically. 17 | // See https://docs.gradle.org/current/userguide/declaring_repositories.html 18 | // for more information about repositories. 19 | maven { 20 | url "https://repo.hypixel.net/repository/Hypixel/" 21 | } 22 | mavenLocal() 23 | } 24 | 25 | dependencies { 26 | // To change the versions see the gradle.properties file 27 | minecraft "com.mojang:minecraft:${project.minecraft_version}" 28 | mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2" 29 | modImplementation "net.fabricmc:fabric-loader:${project.loader_version}" 30 | modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" 31 | 32 | include modImplementation("net.hypixel:mod-api:${project.mod_api_version}") 33 | } 34 | 35 | processResources { 36 | inputs.property "version", project.version 37 | inputs.property "minecraft_version", project.minecraft_version 38 | inputs.property "loader_version", project.loader_version 39 | filteringCharset "UTF-8" 40 | 41 | filesMatching("fabric.mod.json") { 42 | expand "version": project.version, 43 | "minecraft_version": project.minecraft_version, 44 | "loader_version": project.loader_version 45 | } 46 | } 47 | 48 | def targetJavaVersion = 17 49 | tasks.withType(JavaCompile).configureEach { 50 | // ensure that the encoding is set to UTF-8, no matter what the system default is 51 | // this fixes some edge cases with special characters not displaying correctly 52 | // see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html 53 | // If Javadoc is generated, this must be specified in that task too. 54 | it.options.encoding = "UTF-8" 55 | if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) { 56 | it.options.release.set(targetJavaVersion) 57 | } 58 | } 59 | 60 | java { 61 | def javaVersion = JavaVersion.toVersion(targetJavaVersion) 62 | if (JavaVersion.current() < javaVersion) { 63 | toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) 64 | } 65 | // Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task 66 | // if it is present. 67 | // If you remove this line, sources will not be generated. 68 | withSourcesJar() 69 | } 70 | 71 | jar { 72 | from("LICENSE") { 73 | rename { "${it}_${project.archivesBaseName}"} 74 | } 75 | } 76 | 77 | // configure the maven publication 78 | publishing { 79 | publications { 80 | mavenJava(MavenPublication) { 81 | from components.java 82 | } 83 | } 84 | 85 | // See https://docs.gradle.org/current/userguide/publishing_maven.html for information on how to set up publishing. 86 | repositories { 87 | // Add repositories to publish to here. 88 | // Notice: This block does NOT have the same function as the block in the top level. 89 | // The repositories here will be used for publishing your artifact, not for 90 | // retrieving dependencies. 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Done to increase the memory available to gradle. 2 | org.gradle.jvmargs=-Xmx1G 3 | 4 | # Fabric Properties 5 | # check these on https://modmuss50.me/fabric.html 6 | minecraft_version=1.21 7 | yarn_mappings=1.21+build.9 8 | loader_version=0.16.10 9 | 10 | # Mod Properties 11 | mod_version = 1.0.1+build.dev 12 | maven_group = net.hypixel 13 | archives_base_name = HypixelModAPI 14 | mod_api_version = dev-SNAPSHOT 15 | 16 | # Dependencies 17 | # check this on https://modmuss50.me/fabric.html 18 | fabric_version=0.102.0+1.21 19 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HypixelDev/FabricModAPI/b75a53e8afe2370bd6bed2663b7b726b0364bdea/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 1>&2 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 48 | echo. 1>&2 49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 50 | echo location of your Java installation. 1>&2 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 1>&2 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 62 | echo. 1>&2 63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 64 | echo location of your Java installation. 1>&2 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | maven { 4 | name = 'Fabric' 5 | url = 'https://maven.fabricmc.net/' 6 | } 7 | gradlePluginPortal() 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /src/main/java/net/hypixel/modapi/fabric/FabricModAPI.java: -------------------------------------------------------------------------------- 1 | package net.hypixel.modapi.fabric; 2 | 3 | import com.mojang.logging.LogUtils; 4 | import net.fabricmc.api.ClientModInitializer; 5 | import net.fabricmc.fabric.api.client.networking.v1.ClientConfigurationNetworking; 6 | import net.fabricmc.fabric.api.client.networking.v1.ClientPlayConnectionEvents; 7 | import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking; 8 | import net.fabricmc.fabric.api.networking.v1.PayloadTypeRegistry; 9 | import net.fabricmc.loader.api.FabricLoader; 10 | import net.hypixel.modapi.HypixelModAPI; 11 | import net.hypixel.modapi.HypixelModAPIImplementation; 12 | import net.hypixel.modapi.fabric.event.HypixelModAPICallback; 13 | import net.hypixel.modapi.fabric.event.HypixelModAPIErrorCallback; 14 | import net.hypixel.modapi.fabric.payload.ClientboundHypixelPayload; 15 | import net.hypixel.modapi.fabric.payload.ServerboundHypixelPayload; 16 | import net.hypixel.modapi.packet.HypixelPacket; 17 | import net.hypixel.modapi.packet.impl.clientbound.ClientboundHelloPacket; 18 | import net.hypixel.modapi.packet.impl.clientbound.event.ClientboundLocationPacket; 19 | import net.minecraft.client.MinecraftClient; 20 | import net.minecraft.network.PacketByteBuf; 21 | import net.minecraft.network.codec.PacketCodec; 22 | import net.minecraft.network.packet.CustomPayload; 23 | import net.minecraft.test.GameTest; 24 | import net.minecraft.util.Identifier; 25 | import org.jetbrains.annotations.ApiStatus; 26 | import org.slf4j.Logger; 27 | 28 | public class FabricModAPI implements ClientModInitializer, HypixelModAPIImplementation { 29 | private static final Logger LOGGER = LogUtils.getLogger(); 30 | private static final boolean DEBUG_MODE = FabricLoader.getInstance().isDevelopmentEnvironment() || Boolean.getBoolean("net.hypixel.modapi.debug"); 31 | 32 | private boolean onHypixel = false; 33 | 34 | @GameTest 35 | @Override 36 | public void onInitializeClient() { 37 | HypixelModAPI.getInstance().setModImplementation(this); 38 | } 39 | 40 | @Override 41 | public void onInit() { 42 | HypixelModAPI.getInstance().createHandler(ClientboundHelloPacket.class, packet -> onHypixel = true); 43 | ClientPlayConnectionEvents.DISCONNECT.register((handler, client) -> onHypixel = false); 44 | 45 | if (DEBUG_MODE) { 46 | LOGGER.info("Debug mode is enabled!"); 47 | registerDebug(); 48 | } 49 | 50 | reloadRegistrations(); 51 | } 52 | 53 | @Override 54 | public boolean sendPacket(HypixelPacket packet) { 55 | if (!isConnectedToHypixel()) { 56 | return false; 57 | } 58 | 59 | ServerboundHypixelPayload hypixelPayload = new ServerboundHypixelPayload(packet); 60 | 61 | if (MinecraftClient.getInstance().getNetworkHandler() != null) { 62 | ClientPlayNetworking.send(hypixelPayload); 63 | return true; 64 | } 65 | 66 | try { 67 | ClientConfigurationNetworking.send(hypixelPayload); 68 | return true; 69 | } catch (IllegalStateException ignored) { 70 | LOGGER.warn("Failed to send a packet as the client is not connected to a server '{}'", packet); 71 | return false; 72 | } 73 | } 74 | 75 | @Override 76 | public boolean isConnectedToHypixel() { 77 | return onHypixel; 78 | } 79 | 80 | /** 81 | * Reloads the identifiers that are registered in the Hypixel Mod API and makes sure that the packets are registered. 82 | *

83 | * This method is available for internal use by Hypixel to add new packets externally, and is not intended for use by other developers. 84 | */ 85 | @ApiStatus.Internal 86 | public static void reloadRegistrations() { 87 | for (String identifier : HypixelModAPI.getInstance().getRegistry().getClientboundIdentifiers()) { 88 | try { 89 | registerClientbound(identifier); 90 | LOGGER.info("Registered clientbound packet with identifier '{}'", identifier); 91 | } catch (Exception e) { 92 | LOGGER.error("Failed to register clientbound packet with identifier '{}'", identifier, e); 93 | } 94 | } 95 | 96 | for (String identifier : HypixelModAPI.getInstance().getRegistry().getServerboundIdentifiers()) { 97 | try { 98 | registerServerbound(identifier); 99 | LOGGER.info("Registered serverbound packet with identifier '{}'", identifier); 100 | } catch (Exception e) { 101 | LOGGER.error("Failed to register serverbound packet with identifier '{}'", identifier, e); 102 | } 103 | } 104 | } 105 | 106 | private static void registerClientbound(String identifier) { 107 | try { 108 | CustomPayload.Id clientboundId = new CustomPayload.Id<>(Identifier.of(identifier)); 109 | PacketCodec codec = ClientboundHypixelPayload.buildCodec(clientboundId); 110 | PayloadTypeRegistry.playS2C().register(clientboundId, codec); 111 | PayloadTypeRegistry.configurationS2C().register(clientboundId, codec); 112 | 113 | // Also register the global receiver for handling incoming packets during PLAY and CONFIGURATION 114 | ClientPlayNetworking.registerGlobalReceiver(clientboundId, (payload, context) -> { 115 | LOGGER.debug("Received packet with identifier '{}', during PLAY", identifier); 116 | handleIncomingPayload(identifier, payload); 117 | 118 | }); 119 | ClientConfigurationNetworking.registerGlobalReceiver(clientboundId, (payload, context) -> { 120 | LOGGER.debug("Received packet with identifier '{}', during CONFIGURATION", identifier); 121 | handleIncomingPayload(identifier, payload); 122 | }); 123 | } catch (IllegalArgumentException ignored) { 124 | // Ignored as this is fired when we reload the registrations and the packet is already registered 125 | } 126 | } 127 | 128 | private static void handleIncomingPayload(String identifier, ClientboundHypixelPayload payload) { 129 | if (!payload.isSuccess()) { 130 | LOGGER.warn("Received an error response for packet {}: {}", identifier, payload.getErrorReason()); 131 | try { 132 | HypixelModAPI.getInstance().handleError(identifier, payload.getErrorReason()); 133 | } catch (Exception e) { 134 | LOGGER.error("An error occurred while handling error response for packet {}", identifier, e); 135 | } 136 | 137 | try { 138 | HypixelModAPIErrorCallback.EVENT.invoker().onError(identifier, payload.getErrorReason()); 139 | } catch (Exception e) { 140 | LOGGER.error("An error occurred while handling error response for packet {}", identifier, e); 141 | } 142 | return; 143 | } 144 | 145 | try { 146 | HypixelModAPI.getInstance().handle(payload.getPacket()); 147 | } catch (Exception e) { 148 | LOGGER.error("An error occurred while handling packet {}", identifier, e); 149 | } 150 | 151 | try { 152 | HypixelModAPICallback.EVENT.invoker().onPacketReceived(payload.getPacket()); 153 | } catch (Exception e) { 154 | LOGGER.error("An error occurred while handling packet {}", identifier, e); 155 | } 156 | } 157 | 158 | private static void registerServerbound(String identifier) { 159 | try { 160 | CustomPayload.Id serverboundId = new CustomPayload.Id<>(Identifier.of(identifier)); 161 | PacketCodec codec = ServerboundHypixelPayload.buildCodec(serverboundId); 162 | PayloadTypeRegistry.playC2S().register(serverboundId, codec); 163 | PayloadTypeRegistry.configurationC2S().register(serverboundId, codec); 164 | } catch (IllegalArgumentException ignored) { 165 | // Ignored as this is fired when we reload the registrations and the packet is already registered 166 | } 167 | } 168 | 169 | private static void registerDebug() { 170 | // Register events 171 | HypixelModAPI.getInstance().subscribeToEventPacket(ClientboundLocationPacket.class); 172 | 173 | HypixelModAPI.getInstance().createHandler(ClientboundLocationPacket.class, packet -> LOGGER.info("Received location packet {}", packet)) 174 | .onError(error -> LOGGER.error("Received error response for location packet: {}", error)); 175 | 176 | HypixelModAPICallback.EVENT.register(packet -> LOGGER.info("Received packet {}", packet)); 177 | HypixelModAPIErrorCallback.EVENT.register((identifier, error) -> LOGGER.error("Received error response for packet {}: {}", identifier, error)); 178 | } 179 | } 180 | -------------------------------------------------------------------------------- /src/main/java/net/hypixel/modapi/fabric/event/HypixelModAPICallback.java: -------------------------------------------------------------------------------- 1 | package net.hypixel.modapi.fabric.event; 2 | 3 | import net.fabricmc.fabric.api.event.Event; 4 | import net.fabricmc.fabric.api.event.EventFactory; 5 | import net.hypixel.modapi.packet.ClientboundHypixelPacket; 6 | 7 | /** 8 | * Callback for when a Hypixel Mod API packet is received. 9 | */ 10 | public interface HypixelModAPICallback { 11 | 12 | Event EVENT = EventFactory.createArrayBacked(HypixelModAPICallback.class, callbacks -> packet -> { 13 | for (HypixelModAPICallback callback : callbacks) { 14 | callback.onPacketReceived(packet); 15 | } 16 | }); 17 | 18 | void onPacketReceived(ClientboundHypixelPacket packet); 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/net/hypixel/modapi/fabric/event/HypixelModAPIErrorCallback.java: -------------------------------------------------------------------------------- 1 | package net.hypixel.modapi.fabric.event; 2 | 3 | import net.fabricmc.fabric.api.event.Event; 4 | import net.fabricmc.fabric.api.event.EventFactory; 5 | import net.hypixel.modapi.error.ErrorReason; 6 | 7 | /** 8 | * Callback for when a Hypixel Mod API error reason is received. 9 | */ 10 | public interface HypixelModAPIErrorCallback { 11 | 12 | Event EVENT = EventFactory.createArrayBacked(HypixelModAPIErrorCallback.class, callbacks -> (identifier, reason) -> { 13 | for (HypixelModAPIErrorCallback callback : callbacks) { 14 | callback.onError(identifier, reason); 15 | } 16 | }); 17 | 18 | void onError(String identifier, ErrorReason reason); 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/net/hypixel/modapi/fabric/payload/ClientboundHypixelPayload.java: -------------------------------------------------------------------------------- 1 | package net.hypixel.modapi.fabric.payload; 2 | 3 | import net.hypixel.modapi.HypixelModAPI; 4 | import net.hypixel.modapi.error.ErrorReason; 5 | import net.hypixel.modapi.packet.ClientboundHypixelPacket; 6 | import net.hypixel.modapi.serializer.PacketSerializer; 7 | import net.minecraft.network.PacketByteBuf; 8 | import net.minecraft.network.codec.PacketCodec; 9 | import net.minecraft.network.packet.CustomPayload; 10 | 11 | public class ClientboundHypixelPayload implements CustomPayload { 12 | private final Id id; 13 | 14 | private ClientboundHypixelPacket packet; 15 | private ErrorReason errorReason; 16 | 17 | private ClientboundHypixelPayload(Id id, PacketByteBuf buf) { 18 | this.id = id; 19 | 20 | PacketSerializer serializer = new PacketSerializer(buf); 21 | boolean success = serializer.readBoolean(); 22 | if (!success) { 23 | this.errorReason = ErrorReason.getById(serializer.readVarInt()); 24 | return; 25 | } 26 | 27 | this.packet = HypixelModAPI.getInstance().getRegistry().createClientboundPacket(id.id().toString(), serializer); 28 | } 29 | 30 | @Override 31 | public Id getId() { 32 | return id; 33 | } 34 | 35 | public boolean isSuccess() { 36 | return packet != null; 37 | } 38 | 39 | public ClientboundHypixelPacket getPacket() { 40 | return packet; 41 | } 42 | 43 | public ErrorReason getErrorReason() { 44 | return errorReason; 45 | } 46 | 47 | public static PacketCodec buildCodec(Id id) { 48 | return CustomPayload.codecOf((value, buf) -> { 49 | throw new UnsupportedOperationException("Cannot write ClientboundHypixelPayload"); 50 | }, buf -> new ClientboundHypixelPayload(id, buf)); 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/main/java/net/hypixel/modapi/fabric/payload/ServerboundHypixelPayload.java: -------------------------------------------------------------------------------- 1 | package net.hypixel.modapi.fabric.payload; 2 | 3 | import net.hypixel.modapi.packet.HypixelPacket; 4 | import net.hypixel.modapi.serializer.PacketSerializer; 5 | import net.minecraft.network.PacketByteBuf; 6 | import net.minecraft.network.codec.PacketCodec; 7 | import net.minecraft.network.packet.CustomPayload; 8 | import net.minecraft.util.Identifier; 9 | 10 | public class ServerboundHypixelPayload implements CustomPayload { 11 | private final Id id; 12 | private final HypixelPacket packet; 13 | 14 | public ServerboundHypixelPayload(HypixelPacket packet) { 15 | this.id = new CustomPayload.Id<>(Identifier.of(packet.getIdentifier())); 16 | this.packet = packet; 17 | } 18 | 19 | private void write(PacketByteBuf buf) { 20 | PacketSerializer serializer = new PacketSerializer(buf); 21 | packet.write(serializer); 22 | } 23 | 24 | @Override 25 | public Id getId() { 26 | return id; 27 | } 28 | 29 | public static PacketCodec buildCodec(Id id) { 30 | return CustomPayload.codecOf(ServerboundHypixelPayload::write, buf -> { 31 | throw new UnsupportedOperationException("Cannot read ServerboundHypixelPayload"); 32 | }); 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/main/resources/assets/hypixel-mod-api/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HypixelDev/FabricModAPI/b75a53e8afe2370bd6bed2663b7b726b0364bdea/src/main/resources/assets/hypixel-mod-api/icon.png -------------------------------------------------------------------------------- /src/main/resources/fabric.mod.json: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 1, 3 | "id": "hypixel-mod-api", 4 | "version": "${version}", 5 | "name": "Hypixel Mod API", 6 | "description": "", 7 | "authors": [], 8 | "contact": { 9 | "repo": "https://github.com/HypixelDev/FabricModAPI" 10 | }, 11 | "license": "MIT", 12 | "icon": "assets/hypixel-mod-api/icon.png", 13 | "environment": "client", 14 | "entrypoints": { 15 | "client": [ 16 | "net.hypixel.modapi.fabric.FabricModAPI" 17 | ] 18 | }, 19 | "depends": { 20 | "fabricloader": ">=${loader_version}", 21 | "fabric": "*", 22 | "minecraft": ">=${minecraft_version}" 23 | } 24 | } 25 | --------------------------------------------------------------------------------