HUDCompass
A Heads Up Display compass with map pins and dynamic markers for Ships, Carts and Portals. New - custom map names for Ships and Carts
About this mod Author’s original text
HUD Compass
Heads-Up Compass with Dynamic Map Markers for Ships, Carts & Portals
Dude, where's my boat? Never lose track of your boats, carts or portals again. A heads-up compass that includes standard pins and dynamic map markers for ships, carts, active and inactive portals on the compass and the map.
HUD Compass brings a complete experience to location aids. (see credits below)
- The scalable compass appears across the top of your screen.
- Toggle the compass on and off in-game.
- Dynamic pins (ships, carts, portals) are shown on the compass and the map, with or without labels.
- Supports custom ships and carts.
- Active and inactive portals can have different colors.
- Configurations for fog, mist, in combat and while running for better immersion.
- Portal pins display the name you give them.
- Ship labels can specify the type of ship (Karve, Longship, Raft), as well as custom ships.
- Pin types to include/exclude are configurable.
- Pin size is relative to marker distance, with configurable limits.
- Configuration to use external images for custom compass and dynamic icon appearance. See Notes
New
- Updated for Valheim 1.0
Configuration
A - HUD Compass
- Enable Compass: Enable or Disable the Compass HUD.@
- Show Compass: Show or Hide the HUD compass. Use the Toggle Compass key to change in-game.
- Toggle Compass Key: Key used in-game to toggle the compass visibility.
B - Compass Display
- Use Player Direction: Orient the compass based on the direction the player is facing, rather than the middle of the screen.
- Compass Scale: Sets the overall scale of the compass on the screen
- Offset (Y): Offset from the top of the screen in pixels.
- Distance (Minimum): Minimum distance from pin to show on compass.@
- Distance (Maximum): Maximum distance from pin to show on compass.@
- Player Pin Visibility: Force player pins (multiplayer) to appear or not appear on the compass and map, or let the player decide. Overrides Show My Player Pin if not set to PlayerChoice.@
- Show My Player Pin: Shows or hides your player pin (multiplayer) on the compass if playing no-map where visibility setting is not available. Overridden by server if Player Pin Behavior is not set to PlayerChoice.
- Pins Scale: Sets the overall scale of the pins on the on the screen
- Minimum Pin Size: Enlarge or shrink the scale of the pins at their furthest visible distance.
- Show Center Mark: (Optional) Show center mark graphic.
- Hide HUD While Map Open: Hide the HUD display while the large map is open.
C - Ignore
- Pin Names: Ignore location pins with these names (comma separated, no spaces). End a string with asterisk (*) to denote a prefix.@
- Pin Types: Ignore location pins of these types (comma separated, no spaces). Types include: Fire,House,Pin,Portal,Start,Haldir,Hildir,BogWitch,Death,Bed,Shout,Boss,Player,RandomEvent,Ping,EventArea.@
E - Compass Colors
- Compass Color: (Optional) Adjust the main color of the compass.
- Pin Color: (Optional) Adjust the color of the location pins on the compass.
- Center Mark Color: (Optional) Adjust the color of the center mark graphic.
F - Dynamic Pins
- Show dynamic pins on map: Display pins for ships, carts and portals on the main and minimap. Controlled individually below.@
- Show dynamic pins on compass: Display pins for ships, carts and portals on the compass. Controlled individually below.@
- Player pin refresh pin interval: Interval in seconds between refresh of player pins on map and compass. Decrease for 'smoother' updates of player pins. Zero refreshes every frame. NOTE: Valheim default for Player pin refresh is 2 seconds. Decreasing can reduce multiplayer performance.@
G - Dynamic Types
- Show Ships: Show ships on the map and compass.@
- Show Carts: Show carts on the map and compass.@
- Show Portals: Show portals on the map and compass.@
H - Dynamic Names
- Show dynamic names on map: Display boat and cart types (i.e., Raft, Karve, Longship) and Portal names on the large map.
I - Dynamic Map Colors
-
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file. In multiplayer, the host and every client need the same mods installed.
Install these first, or the mod will not work: