Mod structure

This page has been revised for the current stable version (41.78.16).

Help by adding any missing content. [edit]

A mod for Project Zomboid must have a certain folder and file structure in order for it to be correctly processed by the game. Only the mod.info file and the media/ folder are required. The rest of the folders and files in the media/ folder are optional and depend on what will be added by the mod.

Mod folder structure

mod.info

This text file contains a description of the mod and those. mod data Example

name=Aquatsar Yacht Club v.1.17
poster=poster.png
require=tsarslib
id=AquatsarYachtClub
versionMin=41.73
description=This is boat mod

The meaning behind each parameter:

name - the name of the mod, which will be displayed in the mod menu. Required parameter.
id - mod ID of your mod. Choose carefully, as it must be unique among all Project Zomboid mods on Steam - so don't use short IDs. Required parameter.
poster - the cover of the mod. There may be several - for this, specify several images. Example:

...
poster=Image1.png
poster=Image2.png
...

require - specifies the mod ID of the mod that your mod requires. For example, some library.
versionMin - minimum game version for your mod. The mod will not run on an earlier version of the game.
versionMax - the maximum game version for your mod. The mod will not run on a later version of the game.
description - a description of your mod, which will be displayed in the mod menu. It may be specified many times in order to make it easier to read the description in the mod.info file. All lines will be merged into one and will be displayed in full text.
pack - specifies the third-party texture pack that you are using in your mod. Several may be specified.
tiledef - specifies a file with tile parameters. Several may be specified.

media/

The folder that contains all the content of the mod. Files will be placed in this folder or in subfolders.

media/models_X

3D models (.x or .fbx files) of objects, clothes, vehicles are placed here.

media/scripts

Script files for items, vehicles, recipes, clothes are placed here.

media/textures

Here files of images of textures of objects, clothes, vehicles are placed.

media/ui

Here are placed image files for icons, interface.

media/texturepacks

Here are the texture pack files.

media/lua/

The folder contains subfolders where all Lua code will be placed.

media/lua/shared

The folder contains Lua files that will be executed both on the server side and on the client side

media/lua/client

The folder contains Lua files that will only be executed on the client side.

media/lua/server

The folder contains Lua files that will only be executed on the server side.

media/sound

Audio files are placed here.

media/maps

Here are the files of the new map.

media/animSets

Here are xml scripts describing animation parameters.

media/anims_X

Animation files (.x or .fbx) are placed here.