HUD API

If you liked this item, please rate it up on Steam Workshop page.

Author: ☢ Nato Potato ☢

Last revision: 22 Jan, 2025 at 16:23 UTC (2)

File size: 2.51 MB

On Steam Workshop

Description:

Using this mod you can create and use your own custom HUD layouts.

You can go to the Mod Config Menu to change the HUD, or you can press H at any time during a game to cycle through all the available HUDs.
(hotkey can be changed in the config menu)

In the config menu you can also set which HUD should be applied by default after starting a game.

Some example HUDs are included:
FakeDefault – Looks like the regular HUD, why would you want this? Mods can’t render sprites over the regular HUD, they can if you use this.
Flash – Nostalgia. (assets shamelessly stolen from the Reflash mod, check it out if you’re a fan of the original game)
TextOnly – Learn to read.
UpsideDown – For all the fellow Australian players out there.
Jittery – Clearly this HUD has had way too much coffee.
SPEEEEEEN – Because why not?

The mod has global functions that allow you to make and manage your own HUDs, basically you need some sprite anm files and a table that lists them, along with fields for position, orientation, etc.
The sprite table can also include functions that should be run while rendering the sprite, really helpful if you want to display dynamic data like stats or health or your own custom variables.
You can check the lua files for more info, it can get a bit complex but it’s a lot easier than trying to implement a custom HUD from scratch.

Using the Mod Config Menu you can also enable a few extra stats (this should work for all up-to-date HUDs without needing them to include the extra stats in their code), currently there is a check for Planetarium room chance (repentance only), a counter for blue flies, one for blue spiders, enemies killed, damage taken, rooms explored, pills used, cards used and a counter for deaths which carries over between runs (and can be reset in the config menu).

Mods that render stuff on screen can also check the current HUD if they want to reposition them to fit different HUDs, all HUDs aside from the regular default one add the ‘No HUD’ seed effect so if you don’t want to add support for different HUDs you can just only render stuff if the nohud seed is not active.
(it’s also just good practice to do that as it will allow people to hide everything for good screenshots and it prevents sprites from being rendered over the mod config menu)

I didn’t mess with maps and inventory stuff since those have already been done by other mods, so if you want visible minimap and inventory for custom HUDs subscribe to MiniMAPI and reHUD.

HUGE thanks to Temmie for the Deal API that can accurately calculate your angel chance. (and letting me re-purpose the code for this mod)
Now the HUDs should all have devil and angel chances, you can also use the config menu to switch the implementation of the chances from the weird ‘chance for a special room & chance for that room to be angel’ to the ACTUAL odds of each room appearing.