Mod manifest (SCS)

There is official documentation available on this topic: Documentation/Engine/Mod manager - SCS Modding Wiki


Using the Mod Manifest, you can define how your mod will be presented in the in-game Mod Manager. This covers both the mod thumbnail and the mod details view.

Here is how the mod thumbnail looks - it displays the mod icon, mod name, mod author and mod category:

Here's how the mod info window looks - all of the info is displayed in here:

Let's go over the Mod Manifest elements in detail:

Mod Name

This can be a string (text) of any length, but we recommend you keep it under 35-40 characters as it will get cut off by the game interface if it's longer. This field is optional.

Mod Author

This can be a string (text) of any length, but we recommend you keep it under 20 characters as it will get cut off by the game interface if it's longer. This field is optional.

Mod Version

This can be a string (text) of any length, but we recommend you keep it under 20 characters as it will get cut off by the game interface if it's longer. This field is optional.

Mod Category

Select the category that your mod belongs to. Select up to two categories. If you do not select a category, your mod will be classified as "Other". If you select more than two categories, only the first two from the list will be used.

DLC Dependencies

If your mod depends on a DLC, this is where you can select it. If you select DLCs in this list and user doesn't have all of them installed, they will not be able to activate your mod. This field is optional.

To manually add a DLC into the available DLCs list, open your MS2 directory (Main toolbar > Open MS2 directory) and navigate to: Data > ModData > SCS > Lists. There are two files in there that you can edit: dlcs-ats.xml and dlcs-ets2.xml. Open them with a text editor to add missing DLCs.

Compatible Versions

Here you can define what game version your mod is for. This field is optional. You can use this to limit what game versions the user can use with your mod. You can add multiple game version numbers in this field. (One per line). Also, you can use wildcards to define versions. However, we do not recommend locking your mod to a specific version, as users will not be able to use your mods as soon as a game gets updated above the version you wrote in this field.

Version can be written in following formats: 

1.34.9
1.35.*

* (star) is a wildcard symbol - if it's used it means all sub-versions are allowed.

Icon

This is the icon/thumbnail image that is shown in the Mod Manager and in the Mod Details window. It has to be a .jpg file with exact size: 276x162px.

Mod Description

This is the description of your mod that shows up in the Mod Info window. The length is not limited, and the game UI will display a scroll bar if necessary. This field is optional.

Color of the text in the description can be changed to one of these colors:

[normal] [white] [red] [blue] [green] [orange]


For example, description text written like this:

Hello Mods Studio 2 friends!

[blue]This is [normal]an example [orange]of colorized
description [green]text. You [red]should try [normal] to
use [white]it.

... will produce a in-game description looking like this: