16
edits
Changes
Jump to navigation
Jump to search
m
Fixed grammar, spelling and clarified some things.
=Introduction=
In this tutorial , we will show you how to prepare your mod for uploading it to the workshop step by step.
==Workshop mod files and directories layout==
{{Tip|For better organization of the directories. We recommend to call this folder ''122_content'' - 122 stands for 1.22 version with removed dot. For example - for 1.23 update it will be 123, for 1.6 it will be 16 , etc.}}
|- style="vertical-align:top;"
| '''2'''
|[[File:0009_add_new_unit_to_versions_sii_with_122_content_step_1.jpg|500px]]
|Open your text editor and do exatly exactly the same steps as you did while adding a definition for the universal update. version of your mod (Besides besides using a different folder and unit namethis time).
<pre>SiiNunit
| '''3'''
|[[File:0010_add_new_unit_to_versions_sii_with_122_content_step_2.jpg|500px]]
|There is new step Now there are some more steps you have will need to take. go through: Set the value of the compatible_versions attribute. As we want to have data for 1.22 update simply write there "1.22.*". Values are similar to compatible_versions array in manifest.sii.
If you want to use this package for version 1.23 update only you will need to write:
<pre>compatible_versions: "1.23.*"</pre>
If you want to support only one update by this content version (not recommended) you will write:
<pre>compatible_versions[]: "1.22.1"</pre>
The value of this attribute can contain numbers, dots "." (between numbers) and asterisk "*" (at the end). Using asterisk inside text or at the beginning is not allowedIf you only write "1.35.1" your mod will only be compatible with this specific version. The use of "1.35.*" will make your mod compatible with all small updates for version 1.35 (recommended).
<pre>SiiNunit
{{Tip|We recommend using similar syntax as for single version specify content, but for separating the versions use underscore "_". For example , if the content will be used by both 1.23 and 1.24 content package will be called: "123_124_content" in case you want the content package to be used for 1.24, 1.25.0 and 1.25.2 updates the content package will be called "124_1250_1252_content".}}
|- style="vertical-align:top;"
| '''5'''
*Run '''SCS Workshop Uploader''' tool from your steam client.
#Select the '''game''' that is compatible with your mod.
#Select '''New''' item from the items comboboxdropdown. It should be selected by default when you launch the tool.#In the '''Mod data''' section - browse for a your '''mod data folder'''. This folder should include your packages and version.sii file.
#If you select folder, browse for '''mod preview image'''.
#In next step fill '''mod name'''.
#You can select '''truck parts''' and '''brand''' tag if appropriate.
#You can now fill '''change note''' of your mod. If you need to have the edit box bigger simply resize the tool window. As it's initial upload step you will more likely write nothing here - or write something like ''"Initial upload."''.
#If you did all the points simply click '''Upload''' button. Before the actual upload operation , the tool will check if your mod contains the correct data.
{{Note|You may notice that when you are using non [https://en.wikipedia.org/wiki/ASCII ASCII characters] the counters are decreasing by more than one. It is because those characters have a bigger size than one byte. The counters are counting bytes space used by description and title - not the character count}}
==Validation==
[[File:0025_in_case_of_error_you_will_get_this_dialog.jpg|500px]]
When you click '''OK''' you will see log dialog with all errors and warnings that occured occurred during validation. In case if you have only warnings you can both continue or abort the operation. In case of error errors, you will '''need to''' fix them before uploading.
{{UsefulLink|If you need help with solving your validation errors click '''[[Documentation/Tools/SCS_Workshop_Uploader/Validation_errors_and_solutions_for_them|here]]'''}}
#In this line you have the summary of the validation - the number of errors and warnings.
#In this area you have log of the validation. All the log entires have the following form: '''''[TYPE] [CODE] (file): Message'''''
#Bellow you have two checkboxes, you can hide warnigns warnings or errors here.
#In case there are is at least one error you are able to only click Abort. This button simply aborts the upload.
#In case validation did not report any error you can click this button and continue uploading of your mod. If there are errors you are unable to continue - you have to fix the problems.
==Success==
If there are no errors and the upload will continue on successfull upload and if everything goes right you will see this dialog.
[[File:0026_upload_success.jpg]]
=Steam Workshop Terms Of Service=
If it’s your first mod and you were not doing any mods for other game <!-- '''(or Valve updated Terms of Service?)'''--> you will likely get an error about not accepted Steam Workshop Terms Of Service - if so happends happens the 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 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. It is '''mandatory''' to agree to these terms.
