Upload Mods to Steam Workshop

In this guide, you will learn how to upload your mod to the Steam Workshop.

• Preparing the upload
• WorkshopItem.lua
  • Tags
  • Visibility
• In-game Uploading
• Updating your Mod

Before you start:

• please have a look at the Pre-Upload-Checklist as well as at the Modding Conversion Guideline!
• in case there are any log errors, we highly recommend fix the errors before uploading!
• if you are facing difficulties while fixing the errors, feel free to reach out to our modding community on the official WRS discord server in the #modding chat!

First, create a new folder named workspace within the directory Documents/MyGames/WinterResortSimulator_Season2.

Now, create a new folder in the directory Documents/MyGames/WinterResortSimulator_Season2/workspace named with yourmodname.

Please create one folder for each Steam Workshop item!

• after that, launch Winter Resort Simulator once
• upon launching, the game will create a file named WorkshopItem.lua in your new directory
• as soon as you've arrived in the main menu, you can close the game again

Switch back to Windows Explorer. As you can see, the game has created a file named WorkshopItem.lua inside your directory.

Next, open the WorkshopItem.lua using a suitable application (e.g. Visual Studio Code or Notepad++).

• change the name to the desired name of your Steam Workshop item (always edit the text between the double quotes ( “ ). This name will be visible for all players in the Steam Workshop.
• also, please add a description to description (again in between of the double quotes).
  
• later on, if you are updating an existing mod, you can add a description of your changes to changenotes (one more time, between the double quotes).

This could look as depicted below:

It is recommended to add some tags to your mod so that players can easily find it. If you don't specify any tags, the mod will be listed as Untagged.
You can choose one tag from each category (but you don't have to).

Category: Type

• Vehicle
• Ropeway
• Map
• Object
• Script
• Mod-Pack
• Other Mods
• Untagged

Category: Vehicles

• Snowcat
• Snowmobile
• Snow Cannon
• Other Vehicles

Category: Ropeways

• Chairlift
• Gondola
• Aerial Tramway
• Surface Lift
• Other Ropeways

• isVisible = 0, → hidden, the mod is only visible for you
• isVisible = 1, → public, your mod is visible for everyone
• isVisible = 2, → the mod is visible for your friends only

The visibility can be changed afterwards in Steam!

Here is an example for the workshopItem.lua:

Every mod has to have a preview image named WorkshopPreview.png inside its directory.

• the image must be named WorkshopPreview.png, and it has to be a .png file.
  
• we recommend using a resolution of 640×360, the aspect ratio should always be 16:9.
  
• in case you are using a higher resolution, it can happen that the Steam upload fails with the error message Limit exceeded.
  • in this case, please scale the preview image down to 640×360.

Up to now, we have only specified how your mod will look like inside the Steam Workshop.
However, we have not yet added any mod files to the directory.
Therefore, please copy the .unity3d file of your mod into your directory. (BTW: You can also add multiple files to one Steam Workshop item.)

Next, please launch the game again and go to Mod Upload.

You should already be able to see your preview picture.
Before uploading, you need to accept the Steam Workshop legal agreement.
Please check your mod name, description, tags and visibility one more time before uploading!

Finally, press Upload to Workshop!

Your mod will now be uploaded to the Steam Workshop!
In case you face any error messages while uploading, please ask on our Community Discord server.

Congratulations, you have successfully shared your mod with the community! It can now be downloaded by all players.

BTW: You can format your mod description in Steam: Text Formatting in Steam

• replace your .unity3d file
• if you changed your mod description afterwards in Steam, copy the mod description from Steam, paste it into your workshop.lua
• at changenotes you can enter all changes, these are visible for everyone in Steam
• now follow the chapter In-game Uploading