Project Zomboid Server Tools

A set of tools to help you with running a Project Zomboid game server (Linux only).

Features

• Install Project Zomboid Dedicated Server easily in a single command.
• Restart Project Zomboid Dedicated Server automatically when a mod is updated on Steam workshop.
• Manage multiple Project Zomboid Dedicated Server running on the same machine.

Tools

Once Project Zomboid Server Tools have been installed successfully, you will have access to the following commands:

• pzinstall: Install Project Zomboid Dedicated Server for the current user
• pzconfig: Edit Project Zomboid Dedicated Server configuration (servertest.ini)
• pzsandbox: Edit Project Zomboid Dedicated Server sandbox configuration (servertest_SandboxVars.lua)
• pzspawnpoints: Edit Project Zomboid Dedicated Server spawn points configuration (servertest_spawnpoints.lua)
• pzspawnregions: Edit Project Zomboid Dedicated Server spawn regions configuration (servertest_spawnregions.lua)
• pzserver: Start Project Zomboid Dedicated Server in the background (no need to use screen)
• pzlog: Show console output of Project Zomboid Dedicated Server
• pzquit: Stop Project Zomboid Dedicated Server
• pzcmd: Run a server command (like chopper, additem, etc)
• pzmessage: Display a message on the server visible to all connected players
• pzrestart: Restart Project Zomboid Dedicated Server
• pzrestarter: Automated task to restart Project Zomboid Dedicated Server when it detects a mod has been updated on Steam workshop

Install

To install Project Zomboid Server Tools, run the following commands:

cd "${HOME}"
git clone https://github.com/quarantin/pz-server-tools
cd pz-server-tools
./bin/install

Configuration

Edit the file /etc/pz-server-tools/config.json as root:

sudo nano /etc/pz-server-tools/config.json

Add each system user that is running a Project Zomboid Dedicated Server to the list under pzservers. For example if you have two servers running with users pzuser1 and pzuser2, the config.json should look like this:

{
	"pzservers": [
		"pzuser1",
		"pzuser2
	]
}

One you're done editing the configuration, run the following command to check for syntax errors:

cd "${HOME}"
cd pz-server-tools
./bin/checkconfig

By default, Project Zomboid Server Tools are configured to check for mod updates once per hour. If that doesn't suit you, edit the file /etc/cron.d/pz-server-tools as root:

sudo nano /etc/cron.d/pz-server-tools

Update

To update Project Zomboid Server Tools, run the following commands:

cd "${HOME}"
cd pz-server-tools
./bin/update

Uninstall

If you want to uninstall Project Zomboid Server tools, run the following commands:

cd "${HOME}"
cd pz-server-tools
./bin/uninstall