This package has been deprecated and may no longer be maintained. We recommend looking for an alternative.
ServerGateway
Exposes live server status and authenticated local commands for Valheim.ServerGateway
Exposes live Valheim server information and authenticated commands through a local HTTP gateway.
Features
- Reports server and world names, connected players and player capacity.
- Reports the current in-game day.
- Queues immediate vanilla world saves through an authenticated local command.
- Listens only on
127.0.0.1for an on-machine website backend. - Supports dedicated servers and peer-hosted worlds.
Installation
| Client required | Server required |
|---|---|
| No | Yes |
Configuration
| BepInEx setting | Default | Purpose |
|---|---|---|
RPC.Port |
8765 |
Local port for GET /status. |
Gateway.Token |
Empty | Bearer token required by every endpoint. |
The JSON response contains server and world information plus players and playerDetails. Each player detail includes the character name, canonical platform user ID, and Steam ID when applicable.
Commands
| Method | Path | Authentication | Behavior |
|---|---|---|---|
GET |
/status |
Bearer token | Returns the current server and player snapshot. |
POST |
/commands/save |
Bearer token | Queues an immediate vanilla world and player-profile save. |
Read the full documentation on GitHub.
Contact
Report bugs through GitHub Issues. For questions, feedback, and other discussions, use GitHub Discussions.
