Difference between revisions of "Documentation/Tools/SCS Workshop Uploader/Workshop mod structure"
m (ErykDwornicki moved page Tools/SCS Workshop Uploader/Workshop mod structure to Documentation/Tools/SCS Workshop Uploader/Workshop mod structure without leaving a redirect) |
MarekTemnyak (talk | contribs) (Added note about mounting of MODs with subdirectories or ZIP archives.) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | The standard mod is a single '''package''' with manifest.sii file inside, description and icon files and the mod data files. The Workshop mod can and should consist of many '''packages''' - this | + | The standard mod is a single '''package''' with manifest.sii file inside, description and icon files and the mod data files. The Workshop mod can and should consist of many '''packages''' - this option allows you to provide multiple versions of your mod for users on different game versions using one Workshop mod. In the '''[[Documentation/Tools/SCS Workshop Uploader/versions.sii|versions.sii]]''' file you specify which '''package''' should be used when using the specified game update. But remember - this layout is only correct for Workshop mods. Standard mods are still using the one package approach. |
[[File:Mod_layout_explanation.jpg]] | [[File:Mod_layout_explanation.jpg]] | ||
| − | [[ | + | Each of these packages contains directly mod metadata (manifest.sii, description, icon) and mod data files. |
| − | [[ | + | |
| + | [[File:Package with mod metadata and mod data files.jpg]] | ||
| + | |||
| + | Since SCS Workshop Uploader version 1.0.38, package might contain subdirectories or files which are mounted only if DLC with the same name is owned. If mod root contains directory "base", zip archive "base.zip", directories or zip archives prefixed with "dlc_", game mounts only parts of the mod that correspond to owned DLCs. "base" part is mounted always (if it’s present). Mod manifest and other metadata are still contained in the package. | ||
| + | |||
| + | [[File:Package with zip files.jpg]] | ||
| + | |||
| + | [[File:Package with subdirectories.jpg]] | ||
| + | |||
| + | When using new style packages, each directory or zip archive is validated separately and only game base data and DLC with the same name is mounted to perform the validation. If you need to mount other DLCs, list them in manifest's '''dlc_dependencies''' array. | ||
Latest revision as of 06:43, 24 July 2023
The standard mod is a single package with manifest.sii file inside, description and icon files and the mod data files. The Workshop mod can and should consist of many packages - this option allows you to provide multiple versions of your mod for users on different game versions using one Workshop mod. In the versions.sii file you specify which package should be used when using the specified game update. But remember - this layout is only correct for Workshop mods. Standard mods are still using the one package approach.
Each of these packages contains directly mod metadata (manifest.sii, description, icon) and mod data files.
Since SCS Workshop Uploader version 1.0.38, package might contain subdirectories or files which are mounted only if DLC with the same name is owned. If mod root contains directory "base", zip archive "base.zip", directories or zip archives prefixed with "dlc_", game mounts only parts of the mod that correspond to owned DLCs. "base" part is mounted always (if it’s present). Mod manifest and other metadata are still contained in the package.
When using new style packages, each directory or zip archive is validated separately and only game base data and DLC with the same name is mounted to perform the validation. If you need to mount other DLCs, list them in manifest's dlc_dependencies array.
