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

From SCS Modding Wiki
Jump to navigation Jump to search
Line 59: Line 59:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />
 +
 +
=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:'''
 +
 +
{| class="wikitable"
 +
!|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
 +
|}

Revision as of 10:31, 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