Confirm with your password

ValheimLifecycleAnnouncer

Server-only Unix-socket lifecycle chat announcements for Valheim.

Server-only

· Website

Stars
0
Downloads
11
Version
0.1.4
Updated
Author
Str
Virus scan
✓ Scan successful
Runs on
Server-only

Description

Valheim Lifecycle Announcer

A small server-only BepInEx plugin that lets local lifecycle automation send chat announcements to everyone connected to a Valheim dedicated server. Use it for messages such as restart warnings without giving an external service access to the game process.

Features

  • Sends server chat announcements through Valheim's native chat system.
  • Accepts local broadcast requests over a Linux Unix-domain socket.
  • Only accepts requests from the same local account that runs the Valheim server; it does not open a network port.
  • Runs only on Linux dedicated servers.

Installation

  1. Install BepInEx 5 for Valheim.
  2. Download the release ZIP. Its root contains manifest.json, README.md, CHANGELOG.md, icon.png, and ValheimLifecycleAnnouncer.dll.
  3. For a manual installation, copy the root-level ValheimLifecycleAnnouncer.dll from the ZIP to the server's BepInEx/plugins/ directory. Thunderstore-compatible managers can install the ZIP directly.
  4. Start the server once to create BepInEx/config/io.hexium.valheim.lifecycleannouncer.cfg.
  5. Set Socket.Path to an absolute path outside the game directory, such as /run/valheim/lifecycle-announcer.sock.
  6. Create the socket's parent directory for the account that runs the Valheim server.
  7. Start the server.

The plugin creates the socket with owner-only permissions. Do not create the socket file yourself.

Configuration

The config file is BepInEx/config/io.hexium.valheim.lifecycleannouncer.cfg.

Setting Default Purpose
Socket.Path lifecycle-announcer.sock Unix-socket path. It must be absolute; its parent directory must already exist.
Chat.Prefix [Lifecycle] Prefix added to every announcement.

Local smoke test

After the server is running, test one standalone socket request with the same account that runs Valheim:

printf '%s' '{"schema_version":1,"operation":"broadcast","id":"manual-smoke-001","message":"Lifecycle announcer smoke test."}' \
  | nc -N -U /run/valheim/lifecycle-announcer.sock

The result must be JSON with "ok":true. Repeat the exact request within two minutes to verify that the plugin returns a cached result instead of sending a duplicate message.

Compatibility

  • Required: BepInEx 5 for Valheim (denikson-BepInExPack_Valheim 5.4.2202 or compatible).
  • Server only: Clients do not need to install this mod.
  • Platform: Linux dedicated servers only.
  • Access: The caller must be local and run as the same account as the Valheim server.

Changelog

0.1.4 Latest
  • Republish the tested server-only package with verified local test-server deployment and scheduled warning delivery.
0.1.3
  • Route lifecycle announcements from a server-owned sender identity to every connected dedicated-server peer.
  • Retain local Unix-domain socket access, owner-only permissions, bounded request processing, strict request validation, and idempotent responses.
0.1.1
  • Initial server-only lifecycle announcer release.
  • Add local Unix-domain socket broadcasts through Valheim's native chat system.

Full version history & older downloads →

Manual installation instructions
1

Install BepInExPack Valheim

BepInExPack Valheim is required to run mods in Valheim.

Download BepInExPack Valheim 5.4.2351 · View mod page

Check out the mod page for detailed installation instructions.

2

Install ValheimLifecycleAnnouncer

This mod only needs to be installed on the server.

Download ValheimLifecycleAnnouncer 0.1.4

Extract the ZIP and place the file(s) into the BepInEx/plugins/ folder inside your Valheim game folder.