WorldSaveMuzzler

A standalone, 100% client-side quality-of-life mod for Valheim that slaps a muzzle on those obnoxious, screen-stealing world save alerts so they finally shut up and stop screaming across your crosshair while you're fighting for your life.

[!NOTE] Client-Side Only: This mod is installed locally on your PC. It does not need to be installed on the server and works when playing singleplayer or connecting to any dedicated or community server.

[!IMPORTANT] Valheim Community Patch Extras Notice: This code was already merged into Valheim Community Patch Extras, but is being released standalone for those who do not want the VCP Extra mod installed.

If Valheim Community Patch Extras is installed, WorldSaveMuzzler will automatically detect it and safely self-disable to prevent duplicate handling.

---

The Problem

In vanilla Valheim, Game.UpdateSaving broadcasts a 30-second autosave warning ("$msg_worldsavewarning 30s") and a save completion alert ("$msg_worldsaved") using MessageHud.MessageType.Center.

This splashes a giant, screen-filling yellow banner directly across your crosshair and combat view. Furthermore, many dedicated servers and admin management scripts broadcast custom countdowns to all players using center-screen toasts.

During intense combat, boss encounters, ocean sailing, or delicate scaffolding construction, having the middle of your screen suddenly blinded by an autosave banner can easily cause mistimed parries, disorientation, accidental falls, or death.

The Solution

WorldSaveMuzzler intercepts MessageHud.ShowMessage and provides clean, customizable display options:

• RelocateToTopLeft (Default): Moves world save countdown warnings and save notices into the subtle top-left notification feed. You stay informed of pending saves without having your crosshair or view blocked.
• Mute: Silences center-screen world save notifications entirely for an uninterrupted, immersive experience.
• Native: Leaves notifications centered across the screen unaltered.

---

Configuration

Settings can be customized directly in-game using the BepInEx Configuration Manager (F1 / F5 depending on configuration) or by editing BepInEx/config/dreamwraith.WorldSaveMuzzler.cfg:

Section	Key	Type	Default	Description
1 - General	WorldSaveNoticeMode	enum	RelocateToTopLeft	Display mode: RelocateToTopLeft (subtle top-left corner feed), Mute (completely hidden), or Native (centered yellow banner).

---

Compatibility

• Valheim Community Patch Extras: This code was already merged into Valheim Community Patch Extras, but is released standalone for those who do not want the VCP Extra mod installed. If VCP Extras is present, WorldSaveMuzzler automatically self-disables to prevent duplicate or conflicting notification handling.
• 100% Client-Side: Safe to use on any server. The server does not need this mod installed.
• Smart Detection: Recognizes native Valheim localization keys ($msg_worldsavewarning, $msg_worldsaved) as well as plain English countdown broadcasts from common server scripts (e.g., "World save in 30s").
• Headless Safe: Inert on headless servers where MessageHud is not rendered.

---

Installation

[!TIP] Client-Side Only: Install this on your local PC via your preferred mod manager (Gale / r2modman / Thunderstore) or manual drop. Nothing needs to be installed on the server.

Mod Manager (Recommended)

1. Install via Gale, Thunderstore Mod Manager, or r2modman.
2. Launch Valheim.

Manual Installation

1. Ensure BepInExPack Valheim is installed.
2. Download and extract the release archive.
3. Place WorldSaveMuzzler.dll into your Valheim/BepInEx/plugins/ directory.
4. Launch Valheim.

---

Building from Source

The project uses a portable MSBuild configuration that auto-detects standard Steam paths.

dotnet build -c Release

The compiled assembly will be placed in bin/Release/net48/WorldSaveMuzzler.dll. Building in Release configuration also automatically packages the distribution ZIP to bin/Publish/WorldSaveMuzzler-<Version>.zip.

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, Publishing & Releases

All developer automation tools for release management, packaging, and publishing to Thunderstore and Nexus Mods are consolidated into the single PowerShell 7 entrypoint .scripts/modtools.ps1, powered by the shared DW.ValheimModTools module:

• Release Management: pwsh ./.scripts/modtools.ps1 release compiles in Release, creates mod & source archives, extracts changelog notes, and publishes GitHub Releases (Draft by default, or published with -Publish) using the gh CLI.
• Packaging & Version Bumping: pwsh ./.scripts/modtools.ps1 package -Bump Patch increments SemVer in WorldSaveMuzzler.csproj, updates manifest.json, and bundles distribution archives.
• Portal Publishing: pwsh ./.scripts/modtools.ps1 publish -Target All uploads directly to Thunderstore and Nexus Mods APIs.
• CI/CD Workflow: .github/workflows/publish.yml provides an automated GitHub Actions workflow to publish to Thunderstore and Nexus Mods whenever a GitHub Release is published.

For detailed documentation on flags, workflows, and secret configuration, see .scripts/README.md.

---

License, Author Notes

• This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details.
• A Small Note from Me about Valheim Modding Specifically - Thoughts on open-source modding, community inclusivity, and anti-gatekeeping.
• A Note on AI, Software Craft, and Why This Code Exists - Personal essay on software craft, human agency, and engineering responsibility.