Immersive Compass

A user-interface compass for Valheim designed to improve immersion. Based on aedenthorn's original Compass with added improvements to support more game styles.

Adds a customizable compass to the game HUD that:

• Can rotate with the camera or player model.
• Shows map marker pins.
• Can show (or hide) player pins.
• Allows you to hide specific pin names and types.
• ServerSync controls.

Thanks to the base mod, you can change the scale of the compass and pins, distance of pins shown, and ignore specific pin names and types. You can also add an overlay and underlay image if required. Thanks to Fragnarock's update, for expanding server sync for minimum and maximum distances of pins and setting a pin management expansion (which we have chosen to remove).

Configuration

A configuration file is created after starting the game. You can adjust the values in this configuration file using a standard text editor or Config Editor in r2modman. Most of the configuration can be changed on-the-fly, though images and keybinds need a restart.

In 1.3.1, Pin management functionality has been removed. Death pins are default ignored to prevent bugs in nomap servers. Please change configuration to remove Death pins from ignore list in nomap mods if you have a mod like AzuMatt's DeathPinRemoval that can handle the removal of Death Pins in correct scenarios.

With 1.4.0, mst of the code has been optimized by Neobotics. Support for dynamic map markers for ships, carts and portals has been added. This experimental release also support always-show lists for pin types that will always be shown on the compass. Please proceed with caution and report issues found to gdragon or Neobotics.

This will likely be the last version under this commissioner, as Neobotics will be refactoring this into a new mod in their portfolio named HUD Compass. Stay posted.

Server Synchronization

The following configuration options are synchronized with the server, if enabled server-side.

• Mod Enabled/Disabled
• ServerSync Enabled/Disabled
• Pins - Minimum and Maximum Distance
• Show Player Pins
• Ignore Pin Names
• Ignore Pin Types

Installation

Unzip the contents to your BepInEx\plugins folder.

Credits

• This is a fork of Fragnarock aka GuyDeYoYo's 's ImmersiveCompass.
• That mod is based on aedenthorn's Compass mod.
• Neobotics authored most of the updated content for this mod. This improved compass could not have existed or happened without their assistance. Please check out all of their awesome mods on the Neobotics Thunderstore page.

License

MIT No Attribution

Changelog

1.4.0

• Compatibility with dynamic map markers for ships, carts and portals. Most of the code has been optimized by Neobotics. This experimental release also support always-show lists for pin types that will always be shown on the compass.

1.3.1

• Pin management functionality has been removed. Death pins are default ignored to prevent bugs in nomap servers. Pleaes change configuration to enable Death Pins again in nomap mods if you have a mod like AzuMatt's DeathPinRemoval.

1.3.0

• Improved compass performance (thanks to Neobotics!)

1.2.0

• Forked and Updated to work with Valheim 0.217.25 by updating source code libs and building off latest serversync (via commission)

1.1.2

• Updated references to work with game version 211.11.
• Updated ServerSync to 1.13.

1.1.1

• Fix to allow you to open your tombstone if auto-remove pin is enabled and pin does not exist.

1.1.0

If upgrading from 1.0.1, you need to delete your existing config file and set up a new config file.

• Added optional center marker image (not enabled by default).
• Added ServerSync for: Mod Enabled/Disabled, Pins (Minimum and Maximum Distance), Show Player Pins, Ignore Pin Names, and Ignore Pin Types.
• Changed keybinds from strings to keycodes in configuration.
• Changed default keybind from P to * (Times/Asterisk on NumPad).
• Changed keybind checking to prevent self-clash situations.

1.0.0

Initial release.