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

1. Install BepInEx for Valheim
2. Place CompassVR.dll into:

Valheim/BepInEx/plugins/

1. 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