Mods for Project Zomboid are entered in the server configuration. The server downloads them from the Steam Workshop on startup, and players get them automatically when joining.
1. Look up the IDs
At the bottom of the description on the mod's Workshop page you'll find two values:
- Workshop ID: a long number, e.g.
2875848298for the mod "Common Sense" (also in the page address). - Mod ID: a name, e.g.
BB_CommonSense. Some Workshop entries contain several Mod IDs – note down all the ones you want to use.
2. Enter them
- Stop the server.
- Tab Files → folder
.cache/Server/→ open the file<servername>.ini. The server name is the value of the startup variable Server Name (SERVER_NAME) – by default the file is calledPterodactyl.ini. - Enter the values, several separated by a semicolon:
WorkshopItems=2875848298;1234567890
Mods=BB_CommonSense;OtherModID
- Save and start the server. The first start with new mods takes longer – you can follow the progress in the Console.
Map mods
Additional maps also need an entry in the Map= line – before the default map, e.g. Map=Bedford Falls;Muldraugh, KY. The Workshop page gives the exact map name.
Good to know
- Build 42: Our servers run the current version (Build 42). Make sure your mods support Build 42 – this is stated on the Workshop page.
- Dependencies: If a mod needs another one (listed under "Required items" on the Workshop page), add that one too.
- Changed the server name? Then the server creates a new
.ini– enter the mods there again. - Create a backup before larger mod changes. If the server no longer starts, this article helps.