This module downloads, updates, launches, monitors, and backs up Vintage Story dedicated servers.
NEEDS LIVE TEST. Official release resolution, safe archive extraction, executable resolution, and launch arguments require end-to-end testing against a current live server.
WindowsGSH resolves releases through Vintage Story's official release API and downloads the official Windows server-only ZIP from cdn.vintagestory.at.
- Choose
stablefor recommended releases orunstablefor preview releases. - Leave Server Version as
latestto follow the selected channel. - Enter an exact published version, such as
1.22.6, to pin that release.
An exact version must exist in the selected official channel. The downloaded archive's MD5 value is checked against the official catalogue before extraction. MD5 is used here to detect a damaged or mismatched vendor download; it is not treated as a cryptographic signature.
WindowsGSH launches the server with --dataPath VintagestoryData on every start and manages selected values in VintagestoryData/serverconfig.json. Unknown settings and Vintage Story's role definitions are preserved.
On the first start, or when an older partial configuration has no role definitions, the module asks Vintage Story itself to generate a complete default config with --genconfig, then reapplies the settings selected in WindowsGSH. An incomplete config is retained as serverconfig.json.windowsgsh-incomplete.bak; worlds and saves are not changed.
The configuration form also exposes curated new-world defaults for death inventory handling, creature hostility and damage, starting health, hunger, food spoilage, tool durability, temporal storms, map access, and the coordinate HUD. Vintage Story only reads these values from serverconfig.json while creating a world. For an existing world, apply the corresponding /worldconfig command in the server console instead.
The release channel and requested version are WindowsGSH installation settings. Updating with latest follows the selected channel; an exact value remains pinned until changed.
| Purpose | Default | Protocol | Exposure |
|---|---|---|---|
| Game traffic | 42420 |
TCP | Public; firewall/UPnP eligible |
If the server reaches Dedicated Server now running but the master server reports port not opened, the game itself started correctly but TCP port 42420 (or the configured replacement) is not reachable from the internet. Confirm the Windows Firewall rule, router port-forward/UPnP mapping, and whether the connection is behind carrier-grade or double NAT.
WindowsGSH reports supervised process state. RCON and remote administration are not advertised until implemented and verified.
- Executable:
VintagestoryServer.exe - Data path:
VintagestoryData - Backup target:
VintagestoryDatadirectory - Updates overwrite program files from the official server archive and exclude
VintagestoryDatafrom replacement.
- The configured Game Port is declared to WindowsGSH for host/firewall purposes but is not currently passed to the server process; the actual listening port is whatever the server's own configuration under
VintagestoryDataspecifies. - Release discovery and downloads require access to
api.vintagestory.atandcdn.vintagestory.at. - Updating overlays the official program files. Vendor files removed between releases may remain until a clean reinstall.
- RCON is not implemented.
- Install latest stable, latest unstable, and an exact published version; verify
VintagestoryServer.exeand checksum rejection behavior. - Confirm
--dataPathresolves toVintagestoryDataand existing configuration is honored. - Start, attach, restart WindowsGSH, stop, and confirm
VintagestoryDatais preserved. - Verify direct connection and player join on the port the server actually listens on.
- Test direct and WindowsGSM
serverfilesimports using Copy and Adopt. - Update an existing server and confirm
VintagestoryData, configuration, worlds, and mods remain intact; then test backup and restore.
Report issues through the issue tracker with sanitized version and log details. Never post credentials or private world data.
If you like the work I do and would like to support continued WindowsGSH and module development, you can contribute here:
Modules execute with WindowsGSH's Windows permissions. Review VintageStoryModule.cs, VintageStoryDownloadClient.cs, module.json, and SECURITY.md before installing. This module accepts catalogue data only from Vintage Story's official API and server archives only from its HTTPS CDN. See the official dedicated-server guide for vendor installation, data-path, networking, and administration guidance.