/HypixelProtocol

Example mod using the Hypixel Modding API

Primary LanguageJavaMIT LicenseMIT

Hypixel Protocol Experimentation

Simple project I used to experiment with the new Hypixel modding protocol. I am sharing it publicly in case it may be a valuable resource to anyone struggling to get it up and running in their own project. You can install this mod, but it does not provide any useful features.

Requirements

This mod is built for Fabric on Minecraft 1.20.4. You must also have the Fabric API installed. Refer to the Fabric installation page for more information.

Usage

If you'd like to install the mod and test it yourself, use the command /hyproto. This mod supports Hypixel ModAPI v0.3.1, which currently supports the following packets:

  • ping
  • player_info
  • party_info
  • location

Provide the name of the packet you wish to send as the first argument to the command (for example, /hyproto ping). The response will be printed in chat and in your client logs in a human-readable format.

The /hyproto command has support for additional arguments for each packet, but none of the available packets currently take any arguments.

This command will not do anything if ran in singleplayer or on a server other than Hypixel.

Development

Steps to running this project in a development environment:

  1. Install Java 17 or higher. If you're running this project through an IDE, it may take care of this step for you.
  2. Install the Auth Me mod into the /run/mods folder. You will need this in order to authenticate and connect to Hypixel.
  3. Run gradlew runClient to start the client.
  4. Alternatively, run gradlew build to build the mod.

I have tested these steps with Java 21 on a Windows 11 installation. I cannot guarantee whether they will work for all systems and Java versions.