MiniMapHeeler

In native Valheim, the HUD minimap is locked to a fixed 200x200 square with a narrow zoom range, offering no way to adjust its size to fit your display or UI preferences. MiniMapHeeler unlocks minimap sizing while keeping the surrounding HUD clean and properly aligned.

This mod runs client-side on your local HUD. It does not need to be installed on servers and works in multiplayer.

---

Features

• Custom dimensions: Freely adjust width (100-1920) and height (100-1080) larger or smaller without texture distortion.
• Wider zoom range: Expands zoom boundaries with balanced steps so zooming in and out stays consistent.
• HUD alignment: Automatically offsets status effect icons to prevent overlap, with an optional layout to place the minimap below them.
• Live in-game tuning: Settings changed in BepInEx Configuration Manager (F1) apply immediately without restarting.
• Client-side only: Safe for local worlds and multiplayer servers with no server installation needed.

---

Configuration

Settings can be changed in-game using the BepInEx Configuration Manager (F1) or by editing BepInEx/config/dreamwraith.MiniMapHeeler.cfg:

Section	Key	Type	Default	Description
1 - General	EnableMod	bool	true	Enable or disable the mod.
2 - Dimensions	MinimapWidth	float	200.0	Minimap width in UI units (native default is 200; scales with UI scale).
2 - Dimensions	MinimapHeight	float	200.0	Minimap height in UI units (native default is 200; scales with UI scale).
3 - HUD Placement	ShiftBelowStatusEffects	bool	false	When true, aligns status effects to the right edge and places the minimap below them.
3 - HUD Placement	PositionOffsetX	float	0.0	Horizontal offset in UI units from default position.
3 - HUD Placement	PositionOffsetY	float	0.0	Vertical offset in UI units from default position.
9 - Debug	EnableDebugLogs	bool	false	Enable verbose diagnostic logging in console and Player.log.

---

Compatibility

• Client-side only: Runs locally on the game HUD; safe to use on any multiplayer server.
• Single-player: Fully functional in local worlds.
• Mod managers: Compatible with Gale, Thunderstore Mod Manager, and r2modman.
• UI scaling: Fully compatible with Valheim's built-in UI scale slider (dimensions and offsets scale proportionally with the rest of the HUD).

---

Installation

Mod Manager (Recommended)

Install through Gale, Thunderstore Mod Manager, or r2modman.

Manual Installation

1. Install BepInExPack Valheim.
2. Download the latest release from GitHub or Thunderstore.
3. Place MiniMapHeeler.dll into Valheim/BepInEx/plugins/.
4. Launch Valheim.

---

Building from Source

Build using the .NET SDK:

dotnet build -c Release

The compiled assembly is output to bin/Release/net48/MiniMapHeeler.dll. Building with the Release configuration also creates a distribution zip in bin/Publish/.

Custom & CI Paths

For custom installations, non-standard Steam paths, or mod manager profiles, copy Environment.props.example to Environment.props in the project root to configure your paths:

• VALHEIM_INSTALL: Root Valheim installation folder.
• BEPINEX_PATH: Root BepInEx folder (containing core, plugins, etc.).

Alternatively, you can set VALHEIM_INSTALL and BEPINEX_PATH as environment variables.

Packaging and Releases

Packaging and release automation are handled through .scripts/modtools.ps1 using the DW.ValheimModTools module:

• Create a release: pwsh ./.scripts/modtools.ps1 release (builds Release, creates distribution archives, extracts changelog notes, and creates a GitHub Release).
• Bump version and package: pwsh ./.scripts/modtools.ps1 package -Bump Patch
• Publish to mod portals: pwsh ./.scripts/modtools.ps1 publish -Target All (uploads to Thunderstore and Nexus Mods).

For full script options and secret configuration, see .scripts/README.md.

---

License & Notes

• This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details.
• A Note on Valheim Modding
• A Note on AI and Software Craft