Saturation Plus

~~~~

Project Updates:

- Version 1.3 Fabric has been released for Minecraft 1.20-1.21.10. Due to the changes in initializing gamerules, a new version will be created for 1.21.11 in the future. Furthermore, a Forge/NeoForge port for Fabric 1.3 will be released in two parts (1.2, 1.3) throughout 2026.

See the Updates tab below to see what implementations to expect in version 1.3.

~~~~

Traditionally, saturation cannot exceed the player's hunger level, which caps out as 20.

This mod adds the following QoL improvements to saturation:

- Saturation is not restricted to hunger level. For instance, a player with a hunger level of 6 can still have a saturation level of 7 or more.

- Excess hunger bars from eating food will be carried over as saturation. For instance, eating a golden carrot (6 hunger points) at 18 hunger points will bring hunger to the maximum of 20, with the remaining 4 being allocated to saturation points.

- Saturation can accumulate past 20, allowing the full efficiency of mods that restore large amounts of hunger or saturation points (>20).

For mod versions 1.0-1.2, saturation can be made visible through mods such as AppleSkin, or queried through the added command /getSaturation.

For 1.3+, saturation and exhaustion are available as visual indicators beside the hunger bar.

Saturation Plus must be installed on both client and server to function as intended.

This mod currently prioritizes Minecraft Fabric, but development on Forge/NeoForge is currently focused on Minecraft versions 1.20+.

If enough requests are made concerning earlier versions, further backports could be considered in the future.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Currently supported versions (Minecraft Fabric):

1.14.4               1.15 - 1.15.2

1.16 - 1.16.5     1.17 - 1.17.1

1.18 - 1.18.2     1.19 - 1.19.4

1.20 - 1.20.6     1.21 - 1.21.11

(Minecraft Forge / NeoForge):

1.21 - 1.21.11

1.20 - 1.20.6

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Updates:

Version 1.1 (Fabric)*

Added two new gamerules for customizing how saturation works for each world:

Hunger Limits Saturation - Saturation level never exceeds the current hunger level. Set to false to allow saturation values above 20.

Max Saturation Level - The upper limit for saturation. Set to a negative integer (ex. -1) to disable this limit, allowing for uncapped saturation (remember to disable Hunger Limits Saturation).

For the vanilla experience, set hungerLimitsSaturation = true and maxSaturation = 20.

*This feature is fully implemented in 1.1 of the Forge and NeoForge ports of this mod.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Version 1.2 (Fabric)*

Added two commands for manually adjusting saturation:

/addSaturation - Adds (or subtracts, using a negative input) saturation.

/setSaturation - Directly changes saturation to the specified amount.

For both commands, saturation is clamped between 0 and the floating point limit (3.4e+38F).

*This feature is fully implemented in 1.0 of the Forge and NeoForge ports of this mod.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Version 1.3 (Fabric)*

The Saturation status effect has been adjusted to account for mods that grant long-lasting status effects.

Instead of always giving 1 saturation point per tick, players with the status effect will gradually receive less points the more saturation they already have.

(ex. 0.125/tick at 21 saturation, 0.025/tick at 22 saturation)

Added three gamerules to further customize saturation mechanics per world:

Always Hungry - If enabled, players can eat any food regardless of hunger level in Survival or Adventure mode.

Max Exhaustion Level - The max exhaustion level before hunger or saturation depletion. Set to 0 to disable exhaustion, allowing for players to never starve (not recommended).

Saturation Status Effect Decay Rate - Controls the rate of decay for the Saturation status effect. Larger numbers means higher decay rate (players receive less saturation the more they already have); set to 0 to keep saturation gain as constant (1/tick).

*The above features are fully implemented in the 1.2 Forge and NeoForge ports of this mod. The features below will be available in 1.3 on all mod loaders.

Saturation and exhaustion stats now appear as visuals beside the hunger meter.

- Saturation is displayed in yellow text and is updated constantly through server packets.

- Exhaustion is displayed in gray text as a percentage (saturation or hunger decreases at 100%, then exhaustion resets to 0%)

- Both displays are disabled if the mod is not detected on the server (this mod must be installed on both client and server).

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Version 1.4 (Planned)*

Adds a configuration file for customizing the saturation/exhaustion client displays.

  - Look for the filename "saturation_plus-config.properties" in the .minecraft/config folder, which can be opened in a text editor such as Notepad.

  - Remember to save the file and restart your Minecraft instance to apply any changes!

  - Note: a prototype of the config file with only the first setting (saturation.ui) exists for Fabric 1.3.1; Version 1.4 plans on expanding the file to include more settings.

  - saturation.ui: Default true, change setting to false to remove the UI client display entirely.

  - exhaustion.asPercentage: Default true, changes whether exhaustion displays as a ratio over the maxExhaustion gamerule or by its true unedited value.

  - saturation.color: Default 0xffffff00, controls saturation display color

  - exhaustion.color: Default 0xff808080, controls exhaustion display color

Adds a new gamerule:

Saturation Command Message As Overlay - determines whether messages from commands (ex. /getSaturation) display as an action bar overlay or as a chat message.

*This update will begin development after Fabric, NeoForge, and Forge are all properly updated to 1.3.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Future plans:

- Configuration file for customizing the visual saturation/exhaustion HUD (ongoing)

- Potential: Ability to change max hunger level below or beyond 20

- In progress: Ports to other mod loaders (ex. Forge, NeoForge)

    - 1.20 and 1.21 are currently implemented for Forge and NeoForge (please report any issues if applicable). Further backports will be created if no issues are currently detected.

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=