Sparroh-Altimeter icon

Altimeter

Client-side HUD that shows your altitude above ground in meters.

Last updated a month ago
Total downloads 226
Total rating 0 
Categories Mods Misc Client-Side
Dependency string Sparroh-Altimeter-1.0.2
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_Mycopunk-5.4.2403 icon
BepInEx-BepInExPack_Mycopunk

BepInEx pack for Mycopunk. Preconfigured and ready to use.

Preferred version: 5.4.2403
Sparroh-SparrohUILib-1.2.2 icon
Sparroh-SparrohUILib

Shared UI library for Sparroh Mycopunk mods. Provides themed widgets, HUD builders, windows, and resolution-aware layout.

Preferred version: 1.2.2

README

Altimeter

A BepInEx mod for Mycopunk that adds a simple client-side altitude HUD, showing how high you are above the ground.

Features

  • Altitude HUD: Displays your current height above ground in meters
  • Ground / ceiling states: Shows "On Ground" when near the floor and "Too High" when nothing is hit within range
  • Configurable position: Move the HUD with X/Y anchor settings
  • Configurable color: Set the altitude value color via hex in the config
  • Toggleable: Enable or disable the display from the config file
  • Hot reload: Config changes are picked up while the game is running
  • Optional drag reposition: Uses SparrohUILib's soft dependency on ModSettingsMenu so the HUD can be moved in-game ( F9)

Dependencies

  • Mycopunk (base game)
  • BepInEx (BepInExPack for Mycopunk, 5.4.2403 or compatible)
  • SparrohUILib (required)

Installing

Via Thunderstore (recommended)

  1. Install with a Thunderstore mod manager (r2modman, Thunderstore App, etc.)
  2. Ensure SparrohUILib is installed as a dependency

Manual installation

  1. Install BepInEx and SparrohUILib
  2. Place Altimeter.dll in <Mycopunk Directory>/BepInEx/plugins/

The mod loads automatically through BepInEx when the game starts. Check the BepInEx log for a load confirmation.

Configuration

Settings are in <Mycopunk Directory>/BepInEx/config/sparroh.altimeter.cfg. Changes hot-reload while the game is running.

Section Setting Default Description
General Enable Altimeter true Enables the Altimeter HUD display
HUD Positioning Altimeter X 0.06355292 X anchor position (0–1)
HUD Positioning Altimeter Y 0.2589327 Y anchor position (0–1)
Colors Altimeter Color shamrock Rich-text value color (hex RRGGBB or #RRGGBB)

Building

  1. Clone this repository
  2. Restore references (game assemblies, BepInEx, SparrohUILib) as needed for your setup
  3. Build in Release mode:
dotnet build --configuration Release

Output DLL: bin/Release/netstandard2.1/Altimeter.dll

Help

  • Mod not loading? Verify BepInEx and SparrohUILib are installed, then check the BepInEx log for errors
  • HUD not visible? Confirm Enable Altimeter is true and that you are in-game with a local player
  • Wrong position? Adjust Altimeter X / Altimeter Y, or use ModSettingsMenu drag-reposition (F9) when installed

Authors

  • Sparroh

License

This project is licensed under the MIT License — see the LICENSE file for details.