Initial implementation for the fabric loader

Author: ConnorLinfoot

.gitignore

@@ -0,0 +1,118 @@
+# User-specific stuff
+.idea/
+
+*.iml
+*.ipr
+*.iws
+
+# IntelliJ
+out/
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+.gradle
+build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Cache of project
+.gradletasknamecache
+
+**/build/
+
+# Common working directory
+run/
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

build.gradle

@@ -0,0 +1,108 @@
+plugins {
+    id 'fabric-loom' version '1.6-SNAPSHOT'
+    id 'maven-publish'
+    id 'com.github.johnrengelman.shadow' version '7.0.0'
+}
+
+version = "${project.mod_version}+mc${project.minecraft_version}"
+group = project.maven_group
+
+base {
+    archivesName = project.archives_base_name
+}
+
+repositories {
+    // Add repositories to retrieve artifacts from in here.
+    // You should only use this when depending on other mods because
+    // Loom adds the essential maven repositories to download Minecraft and libraries from automatically.
+    // See https://docs.gradle.org/current/userguide/declaring_repositories.html
+    // for more information about repositories.
+    maven {
+        url "https://repo.hypixel.net/repository/Hypixel/"
+    }
+    mavenLocal()
+}
+
+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}"
+
+    // Fabric API. This is technically optional, but you probably want it anyway.
+    modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}"
+
+    shadow "net.hypixel:mod-api:${project.mod_api_version}"
+}
+
+shadowJar {
+    // Exclude all dependencies by default
+    configurations = [project.configurations.shadow]
+
+    // Rename the shaded JAR
+    archiveClassifier = 'shaded'
+}
+
+remapJar {
+    dependsOn(shadowJar)
+    inputFile = tasks.shadowJar.archiveFile
+}
+
+processResources {
+    inputs.property "version", project.version
+    inputs.property "minecraft_version", project.minecraft_version
+    inputs.property "loader_version", project.loader_version
+    filteringCharset "UTF-8"
+
+    filesMatching("fabric.mod.json") {
+        expand "version": project.version,
+                "minecraft_version": project.minecraft_version,
+                "loader_version": project.loader_version
+    }
+}
+
+def targetJavaVersion = 17
+tasks.withType(JavaCompile).configureEach {
+    // 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
+    // If Javadoc is generated, this must be specified in that task too.
+    it.options.encoding = "UTF-8"
+    if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) {
+        it.options.release.set(targetJavaVersion)
+    }
+}
+
+java {
+    def javaVersion = JavaVersion.toVersion(targetJavaVersion)
+    if (JavaVersion.current() < javaVersion) {
+        toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion)
+    }
+    // Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task
+    // if it is present.
+    // If you remove this line, sources will not be generated.
+    withSourcesJar()
+}
+
+jar {
+    from("LICENSE") {
+        rename { "${it}_${project.archivesBaseName}"}
+    }
+}
+
+// configure the maven publication
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            from components.java
+        }
+    }
+
+    // See https://docs.gradle.org/current/userguide/publishing_maven.html for information on how to set up publishing.
+    repositories {
+        // Add repositories to publish to here.
+        // Notice: This block does NOT have the same function as the block in the top level.
+        // The repositories here will be used for publishing your artifact, not for
+        // retrieving dependencies.
+    }
+}

gradle.properties

@@ -0,0 +1,18 @@
+# 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.20.5
+	yarn_mappings=1.20.5+build.1
+	loader_version=0.15.10
+
+# Mod Properties
+	mod_version = 0.3.2
+	maven_group = net.hypixel
+	archives_base_name = HypixelModAPI
+	mod_api_version = 0.3.2
+
+# Dependencies
+	# check this on https://modmuss50.me/fabric.html
+	fabric_version=0.97.8+1.20.6

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1 @@
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip

settings.gradle

@@ -0,0 +1,9 @@
+pluginManagement {
+    repositories {
+        maven {
+            name = 'Fabric'
+            url = 'https://maven.fabricmc.net/'
+        }
+        gradlePluginPortal()
+    }
+}

src/main/java/net/hypixel/modapi/fabric/FabricModAPI.java

@@ -0,0 +1,64 @@
+package net.hypixel.modapi.fabric;
+
+import com.mojang.logging.LogUtils;
+import net.fabricmc.api.ClientModInitializer;
+import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
+import net.fabricmc.fabric.api.networking.v1.PayloadTypeRegistry;
+import net.hypixel.modapi.HypixelModAPI;
+import net.hypixel.modapi.fabric.payload.ClientboundHypixelPayload;
+import net.hypixel.modapi.fabric.payload.ServerboundHypixelPayload;
+import net.minecraft.network.PacketByteBuf;
+import net.minecraft.network.codec.PacketCodec;
+import net.minecraft.network.packet.CustomPayload;
+import org.apache.commons.lang3.Validate;
+import org.slf4j.Logger;
+
+public class FabricModAPI implements ClientModInitializer {
+    private static final Logger LOGGER = LogUtils.getLogger();
+
+    @Override
+    public void onInitializeClient() {
+        registerPayloads();
+        registerPacketSender();
+    }
+
+    private void registerPayloads() {
+        for (String identifier : HypixelModAPI.getInstance().getRegistry().getIdentifiers()) {
+            registerClientbound(identifier);
+            registerServerbound(identifier);
+        }
+    }
+
+    private void registerPacketSender() {
+        HypixelModAPI.getInstance().setPacketSender((packet) -> {
+            ServerboundHypixelPayload payload = new ServerboundHypixelPayload(packet);
+            ClientPlayNetworking.send(payload);
+        });
+    }
+
+    public void registerClientbound(String identifier) {
+        Validate.isTrue(HypixelModAPI.getInstance().getRegistry().isRegistered(identifier), "Identifier %s is not registered", identifier);
+
+        CustomPayload.Id<ClientboundHypixelPayload> clientboundId = CustomPayload.id(identifier);
+        PacketCodec<PacketByteBuf, ClientboundHypixelPayload> codec = ClientboundHypixelPayload.buildCodec(clientboundId);
+        PayloadTypeRegistry.playS2C().register(clientboundId, codec);
+
+        // Also register the global receiver for handling incoming packets
+        ClientPlayNetworking.registerGlobalReceiver(clientboundId, (payload, context) -> {
+            if (!payload.isSuccess()) {
+                LOGGER.warn("Received an error response for packet {}: {}", identifier, payload.getErrorReason());
+                return;
+            }
+
+            HypixelModAPI.getInstance().handle(payload.getPacket());
+        });
+    }
+
+    public void registerServerbound(String identifier) {
+        Validate.isTrue(HypixelModAPI.getInstance().getRegistry().isRegistered(identifier), "Identifier %s is not registered", identifier);
+
+        CustomPayload.Id<ServerboundHypixelPayload> serverboundId = CustomPayload.id(identifier);
+        PacketCodec<PacketByteBuf, ServerboundHypixelPayload> codec = ServerboundHypixelPayload.buildCodec(serverboundId);
+        PayloadTypeRegistry.playC2S().register(serverboundId, codec);
+    }
+}

src/main/java/net/hypixel/modapi/fabric/payload/ClientboundHypixelPayload.java

@@ -0,0 +1,52 @@
+package net.hypixel.modapi.fabric.payload;
+
+import net.hypixel.modapi.HypixelModAPI;
+import net.hypixel.modapi.error.ErrorReason;
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.serializer.PacketSerializer;
+import net.minecraft.network.PacketByteBuf;
+import net.minecraft.network.codec.PacketCodec;
+import net.minecraft.network.packet.CustomPayload;
+
+public class ClientboundHypixelPayload implements CustomPayload {
+    private final Id<ClientboundHypixelPayload> id;
+
+    private ClientboundHypixelPacket packet;
+    private ErrorReason errorReason;
+
+    private ClientboundHypixelPayload(Id<ClientboundHypixelPayload> id, PacketByteBuf buf) {
+        this.id = id;
+
+        PacketSerializer serializer = new PacketSerializer(buf);
+        boolean success = serializer.readBoolean();
+        if (!success) {
+            this.errorReason = ErrorReason.getById(serializer.readVarInt());
+            return;
+        }
+
+        this.packet = HypixelModAPI.getInstance().getRegistry().createClientboundPacket(id.id().toString(), serializer);
+    }
+
+    @Override
+    public Id<? extends CustomPayload> getId() {
+        return id;
+    }
+
+    public boolean isSuccess() {
+        return packet != null;
+    }
+
+    public ClientboundHypixelPacket getPacket() {
+        return packet;
+    }
+
+    public ErrorReason getErrorReason() {
+        return errorReason;
+    }
+
+    public static PacketCodec<PacketByteBuf, ClientboundHypixelPayload> buildCodec(Id<ClientboundHypixelPayload> id) {
+        return CustomPayload.codecOf((value, buf) -> {
+            throw new UnsupportedOperationException("Cannot write ClientboundHypixelPayload");
+        }, buf -> new ClientboundHypixelPayload(id, buf));
+    }
+}