Ymiron-PinGPS_Ymiron icon

PinGPS Ymiron

Ctrl+click a map pin to turn it into a GPS waypoint: its icon and distance float on screen while you travel.

By Ymiron
Last updated 13 hours ago
Total downloads 38
Total rating 0 
Categories Mods Tweaks Misc Client-side Utility AI Generated Deep North Update
Dependency string Ymiron-PinGPS_Ymiron-1.0.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2202 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.2202

README

PinGPS-Ymiron

Turn any map pin into a GPS waypoint. Open the map, hold Ctrl and left-click a pin: from then on the pin's icon floats on screen over the real spot in the world, with its name and the distance, while you travel.

        [icon]
      Troll cave
        245 m
  • When the destination is out of view (to the side or behind you), the icon sticks to the edge of the screen with an arrow pointing towards it: just turn until it comes back into view.
  • Far away the icon sits on the horizon; once the terrain around the destination is loaded it floats a few meters above the ground at the exact spot.
  • The active pin pulses on the map and minimap.
  • When you get there (10 m by default) the GPS turns itself off with a sound and a "You have reached your destination" message.
  • Ctrl + click the same pin again to turn the GPS off; Ctrl + click another pin to switch destination. Deleting the pin (right click) also turns it off.
  • The destination is remembered per character and per world: log out and back in, and the GPS is still on.

Works with every saved pin: your own markers, boss pins from Vegvisirs, tombstones, Hildir's pins...

Configuration

File BepInEx\config\ymiron.valheim.pingps.cfg:

Section Key Default What it does
1 - Controls SelectModifier LeftControl Key to hold while left-clicking a pin on the map.
1 - Controls TurnOffKey (none) Optional key that turns the GPS off without opening the map.
2 - Display IconSize 40 Size of the on-screen icon (pixels at 1080p, scales with resolution).
2 - Display ShowName true Show the pin name under the icon.
2 - Display ShowDistance true Show the distance under the icon.
2 - Display TextColor #FFD966 Color of the text and of the edge arrow.
2 - Display ShowEdgeArrow true Arrow next to the icon when it is stuck to the screen edge.
2 - Display EdgeMargin 70 Distance kept from the screen edges (pixels at 1080p).
2 - Display HeightAboveGround 4 Meters above the ground when the destination is close.
2 - Display PulseOnMap true Make the active pin pulse on the map.
3 - Arrival ArrivalDistance 10 Meters from the pin that count as "arrived".
3 - Arrival TurnOffOnArrival true Turn the GPS off on arrival (otherwise the marker is only hidden).
3 - Arrival SetSound sfx_gui_select Vanilla sound when setting / turning off. Empty = silent.
3 - Arrival ArrivalSound sfx_gui_biomefound Vanilla sound on arrival. Empty = silent.
4 - Messages DestinationSet, GpsOff, Arrived English Texts of the messages (translate them if you like).

The file can be edited while the game is running: the mod reloads it on save. It also works from the Configuration Manager (F1), if installed.

Notes

  • The marker is hidden while the map, the inventory, the menu or any text box is open, and when the HUD is hidden.
  • Selecting a pin needs mouse and keyboard (Ctrl + click); with a gamepad the GPS still shows, but cannot be set.
  • Client side only: the mod applies to whoever installs it. It is not needed on the server.

Installation

  • Mod manager (r2modman / Thunderstore Mod Manager): Settings > Import local mod and pick the zip.
  • Manual: copy PinGPS.dll into BepInEx\plugins.

Requires BepInExPack_Valheim.