AppleSkin Documentation

AppleSkin is a Minecraft mod that provides food-related HUD improvements. Key features include:

• Food Value Tooltips: Displays food value information when hovering over items in tooltips.
• HUD Visualizations: Adds visual indicators for saturation and exhaustion to the HUD.
• Food Preview: Shows potential hunger/saturation restored and potential health restored while holding food in the hand.
• Debug Overlay: Adds hunger, saturation, and exhaustion information to the F3 debug overlay.
• Data Syncing: Synchronizes saturation and exhaustion values to the client.

To build the project locally, clone the repository and use the Gradle wrapper. You can optionally provide a specific version number during the build process.

# Standard build
./gradlew build

# Build with a specific version
./gradlew build -Pversion=1.0.0

When using the AppleSkin API, you should only register your event handlers if the AppleSkin mod is actually loaded in the environment. This prevents crashes when the mod is missing. Use ModList.get().isLoaded("appleskin") within your client setup event.

// In your @Mod annotated class
private void clientInit(final FMLClientSetupEvent event) {
    if (ModList.get().isLoaded("appleskin")) {
        MinecraftForge.EVENT_BUS.register(new AppleSkinEventHandler());
    }
}

// Your event handler implementation
public class AppleSkinEventHandler {
    @SubscribeEvent
    public void onPreTooltipEvent(TooltipOverlayEvent.Pre event) {
        // Example: hide the tooltip for regular apples
        if (event.itemStack.getItem() == Items.APPLE) {
            event.setCanceled(true);
        }
    }
}