-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Welcome to the pzpw wiki!
To use PZPW command-line you need these software installed on your machine.
Install PZPW node module globally.
> npm install -g pzpw
Create a new Project Zomboid PipeWrench Mod anywhere you want in your computer.
> cd C:\My-PZPW-Mods
> pzpw new
Open the new mod directory in your code editor.
I personally use https://code.visualstudio.com/
When preparing your mod for the next Project Zomboid patch, you can switch PipeWrench typing to the unstable branch using a single command.
> pzpw switch unstable
You can switch back to stable branch using
> pzpw switch stable
- Create a new git repo on Github.
- Copy the repo url ending with
.git - Run
pzpw gitcommand from the root of your new mod directory. - Paste your
.gitrepo url. - Optionally, enter
yesto push your first commit.
PZPW Template use a file named pzpw-config.json to configure each mods and workshop information.
If you are using VSCode a json schema is included and configured by default to get auto-complete.
When adding a mod using the command pzpw add it will create an new asset directory for that mod.
You can place all your assets (scripts text file, models, textures, packs, etc) files in there.
You can add your copyright in assets/copyright.txt, the distribution compilation will prepend it at the top of each of your script.
You can set your workshop description in assets/workshop/description.txt, the workshop compilation will handle it automatically.
You can set your workshop preview image in assets/workshop/preview.png.
If you are using a custom Project Zomboid cachedir path you can set it using
> pzpw cachedir set D:/Zomboid
Otherwise it will default to the vanilla path.
> pzpw compile distribution
Distribution compilation will copy the generated mod directories into your game cachedir mods/ directory.
> pzpw compile workshop
Worshop compilation will copy the generated workshop directory into your game cachedir workshop/ directory.