CompassVR
A VR-compatible compass for Valheim with distance-based pins and customizable layout.
About this mod Author’s original text
CompassVR
A VR-friendly compass for Valheim, designed to work smoothly with VR mods while maintaining performance and clarity.
✨ Features
- 🧭 Smooth scrolling compass
- 📍 Map pins displayed in-world
- 📏 Distance text for pins
- 📐 Distance-based pin scaling
- ⚙️ Fully configurable layout (size, position, distance, etc.)
- 🧠 Optimized with pooling (no per-frame allocations)
⚙️ Configuration
All settings can be changed live using BepInEx Configuration Manager.
Transform
- Scale — overall size of the compass
- Distance — distance from camera
- Vertical Offset — vertical position
Mask (Visible Area)
- Width — how wide the compass appears
- Height — height of the compass window
Pins
- Max Distance — max range for pins (default 350m)
- Min Scale At Max Distance — how small pins get (default 25%)
- Show Distance Text — toggle distance labels
- Distance Text Range — how close to center before showing text
Compass
- Rotation Offset — aligns cardinal directions correctly
📂 Installation
- Install BepInEx for Valheim
- Place CompassVR.dll into:
Valheim/BepInEx/plugins/
- Launch the game
🧪 Notes
- Designed specifically for VR usage
- Works best with high-resolution compass textures (e.g. 4096x64)
- Mask controls the visible width — increase it for wider VR FOV
🎨 Customization
You can replace textures in:
BepInEx/config/CompassVR/
Supported files:
- compass.png
- center.png
⚠️ Known Limitations
- No curvature (flat UI)
- Distance text uses Unity UI (not TextMeshPro)
- Mask is rectangular (no soft-edge fading)
🛠️ Future Improvements
- Curved compass for VR
- Better edge fading
- Advanced pin filtering
- Improved text scaling
❤️ Credits
- Valheim developers
- BepInEx team
- Original Compass mod inspiration
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: