Overlay

Overlay adds additional GUI overlay that can be seen in the in-game interface.

NeoForge 26.1.2NeoForge 1.21.1

Step-by-step guide: how to make overlay →

Fields you fill in

Base texture

A base texture for your overlay. Other components will be drawn over this texture.

This parameter can be used to make "pumpkin" like overlays.

Recommended overlay size is 1920 x 1080 to make is scale properly.

Display condition

This procedure specifies if the overlay should be shown.

When the procedure returns true, the overlay will be shown on the screen.

Overlay target

Overlay target specifies on which screen this overlay should be drawn over.

Use Ingame for overlays such as hunger bars and pumpkin-like overlays.

Use other targets to overlay other specific screens.

Render priority

This parameter defines the priority of your overlay. Overlays with "High" will be rendered above

overlays with this parameter set to "Low".