MountainFarmer-PeakCompass icon

PeakCompass

Adds an on-screen compass bar that tracks other players with colored directional dots and distance labels in real-time.

Last updated 2 hours ago
Total downloads 17
Total rating 0 
Categories Tools World Quality Of Life Client Side
Dependency string MountainFarmer-PeakCompass-1.0.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

PeakCompass

A client-side compass mod for PEAK that helps you track your teammates in real-time during multiplayer sessions.

Features

Compass Bar UI

A sleek horizontal compass bar appears at the top of your screen showing:

  • Colored dots for each teammate - dots match each player's in-game skin color
  • Real-time position tracking - dots move left/right based on the player's bearing relative to your camera direction
  • Distance display - a label below each dot shows the distance in meters to that player
  • Dynamic color updates - if a player changes their skin color, the dot updates automatically

How It Works

  • Players directly in front of you appear in the center of the compass bar
  • Players to your left appear on the left side, players to your right appear on the right
  • The further left or right a dot is, the more you need to turn to face that player
  • Distance labels help you gauge how far away teammates are

Technical Details

  • Uses Photon PUN2 networking callbacks to detect when players join or leave
  • Retrieves player positions using the game's Character.Center property for accurate real-time tracking
  • Automatically handles scene reloads and reconnections
  • Dot colors are retrieved from Character.refs.customization.PlayerColor to match in-game skins

Installation

Requirements

  • BepInEx 5 - the modding framework for Unity games

Steps

  1. Install BepInEx 5 for PEAK if you haven't already
  2. Download the latest PeakCompass release from Thunderstore
  3. Extract the contents so that PeakCompass.dll is placed in your BepInEx/plugins folder
  4. Launch PEAK and join a multiplayer session

File Structure

PEAK/
└── BepInEx/
    └── plugins/
        └── PeakCompass.dll

Usage

Once installed, the compass automatically appears when you're in a multiplayer session with other players. There's nothing to configure - it just works!

  • Join a multiplayer game - the compass will show dots for all other players
  • Look around - watch the dots move as players change position relative to you
  • Check distances - glance at the numbers below each dot to see how far away teammates are
  • Find lost teammates - use the compass to navigate toward players who are far away

Compatibility

  • Client-side only - does not require the host or other players to have the mod installed
  • No server modifications - works on any multiplayer session
  • Works with other mods - designed to be compatible with other BepInEx mods

Troubleshooting

Compass not appearing?

  • Make sure you're in a multiplayer session with at least one other player
  • Check that the mod is loaded by looking for PeakCompass in the BepInEx console output
  • Try rejoining the session

Dots not moving correctly?

  • The mod uses the game's internal position tracking which may have brief delays for network players
  • Positions are sampled from the character's torso for accuracy

Colors not showing?

  • Player colors are retrieved from the game's customization system
  • If a color can't be retrieved, dots default to red

Changelog

See CHANGELOG.md for version history.

Credits

  • Built using extensive analysis of PEAK's decompiled game code
  • Position tracking method discovered from the game's Campfire.EveryoneInRange() implementation
  • Color retrieval based on CharacterCustomization.PlayerColor property

License

This mod is provided as-is for personal use with PEAK.