Food API

Minecraft 版本： 1.21.1

平台： neoforge

标签： food game-mechanics

# 🍖 Food API ### A flexible hunger system library for NeoForge [](https://modrinth.com/user/Arimo) [](https://github.com/ArimoV2)

📖 About

Food API is a developer-focused library that removes the hardcoded limitations of Minecraft's vanilla hunger system. It exposes hunger capacity and drain speed as proper entity attributes, adds multi-row food bar rendering, and provides a clean provider-based system for replacing food icons — all with optional compatibility for popular HUD mods.

✨ Features

▶ Dynamic hunger capacity — max hunger is now an attribute, supports up to 2 rows (40 units).

▶ Configurable drain speed — control how fast hunger depletes via a multiplier attribute.

▶ Multi-row food bar — second row renders seamlessly above the first, fully synced with vanilla shake animation.

▶ Icon provider system — replace any food icon (empty, half, full, hunger, overlay, saturation) per-player, per-row, per-slot with a simple registration API.

▶ Optional mod compat — native support for Overflowing Bars and AppleSkin when present.

🖼️ Screenshots

**Vanilla rendering** — single row, standard icons

**With Overflowing Bars** — row counter, overlay icons stacked on top

📦 New Attributes

Two new player attributes are registered automatically when Food API is loaded:

Both attributes are synced to the client and can be modified via commands, other mods, or directly in code:

// Example: give a player double hunger capacity
player.getAttribute(AttributeRegistries.MAX_HUNGER)
      .setBaseValue(40);

// Example: slow hunger drain to half speed
player.getAttribute(AttributeRegistries.HUNGER_RATE)
      .setBaseValue(0.5);

🔧 API Usage

Replacing food icons

Register a provider with an ID and priority. Higher priority wins. Return null to fall through to the next provider.

FoodIconRegistry.register(
    ResourceLocation.fromNamespaceAndPath("mymod", "my_provider"),
    10, // priority — higher = checked first (vanilla = 0)
    (player, iconIndex, row, type) -> {
        // iconIndex: 0 = rightmost icon, 9 = leftmost
        // row: 0 = bottom row, 1 = top row
        return switch (type) {
            case FULL  -> ResourceLocation.fromNamespaceAndPath("mymod", "hud/my_food_full");
            case HALF  -> ResourceLocation.fromNamespaceAndPath("mymod", "hud/my_food_half");
            case EMPTY -> ResourceLocation.fromNamespaceAndPath("mymod", "hud/my_food_empty");
            default    -> null; // let other providers or vanilla handle the rest
        };
    }
);

Icon types

Registering at the right time

Call FoodIconRegistry.register(...) during FMLClientSetupEvent or earlier:

@SubscribeEvent
public static void onClientSetup(FMLClientSetupEvent event) {
    FoodIconRegistry.register(...);
}

🔗 Optional Dependencies

Food API works standalone. These mods unlock extra features when present:

• Overflowing Bars — enables row counter display and overlay icon rendering on the top row
• AppleSkin — enables saturation overlay icon replacement via FoodIconType.SATURATION