Unified API
ModLGPL-3.0-only

Unified API

A multiloader API built to enable easy cross-loader mod development

22
Downloads
0
Followers
2 months ago
Updated
📦
8
Versions

📖About Unified API

Unified API

Unified API is a cross-loader API for both Fabric & NeoForge that enables you to create multiloader mods at no additional effort.

This is accomplished through Unified API's custom registries, events and helpers which replace the need for platform-specific code in favour of using Unified API's common-friendly, well-documented alternatives.

Unified API was built on Unimined, and has no dependencies - simply Fabric API for Fabric, or base NeoForge for NeoForge.

For comprehensive documentation alongside a setup guide, check out unified-api.dev

Registries include:

  • Items
  • Blocks
  • Entity Types
  • Block Entity Types
  • Creative Tabs
  • Mob Effects
  • Data Component Types
  • Particle Types
  • Sound Events
  • Key Mappings

Helpers include:

  • Platform (check for mods / modloader)
  • Packs (register internal data / resource packs)
  • Creative Entries (add items to creative tabs)
  • Loot Tables (append any loot table in a multiloader-friendly manner)
  • Networking (register, send & handle packets)
  • Strippable Blocks (make logs strippable)
  • Block Layers (determine client-side block rendering)
  • Particle Providers (create custom particles for the client)
  • Entity Renderers (setup rendering for custom entity / block entity models & textures)
  • Tooltips (bind custom client tooltip information to a tooltip, similarly to bundles)

Events include:

  • Item Components (filter for & modify the default components on any item)
  • Commands (create custom commands)
  • Players (run code on player events such as join/leave/respawn)
  • Ticks (run code at the start / end of client ticks, such as custom keybind code)
  • Guis (append hud rendering such as crosshair and hotbar rendering)
  • Screens (access AbstractContainerScreen in order to create custom mouse behaviour)

Components include:

  • Furnace Fuel (easily specify custom furnace fuel durations for any item)

Once again, be sure to check out unified-api.dev for documentation and the full feature set.