Food API
No reviews yet
A flexible food system API for NeoForge. Adds configurable hunger capacity and drain speed via attributes, dynamic food bar rendering with multi-row support, and a provider-based icon replacement system for seamless mod integration.
Focuses on cooking, recipes, and food-related mechanics.
Neoforge is a fork of the Minecraft Forge available for versions 1.20.1+ of Minecraft. Many Forge mods are compatible with Neoforge and vice versa.
Community voices
Reviews
Click once to include, again to exclude, again to clear
No reviews yet. Be the first to review this project!
Get it on
Available Platforms
Compatibility
Supported Environments
About
Project Details
For authors
Embed Badge
If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.
Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.
Identifiers
Platform IDs
Resources
External Links
About
Description
📖 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:
| Attribute | ID | Default | Range | Description |
|---|---|---|---|---|
| Max Hunger | food_api:max_hunger |
20 |
1 – 40 |
Maximum hunger capacity. 20 = one row, 40 = two rows. |
| Hunger Rate | food_api:hunger_rate |
1.0 |
0.0 – 10.0 |
Hunger drain speed multiplier. 0 = no drain, 2 = twice as fast. |
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
| Type | Description |
|---|---|
EMPTY |
Background (empty slot) |
HALF |
Half-filled icon |
FULL |
Fully filled icon |
EMPTY_HUNGER |
Background during Hunger effect |
HALF_HUNGER |
Half icon during Hunger effect |
FULL_HUNGER |
Full icon during Hunger effect |
HALF_OVERLAY |
Half icon on top row (Overflowing Bars only) |
FULL_OVERLAY |
Full icon on top row (Overflowing Bars only) |
SATURATION |
Saturation overlay texture (AppleSkin only) |
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
Made with 🩷 by ArimoV2
Versions
Files
Relations
Project Relations
More like this
Similar Mods
Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.
On ModDex
Community snapshot
By the numbers
Statistics
Want to reach Minecraft players?
We're looking for a server hosting partner to feature here and other parts of the site. Interested? Send us a message!
Get in touchGet it on
Available Platforms
On ModDex
Community snapshot
By the numbers
Statistics
Resources