Difference between revisions of "Tutorials/SCS Workshop Uploader/How to update workshop mod?"

From SCS Modding Wiki
Jump to navigation Jump to search
Line 202: Line 202:
 
=FAQ=
 
=FAQ=
  
>- Q: I want to upload map mod to Workshop however i get many errors that .aux
+
*Q: I want to upload map mod to Workshop however i get many errors that .aux
 
and other file formats are not supported. Help!
 
and other file formats are not supported. Help!
>- A: In initial release of the Steam Workshop implementation we do not support
+
*A: In initial release of the Steam Workshop implementation we do not support
 
map mod. We will implement support of them soon.
 
map mod. We will implement support of them soon.
  
-
+
 
>- Q: I want to create mod of type X however i don't see this type tag available.
+
*Q: I want to create mod of type X however i don't see this type tag available.
 
What to do?
 
What to do?
>- A: We do recommend using "Others" tag. However we will try to add new tags
+
*A: We do recommend using "Others" tag. However we will try to add new tags
 
over the time.
 
over the time.

Revision as of 10:58, 14 January 2016

How to send your newly created mod to Steam Workshop:

  1. Create folder where you will put your mod content.
  2. Create file called versions.sii where you will put definition of each version content.
  3. Put version specific content into appropriate folders - you can zip those folders.
  4. When you prepare everything launch SCS Workshop Uploader tool from your Steam Client.
  5. Select the game which will be the target application for your workshop creation. (At the moment Euro Truck Simulator 2 is implemented only)
  6. In “Mod data” section
    1. Select folder with your mod content. You need to select the root folder of your mod this where you have placed your versions.sii file and appropriate version folders/archives.
    2. Browse for preview image - it must be image file with size smaller than 1 MB. (TODO: i think i have some specific dimmensions - fill them here!)
  7. In the next section
    1. fill the Mod name (maximum 128 characters)
    2. select visibility state (if the mod is private, friends only or public).
  8. In “Description” section fill your mod description - the minimum amount of characters is 50 characters - maximum is 8000 - we count one byte as characters so in case you are using characters from different alphabet than english one one character may count as 2 or more. (Also new lines, spaces count as character) # In “Tags” section
    1. You must select Type of your mod
    2. Truck parts and Brand are optional
  9. In “Change note” you specify changelog of new mod version - in this case you can leave it empty or simply write there something like “Initial release” or “First version release”.
  10. When you are done you can press Upload button. In case validation failed or some different problem happened you will be informed by proper dialog.

If it’s your first mod and you were not doing any mods for other game you will likely get error about not accepted Steam Workshop Terms Of Service - if so happends tool will show you appropriate message and the steam workshop terms of service will be opened in your default web browser - you have to login to your steam account read and accept the terms of service and if you do so simply go back to the tool and try again with uploading your mod.

How to upload new version of your mod:

If you have prepared new version of the mod, created new version entry in versions.sii and put the content in appropriate directory you must follow those steps to upload it to the workshop.

  1. Select the game on which workshop your mod is. (At the moment only Euro Truck Simulator 2 is implemented)
  2. Select your item from the combobox in “Item” section.
  3. In case icon and preview file hasn’t changed simply skip “Mod data” section - in case something new appeared adjust the settings.
  4. In the next section
    1. In case you want to specify the version adjust the Mod name setting.
  5. . In "Description" section adjust the description.
  6. . In "Tags" section adjust them to fit new mod version.
  7. . In "Change note" we recommend to write full changelog to keep your mod users up-to-date what did you changed in the new version of the mod.
  8. . When you finished everything press "Upload" button. In case validation failed or some different problem happened you will be informed by proper dialog.

versions.sii

In the Steam Workshop mods you need to specify have versions.sii file containing definition which content folder should be used for which game version.

This file contains set of package_version_info serialized unit informations with proper set of the attributes.

  • Example file:

        SiiNunit
        {
        package_version_info : .latest {
                folder: "latest"
        }

        package_version_info : .122.content {
                folder: "content_122"
                compatible_versions[]: "1.22.*"
        }

        package_version_info : .120and121.content {
                // No special difference between 1.20 and 1.21
                folder: "content_120_121"
                compatible_versions[]: "1.20.*"
                compatible_versions[]: "1.21.*"
        }
        }

Package version info

Package version info is unit containing version informations such like name of the folder or archive with content and the array of compatible game versions.

The package version info without defined compatible_versions is called universal version. This version will be used for all game versions that are not explictly defined inside versions.sii file.

package_version_info unit attributes:

Type Name Description
string folder The name of the folder or archive with the version-specific mod content. This is required attribute.
string array compatible_versions The array containg set of versions that are compatible with this version definition. This attribute is optional, if not specified this version will be used for all of the game versions - you can only have one `package_version_info` with this parameter not specified in versions.sii

Example mod directory layout

Here you have example how your mod directory/files structure should look.

  • /
    • versions.sii
    • latest/
      • manifest.sii
      • icon.jpg
      • description.txt
      • other data files for this version
    • content_122.zip
      • manifest.sii
      • icon.jpg
      • description.txt
      • other data files

Differences between standard mods and workshop mods

  1. Workshop mods have more complex layout - versions.sii etc.
  2. In normal mods you specify `compatible_versions` in manifest.sii file however for steam workshop mods you specify `compatible_versions` array in versions.sii file.
  3. When you are creating standard mod you need to take care about it's distribution and your mod users needs to take care of downloading up-to-date version Steam Workshop mods are automatically downloaded when you send new version to workshop for each mod subscriber.

Validation

Each mod before entering workshop must pass validation process - it is because we do not want to have mods that may cause problem for players due to some trival problems which we can easily prevent.

In case validation finished with any warning or error at the end of the validation process you will see the log window so you can easily inspect what is broken and what to fix - also the log is written to the `validation.log.txt` file placed by default in:

On Windows:

C:/Users/%user_name%/My Documents/SCS Workshop Uploader/validation.log.txt

On Linux:

/home/.local/share/SCS Workshop Uploader/validation.log.txt

On Mac OS X:

/Users/%user_name%/Library/Application Support/SCS Workshop Uploader/validation.log.txt

Where `%user_name%` is your user name.

In the Validation error and warning codes section you can find error and warning codes that may be helpful in finding why the validation failed.

Validation error and warning codes

In result of validation you can get errors and warnings. With most of them you also have descriptive information about what is the real reason of it. We present you list of the error and warning codes with the explanation what they mean.

Errors:

Code Name Description
00001 Generic error Any error that does not fit error codes below.
00002 File not found File is not found.
00003 Not allowed Something that is not allowed for example placing ".." in paths or windows-like path separators.
00004 Malformed file The file is malformed and will definitely crash the game - you should try to reexport it or resave it.
00005 Some of the required unit attribute is not set.
00006 Access denied Tool failed to create file or read it.
00007 Not supported Some file has not supported version or some feature is not supported.
00008 Unable to load Unable to load some file - in most cases its similar to `00002` error.
00009 File is too big File is too big.
00010 Unused field set Field that must not be set was set.

Warnings:

Code Name Description
00001 Generic warning Any warning that does not fit warning codes bellow.
00002 Unused field set Field that should be not set is set. Not critical but should be fixed.

FAQ

  • Q: I want to upload map mod to Workshop however i get many errors that .aux

and other file formats are not supported. Help!

  • A: In initial release of the Steam Workshop implementation we do not support

map mod. We will implement support of them soon.


  • Q: I want to create mod of type X however i don't see this type tag available.

What to do?

  • A: We do recommend using "Others" tag. However we will try to add new tags

over the time.