Correctly packing mods

All mods on the repository need to work from the get-go for any user who installs it, and this means that the folder structure of the compressed zip file needs to be correct. This is commonly referred to as how the mod is packed.

The first file inside your zip should always be the appropriate top level folder (or folders) for your content. This is usually the vehicles or levels folder but may also be lua, ui, art or a range of others depending on what the mod is. This folder is what needs to be selected and compressed/zipped, instead of the mod folder these are contained inside or any individual parts of a mod.

Basic example

An example file structure, in this case for a vehicle configuration mod that has been unpacked could look like this in your mods folder:

/mods/unpacked/my_new_config/vehicles/pessima/pessima_awesome_configuration.pc

You would need to select and compress the vehicles folder here, as this is the top level folder that tells the game what type of content it is. The zip file will take the place of the folder that holds the mod content and it’s name can be whatever you wish (provided it’s relevant to the mod itself of course).


Multiple Folders

Some mods contain more than one top level folder. For example, an Automation vehicle may include both:

  • vehicles
  • art

In this case, select both folders at the same time and compress them together. This applies to all folders that exist at the same level in your mod structure.


Packing multiple mods into one file

If you have multiple mods you would like to include in the same file, always make sure the same folder structure is being followed.

In the case of multiple car mods you would like to upload together, you would merge them into the same mod folder so that the individual car folders are together under the same parent vehicles folder, which would then be compressed and uploaded to the repository.


Top Level Folders

All available top level folders used by mods:

Folder
Description
Folder
vehicles
Description
For individual vehicles
Folder
levels
Description
For individual levels
Folder
art
Description
Common assets used by levels and missions, always loaded and available
Folder
assets
Description
Assets shared between levels, used with the asset linking system
Folder
lua
Description
For all regular Lua scripts and code
Folder
scripts
Description
Used for basic scripts, usually for loading Lua extensions
Folder
ui
Description
For all UI app related content
Folder
gameplay
Description
For all mission files
Folder
settings
Description
Used for settings files, such as additional input maps
Folder
trackEditor
Description
Used for all saved Track Builder files
Folder
vehicleGroups
Description
Used for all vehicle group files created through the Vehicle Groups Editor


Common Mistakes

  • Zipping the mod folder that contains the top level folder (vehicles, levels, etc.)
  • Only including individual modified files (such as singular config.pc files outside of a folder structure)
  • Mixing unrelated files and folders outside of the valid top level directories

Key Rule

When opening your .zip, the first visible folders should be the relevant top level folders like vehicles, levels, lua, etc.

If you see your mod name as the first folder, it is packed incorrectly.


Last modified: April 22, 2026

Any further questions?

Join our discord
Our documentation is currently incomplete and undergoing active development. If you have any questions or feedback, please visit this forum thread.