Description
Hydration Overlay
A client-side Fabric mod for Minecraft 26.3 that displays a colored overlay over blocks to visualize irrigation: where crops will stay hydrated, where they won't, and where sugar cane can be planted.
Inspired by the Lighty and Watering Overlay mods.
Features
- Configurable keybind (default:
H) toggles the overlay, with a status message on the action bar. - Red overlay: farmland-able block (dirt, grass block, ...) that would not stay hydrated.
- Blue overlay: farmland-able block that would stay hydrated.
- Green overlay: spot where sugar cane could be planted (can be deactivated, see Configuration).
- Overlay refreshes within a tick when blocks or water are placed or removed.
Configuration
Config file: config/hydration_overlay.json (reloaded each time the overlay is toggled on).
| Field | Default | Description |
|---|---|---|
scanRadiusXZ |
32 |
Horizontal scan radius around the player, in blocks. |
minYOffset |
-6 |
Vertical scan range lower bound, relative to the player. |
maxYOffset |
6 |
Vertical scan range upper bound, relative to the player. |
scanIntervalTicks |
20 |
Lazy rescan interval while walking. Block updates always rescan within one tick. |
showSugarCaneSpots |
true |
Enable/disable the green sugar cane overlay. |
hydratedColor |
"#663355CC" |
Blue: irrigated farmland-able block. |
unhydratedColor |
"#66FF3355" |
Red: non-irrigated farmland-able block. |
sugarCaneColor |
"#6644CC44" |
Green: plantable sugar cane spot. |
Colors are "#RRGGBB" (fully opaque) or "#AARRGGBB" — the first pair is the alpha channel: 00 is invisible, FF is fully opaque. Suggested values around 40% opacity. Invalid values fall back to defaults with an error in the log.
Known Issues
- Overlay does not work when Iris shaders are on. Shaders can be toggled off to solve the issue.
- Sugar cane overlay can be confusing (sand is not a valid hydration candidate, but is still shown as green if next to water)
- Performance could be better
Future Plans
- Fix the above issues.
- Improve visuals.
- Add configuration through Mod Menu.
- Add a config for colourblindness.
License
MIT
