HUDFramework v1.0f

HUDFramework v1.0f

HUDFramework is a UI framework that makes it possible for mods to add new UI elements to the HUD in a conflict-free way. Stats, time, widgets… and more! Welcome to a new world of UI modding.

DETAILS
Previously, any mod modifying the HUD would necessarily overwrite and conflict with every other HUD mod. HUDFramework solves this by dynamically loading individual interface mods into the HUD at runtime. It gives modders the tools to load custom widgets and communicate with their widgets.

Note that you need to have a mod installed that uses the framework to see any widgets! If you’re looking for HUDFramework mods to install, there’s a list on the sticky in the Comments section.

INSTALLATION
1. Install with your preferred mod manager, or copy the files in the download to your Fallout 4 Data folder.
2. Activate HUDFramework.esm in your mod manager, or via the Mods menu.

Note: If you receive a message about overwriting HUDMenu.swf, then you have an existing UI mod installed. To use both together, you can inject HUDFramework into the other mod using the HUDFramework auto-patcher. See the Compatibility section.

FEATURES (for mod authors)
– Create HUD widgets and modify existing UI elements on-the-fly via a Papyrus interface.
– Write AS3 expressions directly within Papyrus and have them dynamically evaluated in Scaleform.
– One framework for both PC and console. HUDFramework benefits from, but does not require F4SE – you can bring your UI mods to consoles.

USAGE EXAMPLES
Retrieving a reference to HUDFramework:
➲ HUDFramework hud = HUDFramework.GetInstance()

Load UI Widget:
➲ hud.RegisterWidget(Self, “MyWidget.swf”, 100, 100)
➲ hud.LoadWidget(“MyWidget.swf”)

Communicate with UI widget:
➲ hud.SendMessage(“MyWidget.swf”, UpdateResourceBar, 100)

Show/hide compass:
➲ hud.Eval(“hud.BottomCenterGroup_mc.CompassWidget_mc.visible = false;”)

WHAT’S POSSIBLE
– On screen clock showing in-game/real time
– Companion status widget (view health and stats)
– Survival stats widget (hunger, sleep, thirst)
– Custom crit meter outside VATS
– Weapon wheel
– Companion wheel
– Custom crosshair
– Hide specific UI elements
– Quest-specific UI elements, such as a radar, minimap, or a timer counting down to detonation
…and more!

If you want to see more examples of what is possible with UI mods, see the supported modlists for UI frameworks for previous Fallout games.

COMPATIBILITY
A DEF_UI patch is provided in the Files section. If you are using any other mod that replaces HUDMenu.swf, you should merge HUDFramework with the other mod’s HUDMenu.swf. This is an automated process – the HUDFramework Auto-Patcher is able to automatically inject HUDFramework into any HUDMenu.swf. (In fact, this release itself is an auto-patch on the vanilla HUDMenu!) Get the auto-patcher in the Files section – instructions are included in the download.