HUD Studio (Fully visual HUD creator)

Discord channel (for bugs or discussion): https://discord.com/channels/1048312349867646996/1545816384578003099

Update 1. 2

API support is here. See this github repo for a quick-start guide and an API reference:

https://github.com/matt-sr/HUD-Studio-Docs

Sample mod showing how to register is here:

https://www.nexusmods.com/warhammer40kdarktide/mods/1294

Ever wanted to create your own HUD in Darktide without having to code? This mod is for you!

No, I don't mean 'place existing elements around in different places', I mean make it look exactly how you want.

The UI of this mod is similar to popular image editing tools like Photoshop. The core concepts are the same: place elements on your canvas and style them as you wish.

This mod gives you tools to change how things appear and what appears based on defined data sources. Elements can be given extensive (or basic) rules for when they should be visible.

Anyone

I imagine it's useful for anyone who likes tweaking with the HUD, or likes customisation.

Since no coding is required, it should be pretty accessible to all, as long as you have a look at the mod images, which give you a visual guide of how things work. I did my best to keep it intuitive, but after weeks of staring at it, it's hard to know what isn't entirely obvious.

Working on proper documentation right now!

Mod Authors

Modders can build their HUDs visually with this mod and export into a new or existing mod. From your mod, you register via HUD Studio (about 20 lines of code) and users who install your mod + HUD Studio will find your elements in their library. The API is particularly useful for introducing new and complete HUD elements, whether driven by the vanilla game or by your mod logic.

Making mods with HUD Studio as a dependency

Since HUD Studio has a built-in code editor, you can write the core of your HUD logic inside your mod lua files in your dev environment of choice, and expose functions or state to HUD Studio elements. DPS mod example:

Inside your DPS mod:

• []Hook the game for attack results and calculate DPS[/]

  []Add settings to your mod as usual [/]

  []Expose DPS value, styling, layout (with settings applied) to your mod handle[/]

Inside this mod's script editor:

• []Retrieve your mod handle with get_mod()[/]

  []Apply value, styling, layout from your mod handle[/]

In the end, you don't have to bother with scenegraph code, have a cleaner split between layout and HUD, and can build your HUD visually.

https://github.com/matt-sr/HUD-Studio-Docs

Prototyping

If you have ideas and want to see if they transfer to the game well, make some mockups with a visual editor (and a browser for all the game's UI textures/materials) rather than commit to scenegraph straight away.

Debugging

I don't like crawling through echo messages in the chat, especially if you want to echo more than one thing at a time. Create a few text elements that read your intended values, one each, and see them update in real-time. If anything breaks, the game won't crash, either.

Anything, really. Here's an example of a fancy panel I made with the mod (Is included with mod in the library):

No code was written to make the above player panel. It's all data sources, dynamic coloring, and textures (with a provided texture browser)

Everything is drag and drop, with corner resize handles. Click and drag baby.

There's a built in code editor which lets you write quick scripts to change almost anything about how an element looks or what data is pulls. Might be a fun place to learn lua.

If you want it to do something really basic, you can do that too. Make an ammo readout, a bar showing ammo remaining for teammates, a dodge counter with a refresh timer bar... etc.

The images explain this better, but in summ