CleanestHud

This is a revival & continuation of HIFU's CleanerHud mod, with permission. (proof at bottom of readme)

Info

• Pretty much everything about the hud has been edited in some way.
• Bugs from the original CleanerHud mod are fixed.
• Uses your survivor's color throughout the hud.
• • This doesn't just include the one you're playing as, but any survivor you're spectating.
• Supports modded UI from many mods, including (but not limited to):
• • Starstorm 2
• • LookingGlass
• • Driver
• • Myst
• Many parts of the hud are configurable.
• • You can use Risk of Options to configure these settings in-game.
• If a survivor you want to play with doesn't work well with the hud, there's a blacklist you can add them to to prevent the hud from doing changes
• Lots of modded multiplayer sessions were played while this was being developed, so I've made sure it works in multiplayer

Many elements of the hud are also configurable Most are for the hud in general, but some are for the survivor specific hud elements that seeker and void fiend have!

Screenshots Showcase

Bugs/Suggestions

If you find a bug, or have a suggestion for the hud, either make a github issue or ping me (lordvgames) in the RoR2 modding discord server.

Known Issues

• Changing resolutions mid-stage doesn't re-scale the hud
• • Kind of a vanilla issue, especially when going from a big resolution to a small one, but I feel it should still be mentioned
• Having the HealthbarImmune mod causes the hp bar text to disappear
• • May or may not be an issue from HealthbarImmune itself. In any case, installing NoMoreMath seems to fix it, even with the "effective health" setting off
• Sometimes Myst's HUD doesn't appear
• • It's a semi-rare error that randomly happens and it comes straight from Myst itself. Can't really fix it until Myst itself adds support for this HUD.
• Some part of the HUD is broken when an editing phase is turned off
• • The HUD was built assuming parts of it's editing process weren't turned off, especially structure edits. It'd be a ton of work to go back and make sure everything works with those options, so any bugs stemming from these options likely won't be fixed.

For mod developers

The mod includes some events you can subscribe to that correlate to when certain stages of the HUD editing process are done. These are, in order of completion:

• HudChanges.HudStructure.OnHudStructureEditsFinished
• HudChanges.HudDetails.OnHudDetailEditsFinished
• Main.OnSurvivorSpecificHudEditsFinished (repeatable)
• HudChanges.HudColor.OnHudColorUpdate (repeatable) The repeatable events happen when the camera/HUD's target changes, so any changes that depend on a specific survivor should go in either. OnSurvivorSpecificHudEditsFinished will always happen after a camera target change, and OnHudColorUpdate will try to run on every camera change, but the event will only be raised after successfully changing the HUD's color.
• Many config options have an event for when they're toggled on/off.

You can look at the existing code for this mod's survivor HUD support for examples on how to use these.

_{^{yes, i did get permission to continue the mod}}

1.0.2

Fixed mod trying to setup the editor component for the suppressed items UI when it shouldn't

1.0.1

Fixed Seeker's meditation UI not changing position

1.0.0

Added support for special HUD elements from the following mod characters:

• Driver
• Myst

Fixed many bugs:

• Fixed consistent difficulty bar coloring not working
• Fixed Seeker's lotus being slightly off center
• Fixed dead players in the inventories menu preventing styling for other scoreboard strips below it
• • Part of support for RestoreScoreboard
• Fixed the panel showing monsters' items having it's background removed when playing as a character that was blacklisted from the hud
• Fixed the suppressed items panel not being styled correctly
• • It still jitters a bit if you click on an item but I don't know if there's anything I can do about that
• Fixed item icons in the TAB menu still getting full outline changes while playing a character who is blacklisted
• • It's still changed slightly but there's nothing I can do about it since I have to edit the item icon asset
• Fixed HP bars sometimes being too light-green
• Fixed MUL-T's other equipment slot getting it's own little key prompt
• Fixed the position of some HUD elements that were slightly off
• Fixed equipment slots looking a little weird
• Fixed end screen's chat box not being styled

Reduced the number of .Find calls

• This should (if it works how I think it does) decrease the time to do all the HUD edits when loading into a stage, possibly decreasing stage load time a tiny bit

Heavily re-organized code

Added code events in the mod for other devs to know when each stage of CleanestHud's edits are finished

• Useful for if a modded HUD element copies off of a vanilla HUD element that gets edited by the HUD after the mod's HUD element spawns
• There are also events for when some config options change
• Read the README for more info

0.11.5

Fixed for SOTS phase 3

Fixed buffs list slowing becoming more off-center the longer the list is

Made another attempt to fix the hud color sometimes being wrong in multiplayer

• Untested, but might actually fix it

Repositioned seeker lotus UI position a bit so it doesn't overlap the sprint & inventory keybind reminders

0.11.4

Fixed SkillsPlusPlus causing the HUD editing process to die

Made color change apply a frame after the camera target change happens, similar to survivor-specific HUD element edits

• This is another attempt to fix another player's color being applied in multiplayer but I have good feeling about this one

0.11.3

Recompiled using latest dependencies

• The RoR2-related dependencies for the mod's code weren't updated since SOTS initial release, so this may fix some weird errors related to UI

0.11.2

Reworked coloring system a bit

• This should hopefully also fix the HUD sometimes using a different player's color in multiplayer

Hopefully fixed NRE related to item icon coloring

Fixed the player's name going to the middle of their inventory section when LookingGlass isn't installed

Fixed consistent difficulty bar coloring not working at the "HAHAHAHA" segment for real this time

Slightly moved the items list in the inventories menu

0.11.1

Fixed a specific setup with the DPSMeter mod causing this mod to die

0.11.0

Renamed many config options, double check your settings!

Added a config options for:

• Showing the section labels in the inventories screen (off by default)
• Showing the outlines for skill icons (on by default)
• • This will hopefully support equipment icons too in the future

Fixed ambient level "Lv." text not being changed to "Level"

Changed ambient level & stage count text to be completely white

Fixed a missing space before the right cloud in the boss subtitle

• AFAIK this has always been a thing in vanilla, now it's finally fixed

Made boss hp bar coloring perfectly cover the background

• Before this, the background would be peeking out a little bit on both ends of the bar

Removed outline from inspect panel

Fixed xp bar being a tiny bit misaligned from the hp bar

Fixed buff bar still being moved for blacklisted character bodies

0.10.2

Fixed potential error related to item icon coloring

Fixed errors when LookingGlass isn't installed

• The hud is meant to be fully usable without it, I just messed some things up when it comes to handling if the mod is running or not

0.10.1

Fixed error spam caused by some other mod messing with the hp bar

• I genuinely have no clue what mod was causing this, but the fix was easy

0.10.0

Rewrote a lot of positioning code

• This means that everything should be properly positioned no matter the screen size, be it 4:3 or ultrawide

Item highlights now get survivor colored using a better method

• Should be more performant at high item counts so the config option for this is now on by default.

The item icon & inventory strip highlight textures have been changed to a cleaner one

Tweaked the inventories menu item display

• Item icons are more spaced out (there's practically no space between icons in vanilla at high item counts)
• Item icons display should take up more height in a player's inventories menu section

Fixed an extra background detail for the item icon in the inspect not being removed

Fixed background for the inspect button reminder not being removed

Centered player names on the inventory menu

• This also includes some support for LookingGlass' item counters setting

Evenly spaced out skill & equipment icons

Tweaked SS2 composite injector equipment slot positions

• Slots past the 10th start at the 5th instead of the first
• • This makes it not overlap with the hp bar at ultrawide resolutions

Made HP bar text smoother

Changed "Lv: ##" text to "Level ##"

Fixed NRE when opening inventories menu when someone had no items

Fixed consistent difficulty bar coloring not working past the start of "HAHAHAHA"

Fixed positioning of the "Items" label in the inventories menu

0.9.0

First release

• Not everything is finished though