Player Status HUD

Player Status HUD

Developer-focused status HUD library for Vintage Story

Current public release: 1.2.0

Player Status HUD is a reusable HUD layer and API for mods that need player-facing status icons with tooltips and animation semantics. It is designed for integration first: provider-based data model, stable ids, deterministic merge behavior, and production-safe defaults.

Mods using this library

Integrators can treat these mods as live demos of the Player Status HUD API in production gameplay.

• Hydrate or Diedrate Visualized — reference integration for different debufst wchich mod provide.
• SlowTox Visualized — reference integration for intoxication and effect statuses.

Why use this library

Stable runtime API	Register providers once and stream statuses per frame via IStatusStripProvider.
Deterministic merge	Sorted by SortOrder + StableId; duplicate id policy is predictable (last provider wins).
Semantic motion	Built-in Neutral / Positive / Negative affect kinds for meaningful animation feedback.
Config-first layout	HUD alignment and icon geometry are user-configurable without changing code.

Quick integration

Minimal client-side bootstrap:

var baseSys = api.ModLoader.GetModSystem<PlayerStatusStrip.PlayerStatusStripModSystem>();
IStatusStripHudApi? stripApi = baseSys?.StatusApi;
if (stripApi == null) return;
stripApi.RegisterProvider(myProvider);

Provider contract: append StatusDescriptor entries in Collect(), keep ids stable across frames, unregister on unload.

Configuration surfaces

• Layout: ModConfig/playerstatusstrip-hudlayout.json — icon size/gap, anchor behavior, row baseline locking, profile settings, draw order.
• Dev: ModConfig/playerstatusstrip-dev.json — `DevMode`, `UseMockStatuses`.
• Runtime reload: press F8 for layout reload feedback in chat.

Dev testing scenarios

Scenario ids for regression and UX checks:

meal mining combat weather recovery buzz

Commands: /stripmock list, /stripmock run <id>, /stripmock stop.

Documentation index

• API: PlayerStatusStrip/docs/PLAYER_STATUS_STRIP_API.md
• Dev guide: PlayerStatusStrip/docs/PLAYER_STATUS_STRIP_DEV_GUIDE.md
• Integration quick links: start with PLAYER_STATUS_STRIP_API.md, then use .striplayout show + Ctrl+F8 to validate your provider in-game.

Release metadata (version, modid, dependencies) is sourced from modinfo.json.