Mod API 1.0.2

This update contains a backend implementation change for how the downstream mods implement the Mod API. No difference in behaviour should be observed.

What's Changed

• Implement mod implementation interface for use in downstream mods in #40

Downloads

• Forge 1.8.9
• Fabric 26.1

Full Changelog: v1.0.1...v1.0.2

Mod API 1.0.1

This update is a minor release and is fully compatible with the previous release.

What's Changed

• Annotate internal methods as so #35
• Add the ability to register an error handler #39
• Forge 1.8.9 Implementation:
  • Various build script improvements HypixelDev/ForgeModAPI#6
  • Add tweaker loader HypixelDev/ForgeModAPI#7

Downloads:

• Forge 1.8.9
• Fabric 1.20.5/1.20.6
• Fabric 1.21

Full Changelog: v1.0...v1.0.1

Mod API 1.0

This marks the first full release of the Hypixel Mod API, meaning our goal moving forward will be to maintain support and compatibility for any functions provided by the API to the best of our abilities. This also means it is now safe to be used in production mods.

This release has no changes from the prior 0.5.0 release and thus is fully compatible without any changes.

Mod API 0.5.0

This update includes a breaking change to how handlers are registered via HypixelModAPI#registerHandler. Previous implementations that use this will not work with this version.

Reminder: Breaking changes are something we will always try to avoid when the Mod API fully releases (hopefully later this month). But during this initial feedback stage, we are open to breaking changes if they improve the overall implementation of the Mod API.

What's Changed

• Changed to use functional interfaces for clientbound packet handling by @nextdayy in #29
• Fixed an issue in the Forge implementation that could result in packets being unable to be sent when receiving the hello packet.

Download Links

• Forge 1.8.9
• Fabric 1.20.5/1.20.6
• Fabric 1.21

Full Changelog: v0.4.0...v0.5.0

Mod API 0.4.0

This update brings some major (and breaking) changes to the Mod API, with the stand-out change being the implementation of event-driven packets.

What's Changed

• Implements an event packet system:
  • Currently supports one event packet, the player's location. This event is sent every time a player switches instances on the server.
    • As this event should be the go-to method of getting a player's location, this event has replaced the standard location packet which has now been fully removed.
  • This system works based on a custom register packet, that the implementation of HypixelModAPI will handle for you.
    • If you wish to subscribe to an event, you should call HypixelModAPI#subscribeToEventPacket with the class instance of the event you wish to subscribe to.
    • Unsubscribing from events is not supported, this is due to the fact that other mods may be subscribing to the same events and unsubscribing could lead to issues with multiple mods.
• Implements a "hello" packet:
  • This packet is automatically sent to all players upon joining the Hypixel Server.
  • The packet contains one piece of data at this time, which is the server environment.
• Implements a version 2 of the party_info packet
  • This version now includes the party roles of members.

Full Changelog: v0.3.3...v0.4.0

Mod API 0.3.3

Full Changelog: v0.3.2...v0.3.3

Mod API 0.3.2

Full Changelog: v0.3.1...v0.3.2

Mod API 0.3.1

• Fixed a bug with the PacketHandler still existing and not calling ClientboundPacketHandler handlers correctly

Full Changelog: v0.3...v0.3.1

Mod API 0.3

What's Changed

• Use a Packet Registry instead of HypixelPacketType by @ConnorLinfoot in #11
• Decouple packet types by @xxDark in #9

Full Changelog: v0.2.1...v0.3

Mod API 0.2.1

What's Changed

• Add Player Info to the handler by @sinender in #7

Full Changelog: 0.2...0.2.1