Navigation Menu

Skip to content

MisterPeModder/ShulkerBoxTooltip

Repository files navigation

Shulker Box Tooltip
Maven CursreForge Modrinth CI Crowdin

This mod allows you to see a preview window of a shulker box contents when hovering above it in an inventory by pressing shift.

Help translate ShulkerBoxTooltip on Crowdin!
Please vote for this to be included in vanilla!

Preview Window

Developers

List of artifacts

  • com.misterpemodder:shulkerboxtooltip-common: Platform-agnostic API
  • com.misterpemodder:shulkerboxtooltip-fabric: Fabric Implementation
  • com.misterpemodder:shulkerboxtooltip-forge: Forge-specific API + Implementation

Declaring the dependency (Fabric Loom/Architectury Loom)

repositories {
    maven { url "https://maven.misterpemodder.com/libs-release/" }
}

dependencies {
    // Change to 'shulkerboxtooltip-forge' or 'shulkerboxtooltip-common' depending on the artifact
    modImplementation("com.misterpemodder:shulkerboxtooltip-fabric:VERSION") { transitive false }
}

API

To use the API, implement the ShulkerBoxTooltipApi interface on a class and register it as a plugin.

On Fabric, add your plugin class as an entry point of type "shulkerboxtooltip" in your fabric.mod.json as such:

"entrypoints": {
    "shulkerboxtooltip": [
      "com.example.mymod.MyShulkerBoxTooltipPlugin"
    ]
}

On Forge, register your plugin by adding an extension point in your mod's initialization code:

ModLoadingContext.get().registerExtensionPoint(ShulkerBoxTooltipPlugin.class,
    () -> new ShulkerBoxTooltipPlugin(MyModShulkerBoxTooltipPlugin::new));

See api source for documentation.