NilsHUD

NilsHUD is a mod that adds various improvements and customizations to the in-game Heads-Up Display (HUD) and player health indicators.

Features

• Customizable Damage Overlay
  • Overlay color can be changed (default: #FF0000 - red)
  • Fill animation can be enabled or disabled (default: enabled)
  • Fill direction can be set to bottom-to-top or top-to-bottom (default: bottom-to-top)
  • Fill transition duration can be adjusted (default: 0.1 seconds)
  • Player's suit color can be used for the overlay (default: disabled)
  • Suit overlay brightness can be adjusted (default: 1)
  • Start fully filled option can be enabled or disabled (default: disabled)

• Fade-Out Effect
  • Fade-out effect for the damage overlay can be enabled or disabled (default: enabled)
  • Fade-out duration can be adjusted (default: 0.5 seconds)
  • Fade-out intensity can be adjusted (0 for no fade-out, 1 for full fade-out; default: 0.5)

• Damage Effects
  • Critical hit effect can be enabled or disabled (default: enabled)
  • Small hit effect can be enabled or disabled (default: enabled)

• Experimental Health Bar
  • Health bar can be enabled or disabled (default: disabled)
  • Health bar color can be changed (default: #FF8000 - orange)
  • Red health bar color can be changed (default: #FF0000 - red)
  • Health bar position can be adjusted (default: x=0, y=30)
  • Fade-in duration for the health bar can be adjusted (default: 0.5 seconds)
  • Fade-out delay for the health bar can be adjusted (default: 1 second)
  • Health bar width and height can be adjusted (default: width=300, height=15)
  • Red health bar width and height can be adjusted (default: width=300, height=15)

Please note that some features, like the experimental health bar, are marked as experimental and may have bugs or issues.

Installation

1. Install BepInEx following the instructions on the BepInEx GitHub repository.
2. Download the latest version of NilsHUD from Thunderstore, NexusMods or Releases.
3. Extract the contents of the zip file into the BepInEx/plugins folder in your Lethal Company installation directory.

Configuration

NilsHUD comes with a configuration file NilsHUD.cfg located in the BepInEx/config folder. You can modify the settings in this file to customize the behavior of the mod according to your preferences.

Compatibility

• LethalConfig

Contributing

Contributions to NilsHUD are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

License

NilsHUD is released under the GNU General Public License version 3.

Credits

NilsHUD was created by Nilaier and is based on the game Lethal Company developed by Zeekers.

Inspired by an icon for BetterFallDamage mod.

1.0.5

• Resolved compatibility issues with LethalConfig version 1.4.1 and later, ensuring seamless integration.
• Fixed a bug where LethalConfig would not load the mod's configuration until the player entered the ship.
• Manually added a custom description and icon for LethalConfig's configuration entry.
• Revamped the suit overlay color handling logic to read the suit texture and use its primary color as an overlay. This works well with vanilla suits and some mono-colored modded suits, but accuracy may vary for other modded suits.
• Introduced a new SuitOverlayBrightness float option to adjust the brightness of the overlay color.
• Implemented additional error-handling measures to prevent the mod from impacting other mods that utilize the same functions in case of encountered issues.
• Added a StartFullyFilled option that initializes the health overlay as fully red and drains it as the player takes damage, instead of filling it up.

1.0.4

• Fixed an issue where, after the player's death, they would be healed before respawning, triggering a fill without HUD reinitialization and causing an indefinite loop of the level-up audio.
• Added explicit support for LethalConfig, as automatic detection was not functioning correctly.

1.0.3

• Initial release of the mod.