Hypixel Mod API

The Hypixel Mod API is an implementation of custom packets for communicating with the Hypixel Server via plugin messages.

Mod Distributions

Official downloads of the Hypixel Mod API can be found on Modrinth. To install the mod, simply download the JAR file and place it in your mods folder.

Currently, the Hypixel Mod API supports the following mod loaders and versions:

If there is significant demand, support for additional versions and loaders may be considered.

Developer Usage

It is recommended to read over the FAQ on the GitHub Wiki before implementing the Mod API.

For using the Mod API you will need to add it as a dependency to your project. This can be done via the public Hypixel Maven repository.

<repository>
    <id>Hypixel</id>
    <url>https://repo.hypixel.net/repository/Hypixel/</url>
</repository>

This repo can also be used with Gradle.

repositories {
    maven { url 'https://repo.hypixel.net/repository/Hypixel/' }
}

You can then include the dependency in your project.

<dependency>
    <groupId>net.hypixel</groupId>
    <artifactId>mod-api</artifactId>
    <version>1.0.1</version>
</dependency>

dependencies {
    implementation 'net.hypixel:mod-api:1.0.1'
}

Depending on your chosen mod loader, you will need to also include the hypixel-mod-api as a required dependency. For example in Fabric you would include the following in your fabric.mod.json file.

{
  "depends": {
    "hypixel-mod-api": ">=1.0.1"
  }
}

Example Usage

Once you have the API added to your project you can start using it. Below are examples of sending server-bound packets, as well as receiving client-bound packets.

Sending a Hypixel Packet

public class Example {
    public void sendPacket() {
        HypixelModAPI.getInstance().sendPacket(new ServerboundPartyInfoPacket());
    }
}

Registering a packet handler

public class Example {
    public void registerPacketHandler() {
        HypixelModAPI.getInstance().createHandler(ClientboundLocationPacket.class, packet -> {
            packet.getServerName();
        });
    }
}

Subscribing to a packet event

If you wish to receive a specific event packet, you will need to subscribe to the event. Once subscribed you can register a packet handler as normal (see example above).

public class Example {
    public void subscribeToPacketEvent() {
        HypixelModAPI.getInstance().subscribeToEventPacket(ClientboundLocationPacket.class);
    }
}

Registering for an event packet is only required one time during the Minecraft client lifecycle. You can register for event packets at anytime, including in your mod initialization code before the player has connected.

The implementation of the Mod API will automatically notify the server of any registered events when receiving the ClientboundHelloPacket.