gohud is a HUD and UI kit for Godot 4 that you can bend to your game instead of bending your
game to it. Drop it into res://addons/gohud/ and it works โ enabling the editor plugin only adds
conveniences.
๐ Tutorials & docs โ https://thruthesky.github.io/gohud/
- ๐งฑ Widgets guide โ dialogs, sheets, forms, HUD and more
- ๐จ Theming guide โ presets, JSON themes, shapes and icons
๐งฉ Widgets
GoSurface |
Draggable, resizable modal window with scrim, header and optional scrolling body |
GoSheet |
Bottom sheet with sticky toolbar and footer, drag-to-dismiss |
GoDialogs |
await alert / confirm / prompt / choice |
GoForm |
Labelled rows that become a single column on narrow screens |
GoNotice |
Snackbars and toasts that never swallow input |
GoPromptCard ยท GoCoachMark |
Inline prompts and spotlight tutorials |
GoHudAnchor ยท GoBar ยท GoSlot ยท GoJoystick |
HUD corners, resource bars, quick slots, virtual stick |
GoStyle |
One-line factories for buttons, chips, list rows, flowing rows and foldable sections |
๐ญ Six presets, one line
GoUi.use_preset(GoThemePresets.MEDIEVAL_DARK) swaps theme, skin and icons together.
| Preset | Look |
|---|---|
default_dark ยท default_light |
Rounded, clean panels |
scifi_dark ยท scifi_light |
Chamfered panels with neon glow |
medieval_dark ยท medieval_light |
Iron and leather or parchment, antique-gold frames, engraved icons, Cinzel headings |
Need your own look? Write a palette JSON โ themes can inherit other themes.
โ๏ธ Everything is an option
All settings live in one GoConfig resource that survives add-on updates: preset, theme and accent,
icon set, base font size, corner radius, spacing scale, breakpoints, surface behaviour, haptics,
sound cues, strings and accessibility. Change a field, call GoUi.refresh(), and every live widget
updates.
๐ Swap the icons, keep the code
Widgets ask for icons by name (GoIconSet.CLOSE), never by path. Point GoConfig.icons at:
- your own SVG set, or
- an icon font (
font+codepoints) such as Font Awesome or Material Symbols, or - a partial set with
fallbackpointing at the bundled one โ override just the few you care about.
The 100 bundled icons (84 default + 16 engraved medieval) are original, MIT, and imported as
DPITexture, so they stay sharp at any UI scale.
๐ฑ Mobile first, desktop ready
48 dp touch targets behind smaller visuals, safe-area insets, virtual-keyboard avoidance,
portrait/landscape layouts, Android Back handling, focus rings only for keyboard users,
accessibility_name on every interactive control, and RTL via
LAYOUT_DIRECTION_APPLICATION_LOCALE. Ships with strings in 21 languages.
๐ ๏ธ Requirements
Godot 4.6 or newer โ gohud uses DPITexture, FoldableContainer, the accessibility
properties and mouse_behavior_recursive. Developed and verified on 4.7.2.
๐ฆ What's included
Pure GDScript (no GDExtension, no engine module) ยท 32 scripts ยท six presets ยท 100 icons ยท
Cinzel heading font ยท strings in 21 languages ยท gallery and medieval example scenes ยท
438 headless tests you can run yourself with addons/gohud/tools/run_tests.sh.
๐ License
MIT, icons included. Use it in commercial games, modify it, redistribute it. The bundled Cinzel heading font is under the SIL Open Font License 1.1.
Changelog for version v1.0.3
No changelog provided for this version.