Changes

# Create =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==First of all - the layout of your mod will change a little bit. To check the Steam Workshop mods structure click [[Documentation/Tools/SCS_Workshop_Uploader/Workshop_mod_structure|here]]. ==Preparing mod for uploading step by step== {| class="wikitable" width="100%"|- style="vertical-align:top;"| '''1'''| style="width: 500px" | [[File:0002_create_folder.jpg|500px]]|First step of preparing your mod is creating of the folder where you . You will put there all the files and folders needed for your mod contentto be compatible with Steam Workshop.# Put version specific content into appropriate folders |- style="vertical- align:top;"| '''2'''|[[File:0003_create_latest_folder.jpg|500px]]|After creating of the folder open it and create another folder inside called '''universal'''. (Instead of folder you can zip those folders. also create ZIP archives with game data)|- style="vertical-align:top;"| '''3'''TODO|[[File:Universal_directory_content.jpg|500px]]|The universal directory (or archive) should contain all the standard mod package content so: What manifest.sii file, description file, icon file and the mod content. {{Note|Remember! In Workshop mods manifest.sii, description and icon files are those required! [[Documentation/Engine/Mod_manager|Find more info here]]}}|- style="appropriatevertical-align:top;" folders?| '''4'''# Create |[[File:0004_open_text_editor_and_create_versions_sii.jpg|500px]]|Open your favorite text editor and create file called versions.sii - save it in the same folder where you created '''universal''' folder|- style="vertical-align:top;"| '''5'''|[[Tools/Workshop_Uploader/File:0005_fill_versions_sii_with_magic_and_global_sii_scope.jpg|500px]]|Add sii file frame to your versions.siifile. <pre>SiiNunit{ }</pre>|versions- style="vertical-align:top;"| '''6'''|[[File:0006_add_package_version_info_for_latest_version.jpg|500px]]|Add definition of universal version unit. <pre>SiiNunit{package_version_info : .universal{ }}</pre>|- style="vertical-align:top;"| '''7'''|[[File:0007_add_folder_attribute_to_latest_info.siijpg|500px]] where |Set '''package_name''' to name of the folder or ZIP archive with the mod data. <pre>SiiNunit{package_version_info : .universal{ package_name: "universal"}}</pre>|} When you do those points and put your game content to package you and you don't want to support exact game updates you can skip next points and go to [[Units/package #Uploading|Uploading]] part. ==Supporting specify version of the game=={| class="wikitable" width="100%"|- style="vertical-align:top;"| '''1'''|[[File:0008_create_folder_for_122_content.jpg|500px]]|In case you have data that supports one exact game version infoyou need to create folder or archive where you will store the content.   {{Tip|package For better organization of the directories. We recommend to call this folder ''122_content'' - 122 stands for 1.22 version infowith 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]] units|Open your text editor and do exatly the same steps as you did while adding definition for universal update. (Besides different folder and unit name) <pre>SiiNunit{package_version_info : .universal{ package_name: "universal"} package_version_info : . 122_content{ package_name: "122_content"}}</pre>|- style="vertical-align:top;"| '''3'''TODO|[[File: Describe how 0010_add_new_unit_to_versions_sii_with_122_content_step_2.jpg|500px]]|There is new step you have to take. 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 1.23 update only you will write:<pre>compatible_versions: "1.23.*"</pre> If you want to support only one update by this content (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 allowed. <pre>SiiNunit{package_version_info : .universal{ package_name: "universal"} package_version_info : .122_content{ package_name: "122_content" compatible_versions[]: "1.22.*"}}</pre>|- style="vertical-align:top;"| '''4'''|[[File:0011_create_multiversion_folder.jpg|500px]]|In case you want to support more than one exact version you need to setup folder for it.  {{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'''|[[File:0012_add_another_unit_to_versions_sii.jpg|500px]]|Add again the same definition file with some examplesfor the unit. <pre>SiiNunit{package_version_info : .universal{ package_name: "universal"} package_version_info : .122_content{ package_name: "122_content" compatible_versions[]: "1.22.*"} package_version_info : .120_121_content{ package_name: "120_121_content"}}</pre>|- style="vertical-align:top;"| '''6'''|[[File:0013_add_first_version_attribute.jpg|500px]]|Add compatible_version value for one update you support. <pre>SiiNunit{package_version_info : .universal{ package_name: "universal"} package_version_info : .122_content{ package_name: "122_content" compatible_versions[]: "1.22.*"} package_version_info : .120_121_content{ package_name: "120_121_content" compatible_versions[]: "1.20.*"}}</pre>|- style="vertical-align:top;"| '''7'''# When |[[File:0014_add_second_version_attribute.jpg|500px]]|And add again compatible_version value for second update you want to support. <pre>SiiNunit{package_version_info : .universal{ package_name: "universal"} package_version_info : .122_content{ package_name: "122_content" compatible_versions[]: "1.22.*"} package_version_info : .120_121_content{ package_name: "120_121_content" compatible_versions[]: "1.20.*" compatible_versions[]: "1.21.*"}}</pre>|} =Uploading= {{UsefulLink|If you prepare everything launch don't have SCS Workshop Uploader installed - check this tutorial - [[Tutorials/SCS_Workshop_Uploader/How_to_download_the_tool?|How to download and install SCS Workshop Uploader?]]}} [[File:Scs_workshop_uploader_tutorial_preview.jpg]] *Run '''SCS Workshop Uploader ''' tool from your Steam Clientsteam client.# Select the '''game which will ''' that is compatible with your mod.#Select '''New''' item from the items combobox. It should be selected by default when you launch the target application for your workshop creationtool.# In "the '''Mod data" ''' section## Select folder with your - browse for a '''mod content. You need to select the root data folder of your mod this where you have placed your versions.sii file and version folders or archives'''.## Browse If you select folder, browse for '''mod preview image'''.# In the next sectionstep fill '''mod name'''.#Select '''mod visibility''' in steam workshop. If it's '''Private''', '''Friends only''' or '''Public'''.# fill the Mod name Fill your '''mod description''' which will be shown in your item workshop page. '''(maximum 128 Minimum 50 characters)'''#If you want to know formatting possibilities click on the question mark button.#Now, you have to select '''type tag''' for your mod.# You can select visibility state ('''truck parts''' and '''brand''' tag if the mod is private, friends only or public)appropriate.# In "Description" section You can now fill '''change note''' of your mod description . 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 minimum amount of characters is 50 characters - maximum is 8000points simply click '''Upload''' button. Before the actual upload operation the tool will check if your mod contains correct data. (We count one byte as characters so in case   {{Note|You may notice that when you are using multibyte non [https://en.wikipedia.org/wiki/ASCII ASCII characters it will count as ] the counters are decreasing by more than one (also new lines, spaces . It is because those characters have bigger size than one byte. The counters are counting bytes space used by description and title - not the character count as character))}} ==Validation==# *In "Tags" sectioncase of any validation error you will notice this dialog. [[File:0025_in_case_of_error_you_will_get_this_dialog.jpg|500px]] ## You When you click '''MUSTOK''' select Type you will see log dialog with all errors and warnings that occured during validation. In case if you have only warnings you can both continue or abort operation. In case of error you '''need to''' fix them before uploading. {{UsefulLink|If you need help with solving your modvalidation errors click '''[[Documentation/Tools/SCS_Workshop_Uploader/Validation_errors_and_solutions_for_them|here]]'''}}  [[File:Validation result window.jpg]]  ## Truck parts In this line you have the summary of the validation - the number of errors and Brand are optionalwarnings.# In "Change note" this area you specify changelog have log of new mod version - in this case the validation. All the log entires have the following form: '''''[TYPE] [CODE] (file): Message'''''#Bellow you have two checkboxes, you can leave it empty or simply write there something like "Initial release" hide warnigns or "First version release"errors here.# When In case there are is at least one error you are done you can press Upload able to only click Abort. This buttonsimply aborts the upload. #In case validation failed or 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 you will see this dialog. [[File:0026_upload_success.jpg]] However it is possible that there was some different problem happened failure while uploading - you will be informed by proper then notice dialogwith the error message.If you have some problem with resolving the problem write on '''[http://forum.scssoft.com/viewforum.php?f=24 our forum]'''

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 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. [[Category:Tutorials]][[Category:TODO]]