-
Notifications
You must be signed in to change notification settings - Fork 10
The Hypixel Mod API is an official API that allows communication from the Minecraft client to the Hypixel Server via the plugin message system.
No. The Mod API is designed to be a system completely separate from the Public API. The Mod API is to aid in communication about data that is currently going on for the active player, and not for querying other data players.
We do not intend to offer the same data that is offered via the Public API in the Mod API.
While it is possible to implement the Mod API manually or use a third-party implementation, it is advised against doing so. This is due to how the Mod API handles rate-limiting and protocol versions for event packets.
As a TLDR, if multiple implementations of the Mod API protocol exist, this can result in some packets not being received by some of those implementations.
-
Packet request cooldowns are implemented at a packet type level, so if two mods request a packet in a very short period, only one response will be received.
- If all usages are using the official Mod API, this should not present a problem. As there is only one system handling the communication, so all mods will be able to handle the one response packet.
- If multiple mods use custom implementations that are using different versions of the Mod API, it is possible that one mod may not receive a response that it can understand, due to the differences in the packet versions.
-
Event packets, such as the location packet, are sent based on a map of registered packet identifiers to packet versions. This allows the Hypixel Server to know what version of the packet the client is expecting.
- The Hypixel Server will only keep reference to the latest sent registration, and will not respond to multiple versions if multiple implementations exist.
- This means that when two separate implementations may conflict, only one of the mods will receive the event response.
Due to this, it is heavily recommended to use the official implementation to avoid issues for end-users. There are also detections in place on the Hypixel Server to detect conflicting mods "fighting" for their wanted version. This detection may result in players receiving chat messages notifying them of this issue.