Changes

Jump to navigation Jump to search

Tutorials/SCS Workshop Uploader/How to upload new mod?

2,658 bytes added, 15:10, 24 November 2016
Validation
=Preparing modIntroduction=To upload mod to Steam Workshop In this tutorial we will show you need how to setup few new files and folders prepare your mod. Steam Workshop mods have ability to be compatible with multiple versions so you need for uploading it to define which data game should usethe workshop step by step.
==Workshop mod files and directories layout==First step of preparing all - the layout of your mod to be sent to will change a little bit. To check the Steam Workshop is creation of folder where you will store your mod datamods structure click [[Documentation/Tools/SCS_Workshop_Uploader/Workshop_mod_structure|here]].
[[File:0002_create_folder.jpg|500px]]==Preparing mod for uploading step by step==
When you create {| 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. You will put there all the files and folders needed for your mod to be compatible with Steam Workshop.|- 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 '''latestuniversal''' . (the name can be different however we recommend calling it latest) - in this place you will put data files of your mod that will be compatible with latest game patches. Instead of folder you can also create ZIP archives with game data)|- style="vertical-align:top;"| '''3'''|[[File:Universal_directory_content.jpg|500px]]|The universal directory (or archive) should contain all the standard mod package content so: manifest.sii file, description file, icon file and the mod content.
{{Note|Remember! In Workshop mods manifest.sii, description and icon files are required! [[Documentation/Engine/Mod_manager|Find more info here]]}}|- style="vertical-align:top;"| '''4'''|[[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'''|[[File:0003_create_latest_folder0005_fill_versions_sii_with_magic_and_global_sii_scope.jpg|500px]]|Add sii file frame to your versions.sii file.
Open text editor and create file called versions.sii - save it in the same folder where you created '''latest''' folder<pre>SiiNunit{
}</pre>|- style="vertical-align:top;"| '''6'''|[[File:0004_open_text_editor_and_create_versions_sii0006_add_package_version_info_for_latest_version.jpg|500px]]|Add definition of universal version unit.
Add magic and global scope to your versions.sii file<pre>SiiNunit{package_version_info : .universal{
}}</pre>|- style="vertical-align:top;"| '''7'''|[[File:0005_fill_versions_sii_with_magic_and_global_sii_scope0007_add_folder_attribute_to_latest_info.jpg|500px]]|Set '''package_name''' to name of the folder or ZIP archive with the mod data.
Add definition of latest version<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 [[File:0006_add_package_version_info_for_latest_version.jpg#Uploading|500pxUploading]]part.
Set value ==Supporting specify version of the attribute called game=={| class="wikitable" width="100%"|- style="vertical-align:top;"| '''folder1''' which is the name of the |[[File:0008_create_folder_for_122_content.jpg|500px]]|In case you have data that supports one exact game version you need to create folder or ZIP archive with where you will store the datacontent.
[[File:0007_add_folder_attribute_to_latest_info.jpg|500px]]
When you do those points and put your game content to folder/archive you and you don't want to support exact patches you can skip next points and go to [[#Uploading|Uploading]] part.
In case you have data that supports one exact update you need {{Tip|For better organization of the directories. We recommend to create call this folder or archive where you ''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 store 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 the contentsame steps as you did while adding definition for universal update.(Besides different folder and unit name)
[[File<pre>SiiNunit{package_version_info :0008_create_folder_for_122_content.jpg|500px]]universal{ package_name: "universal"}
Open your text editor and do exatly package_version_info : .122_content{ package_name: "122_content"}}</pre>|- style="vertical-align:top;"| '''3'''|[[File:0010_add_new_unit_to_versions_sii_with_122_content_step_2.jpg|500px]]|There is new step you have to take. Set the same steps as you did while adding definition value of the compatible_versions attribute. As we want to have data for latest patch1.22 update simply write there "1.22.*". Values are similar to compatible_versions array in manifest.sii. (Besides different folder and unit name)
[[FileIf you want to use this package for 1.23 update only you will write:0009_add_new_unit_to_versions_sii_with_122_content_step_1<pre>compatible_versions: "1.23.jpg|500px]]*"</pre>
There is new thing. You need to set value of the compatible_versions attribute. This attribute is simply array containing strings that are masks of the game versions. As we If you want to have data for 1.22 patch simply support only one update by this content (not recommended) you will write there :<pre>compatible_versions[]: "1.22.*1". Values are similar to compatible_versions array in manifest.sii however for workshop mods we are using versions specified in versions.sii.</pre>
[[File:0010_add_new_unit_to_versions_sii_with_122_content_step_2The 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.jpg|500px]]
In case you want to support more than one exact version you need to setup folder for it<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.
Add again the same definition for the unit.
{{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 for the unit.
Add compatible_version value for one patch you support<pre>SiiNunit{package_version_info : .universal{ package_name: "universal"}
package_version_info : .122_content{ package_name: "122_content" compatible_versions[[File]:0013_add_first_version_attribute"1.22.jpg|500px]]*"}
And add again 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 second patch one update you want to support.
[[File<pre>SiiNunit{package_version_info :0014_add_second_version_attribute.jpg|500px]]universal{ package_name: "universal"}
=Uploading=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'''|[[File:Scs_workshop_uploader_tutorial_preview0014_add_second_version_attribute.jpg|500px]]|And add again compatible_version value for second update you want to support.
Run '''SCS Workshop Uploader''' tool from your steam client<pre>SiiNunit{package_version_info : . **TODOuniversal{ package_name: Describe howto find the tool in steam client and link installation tutorial**"universal"}
package_version_info : .122_content{ package_name: "122_content" compatible_versions[[File]:0015_workshop_uploader"1.22.jpg|500px]]*"}
Select the game that is compatible with your modpackage_version_info : . In the ''Mod data'' section - browse for a mod data folder120_121_content{ package_name: "120_121_content" compatible_versions[]: "1.20.*" compatible_versions[]: "1.21.*"}}</pre>|}
[[File:0016_select_mod_folder.jpg|500px]]=Uploading=
{{UsefulLink|If you select folder, browse for mod preview image.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:0017_select_preview_imageScs_workshop_uploader_tutorial_preview.jpg|500px]]
*Run '''SCS Workshop Uploader''' tool from your steam client.#Select the '''game''' that is compatible with your mod.#Select '''New''' item from the items combobox. It should be selected by default when you launch the tool.#In the '''Mod data''' section - browse for a '''mod data folder'''.#If you select folder, browse for '''mod preview image'''.#In next step fill '''mod name'''.#Select '''mod visibility''' in steam workshop. If it's '''Private''', '''Friends only''' or '''Public'''.#Fill your '''mod description''' which will be shown in your item workshop page. '''(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 '''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 correct data.
[[File:0018_fill_mod_name.jpg|500px]]
Select mod visibility in steam workshop{{Note|You may notice that when you are using non [https://en. If it's '''Private''', '''Friends only''' or '''Public'''wikipedia.org/wiki/ASCII ASCII characters] the counters are decreasing by more than one. 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}}
[[File:0019_select_visibility==Validation==*In case of any validation error you will notice this dialog.jpg|500px]]
Fill your mod description which will be shown in your item workshop page. '''(Minimum 50 characters)''' '''TODO[[File: Describe why writing for example 1 cyrillic character counts as 2, why one space is count as character and why enter is cound as character0025_in_case_of_error_you_will_get_this_dialog.'''jpg|500px]]
[[File:0020_fill_descriptionWhen you click '''OK''' 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.jpg|500px]]
Now, {{UsefulLink|If you need help with solving your validation errors click '''MUST[[Documentation/Tools/SCS_Workshop_Uploader/Validation_errors_and_solutions_for_them|here]]''' select type tag for your mod.}}
[[File:0021_select_mod_type_tag.jpg|500px]]
You '''CAN''' select truck parts and brand tag if appropriate[[File:Validation result window.jpg]]
[[File:0022_truck_parts_and_brand_are_optional.jpg|500px]]
You #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 fill change hide warnigns 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 - because it's first upload step you will more likely write nothing here - or write something like ''"Initial upload."''have to fix the problems.
[[File:0023_fill_change_note.jpg|500px]]==Success==If you did all there are no errors and the points simply click '''Upload''' button. Before the actual upload operation the tool will check if your mod contains correct data. [[File:0024_validation_progress.jpg|500px]] In case of any error you will notice this dialog. [[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 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.  '''TODO: Error log screenshot here'''  In case you click '''Continue''' mod will start uploading. In case mod has been successfuly uploaded on successfull upload you will see this dialog.
[[File:0026_upload_success.jpg]]
However it is possible that there was some failure while uploading - you will then notice dialog with the error message. If you have some problem with resolving the problem write on our forum '''[http://forum.urlscssoft.putcom/viewforum.here click todo moding sectionphp?f=24 our forum] (Create Steam Workshop section dedicated to it?)'''
=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 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. =OLD=# Create folder where you will put your mod content.# Put version specific content into appropriate folders - you can zip those folders. '''TODO: What are those "appropriate" folders?'''# Create file called [[Tools/Workshop_Uploader/versions.sii|versions.sii]] where you put [[Units/package version info|package version info]] units. '''TODO: Describe how to write this definition file with some examples'''# When you prepare everything launch SCS Workshop Uploader tool from your Steam Client.# Select the game which will be the target application for your workshop creation.# In "Mod data" section## 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 version folders or archives.## Browse for preview image. The maximum size of the file is '''1 MB'''.# In the next section## fill the Mod name (maximum 128 characters)## select visibility state (if the mod is private, friends only or public).# 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 multibyte characters it will count as more than one (also new lines, spaces count as character))# In "Tags" section## You '''MUST''' select Type of your mod## Truck parts and Brand are optional# 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".# 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. [[Category:Tutorials]][[Category:TODO]]
1,618
edits

Navigation menu