PZ LiveMap setup manual

A private browser map for your Project Zomboid server, with live players, searchable locations and likely-loot estimates. Players do not need a LiveMap mod.

Version 0.5.0. Both signed EXEs use automatic dependency downloads. Internet access is needed before the first render/import and when installing a new Cloudflare connector. Game assets are never included.

Automatic downloads

Setup verifies each download against a pinned SHA-256 checksum and retries failures up to three times. A progress window shows downloaded bytes and offers Cancel. After a failed or cancelled download, reopen Configure or the renderer. Completed verified files are cached under tools/dependency-cache; incomplete downloads are discarded. A working runtime is kept until its replacement is ready. Once installed, the runtime can be reused offline. Allow around 200 MiB free for dependency downloads and installation, separately from map output.

The initial download needs HTTPS access to python.org, files.pythonhosted.org, codeload.github.com, and github.com plus its release download hosts for Cloudflare. If a checksum fails repeatedly, check filtering/proxy software and retry; do not bypass verification. Updating an old bundled installation prepares the pinned runtime once on its next render/import.

1. Before installation

2. Configure LiveMap

  1. Run the signed setup EXE as administrator. The default LiveMap installation folder is C:\PZLiveMap.
  2. Review the detected dedicated-server folder, Zomboid data folder and server profile. Setup checks Steam libraries, common SteamCMD paths and Windows user profiles. If several installations are found, select the correct one; use Browse for custom paths. A custom -cachedir needs its actual data folder.
  3. The game folder contains media and the server launcher. The data folder contains Server\your-profile.ini. Enter the profile name without .ini.
  4. Choose an administrator username/password and a different team access code. Both secrets require at least eight characters. Share only the team code with players.
  5. Leave public access disabled initially, or enter your own HTTPS address and enable the public-address option. An address such as https://map.example.com is an example, not a supplied service. This Windows installer supports a hostname root, not a URL subpath.
  6. Let setup index the installed map and loot assets, create the map service and finish its health check.
  7. Restart the game server to load the telemetry agent when setup reports that a restart is required.

3. Terrain

The installer does not contain game maps or your rendered tiles. Choose Render terrain and select a matching full-client installation, area, floors and output location. Full-world rendering can take hours and substantial disk space.

You can instead render on another Windows PC with the portable renderer, transfer its Map.pzmap package, and import it on the server. Existing compatible terrain can be reused during upgrades; do not rerender just to update LiveMap.

4. Optional public access with Cloudflare Tunnel

  1. Create a tunnel in your own Cloudflare account. Follow Cloudflare’s domain and hostname setup requirements.
  2. For a new Windows connector, enter your public HTTPS address, enable the public-address option, and paste its token or service-install command into the optional masked setup field. If a connector service already exists, leave the token blank and configure its route in Cloudflare.
  3. Route your hostname to http://127.0.0.1:3000, or the local port you configured. Do not expose the internal ingestion port.
  4. In LiveMap Configure, enter exactly your public HTTPS address and enable public access. Setup sets the matching login origin and cookie settings. It does not create DNS records or hostname routes in your Cloudflare account.
  5. Use the configured public address for login. Check live movement and tile loading from a remote connection before sharing it with players.

Keep tokens private. Only terrain/static assets should be publicly cached; authenticated API responses must remain uncached.

5. Everyday use

Use the Open map shortcut or configured public URL. Team access can remember a device for 30 days. Search for locations or likely items; estimates describe loot tables, not current stock. Floor changes preserve the viewed location and zoom. Ground-floor labels remain visible beneath upper-floor terrain where applicable.

6. Updates and backups

Keep existing installation and game paths. Leave rendering unchecked when reusing terrain. Setup preserves accounts, configuration and tiles and reindexes when needed. The map website restarts during updates; the game needs a restart only when its telemetry integration changes.

Before moving hosts or backing up SQLite directly, stop the LiveMap service or use a consistent SQLite backup. Preserve configuration, database and associated files, catalog, terrain and calibration. Never publish account databases, configuration secrets or raw telemetry.

7. Troubleshooting