First public version of the Mod API

Author: ConnorLinfoot

.gitignore

@@ -0,0 +1,35 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### IntelliJ IDEA ###
+.idea/
+*.iws
+*.iml
+*.ipr
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

README.md

@@ -1 +1,5 @@
-# ModAPI
+# Hypixel Mod API
+
+The Hypixel Mod API is an implementation of custom packets for communicating with the Hypixel Server via plugin messages.
+
+At this time the API is in an early preview state to obtain feedback from the community. The API is subject to change and may be changed or disabled at any time. You can read more about on the [announcement forum thread](https://hypixel.net/threads/hypixel-mod-api-developer-preview-feedback.5635119/).

pom.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>net.hypixel</groupId>
+    <artifactId>mod-api</artifactId>
+    <version>0.1.6</version>
+
+    <properties>
+        <maven.compiler.source>8</maven.compiler.source>
+        <maven.compiler.target>8</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <distributionManagement>
+        <repository>
+            <id>Hypixel</id>
+            <url>https://repo.hypixel.net/repository/Hypixel/</url>
+        </repository>
+    </distributionManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>24.0.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-all</artifactId>
+            <version>4.0.56.Final</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>5.9.2</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>2.3.2</version>
+                <configuration>
+                    <encoding>UTF-8</encoding>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

src/main/java/net/hypixel/modapi/HypixelModAPI.java

@@ -0,0 +1,49 @@
+package net.hypixel.modapi;
+
+import net.hypixel.modapi.handler.ClientboundPacketHandler;
+import net.hypixel.modapi.packet.HypixelPacket;
+import net.hypixel.modapi.packet.HypixelPacketType;
+import net.hypixel.modapi.serializer.PacketSerializer;
+
+import java.util.List;
+import java.util.concurrent.CopyOnWriteArrayList;
+
+public class HypixelModAPI {
+    private static final HypixelModAPI INSTANCE = new HypixelModAPI();
+
+    public static HypixelModAPI getInstance() {
+        return INSTANCE;
+    }
+
+    private final List<ClientboundPacketHandler> packetHandlers = new CopyOnWriteArrayList<>();
+
+    private HypixelModAPI() {
+    }
+
+    public void registerHandler(ClientboundPacketHandler handler) {
+        packetHandlers.add(handler);
+    }
+
+    public void handle(String identifier, PacketSerializer serializer) {
+        if (packetHandlers.isEmpty()) {
+            return;
+        }
+
+        HypixelPacketType packetType = HypixelPacketType.getByIdentifier(identifier);
+        if (packetType == null) {
+            return;
+        }
+
+        // All responses contain a boolean of if the response is a success, if not then a string is included with the error message
+        if (!serializer.readBoolean()) {
+            String errorMessage = serializer.readString();
+            throw new RuntimeException("Received error response for packet " + packetType + ": " + errorMessage);
+        }
+
+        HypixelPacket packet = packetType.getPacketFactory().apply(serializer);
+        for (ClientboundPacketHandler handler : packetHandlers) {
+            handler.handle(packet);
+        }
+    }
+
+}

src/main/java/net/hypixel/modapi/data/Environment.java

@@ -0,0 +1,10 @@
+package net.hypixel.modapi.data;
+
+public enum Environment {
+    PRODUCTION, // The Production Hypixel Network - "mc.hypixel.net"
+    BETA, // The Alpha Hypixel Network - "alpha.hypixel.net"
+    TEST, // The Test Hypixel Network - For Hypixel Developers
+    ;
+
+    public static final Environment[] VALUES = values();
+}

src/main/java/net/hypixel/modapi/handler/ClientboundPacketHandler.java

@@ -0,0 +1,33 @@
+package net.hypixel.modapi.handler;
+
+import net.hypixel.modapi.packet.HypixelPacket;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundLocationPacket;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPartyInfoPacket;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPingPacket;
+
+public interface ClientboundPacketHandler extends PacketHandler {
+
+    default void handle(HypixelPacket packet) {
+        if (packet instanceof ClientboundPingPacket) {
+            onPingPacket((ClientboundPingPacket) packet);
+        }
+
+        if (packet instanceof ClientboundLocationPacket) {
+            onLocationPacket((ClientboundLocationPacket) packet);
+        }
+
+        if (packet instanceof ClientboundPartyInfoPacket) {
+            onPartyInfoPacket((ClientboundPartyInfoPacket) packet);
+        }
+    }
+
+    default void onPingPacket(ClientboundPingPacket packet) {
+    }
+
+    default void onLocationPacket(ClientboundLocationPacket packet) {
+    }
+
+    default void onPartyInfoPacket(ClientboundPartyInfoPacket packet) {
+    }
+
+}

src/main/java/net/hypixel/modapi/handler/PacketHandler.java

@@ -0,0 +1,9 @@
+package net.hypixel.modapi.handler;
+
+import net.hypixel.modapi.packet.HypixelPacket;
+
+public interface PacketHandler {
+
+    void handle(HypixelPacket packet);
+
+}

src/main/java/net/hypixel/modapi/packet/HypixelPacket.java

@@ -0,0 +1,11 @@
+package net.hypixel.modapi.packet;
+
+import net.hypixel.modapi.serializer.PacketSerializer;
+
+public interface HypixelPacket {
+
+    HypixelPacketType getType();
+
+    void write(PacketSerializer serializer);
+
+}

src/main/java/net/hypixel/modapi/packet/HypixelPacketType.java

@@ -0,0 +1,42 @@
+package net.hypixel.modapi.packet;
+
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundLocationPacket;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPartyInfoPacket;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPingPacket;
+import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+
+public enum HypixelPacketType {
+    PING(ClientboundPingPacket::new),
+    LOCATION(ClientboundLocationPacket::new),
+    PARTY_INFO(ClientboundPartyInfoPacket::new),
+    ;
+    private static final String IDENTIFIER_PREFIX = "hypixel:";
+    private static final Map<String, HypixelPacketType> BY_IDENTIFIER = Arrays.stream(values()).collect(HashMap::new, (map, type) -> map.put(type.getIdentifier(), type), HashMap::putAll);
+    private final Function<PacketSerializer, HypixelPacket> packetFactory;
+
+    @Nullable
+    public static HypixelPacketType getByIdentifier(String identifier) {
+        return BY_IDENTIFIER.get(identifier);
+    }
+
+    private final String identifier;
+
+    HypixelPacketType(Function<PacketSerializer, HypixelPacket> packetFactory) {
+        this.identifier = IDENTIFIER_PREFIX + name().toLowerCase();
+        this.packetFactory = packetFactory;
+    }
+
+    public String getIdentifier() {
+        return identifier;
+    }
+
+    public Function<PacketSerializer, HypixelPacket> getPacketFactory() {
+        return packetFactory;
+    }
+}

src/main/java/net/hypixel/modapi/packet/impl/VersionedPacket.java

@@ -0,0 +1,32 @@
+package net.hypixel.modapi.packet.impl;
+
+import net.hypixel.modapi.packet.HypixelPacket;
+import net.hypixel.modapi.serializer.PacketSerializer;
+
+public abstract class VersionedPacket implements HypixelPacket {
+    private final byte version;
+
+    public VersionedPacket(byte version) {
+        this.version = version;
+    }
+
+    public VersionedPacket(PacketSerializer byteBuf) {
+        this.version = byteBuf.readByte();
+    }
+
+    @Override
+    public void write(PacketSerializer serializer) {
+        serializer.writeByte(version);
+    }
+
+    public byte getVersion() {
+        return version;
+    }
+
+    @Override
+    public String toString() {
+        return "VersionedPacket{" +
+                "version=" + version +
+                '}';
+    }
+}