[Official] How to up- and download mods using Steam Workshop

Overview

This official guide explains how to download mods from steam Workshop and how to upload your own mod to the Workshop if you are a modder.

Introduction

This official guide explains you how to download mods for Songs of Syx via the Steam Workshop and also how to upload mods to the Workshop if you are a modder.

Downloading & activating mods

You can browse the Songs of Syx Workshop for mods here.

When you found a mod you like just hit the subscribe button. Steam should then immediately download the mod for you!

Downloading a mod from outside Steam
To download a mod found outside Steam (for example on our Discord or Moddb site).
Just download the files and unpack them into your mod folder which is under AppDataRoamingsongsofsyxmods on Windows.
To get to that folder you just have to open explorer (Win+E) and type in %appdata% into the searchfield.

The modfolder should contain all your installed mods. Simply copy the content of you mod download into that folder.

As soon as the mod is downloaded it should appear in your Songs of Syx gamelauncher.
When you start the launcher just hit the PLAY button to get to the mod selection screen.
After doing so you should see a list of all your installed mods. If your newly added mod is not visible, please try resterting the launcher or Steam.
To start the game with a mod just click on the mod name in the mod selection screen.
Unfortunately it is currently not possible to launch more than 1 mod at the same time(will get changed!!).

Deleting mods

To permanently delete a mod from your computer you need to unsubscribe the mod in the Workshop. Unfortunately in the current implementation this will not delete the mod from your mod folder!! This will change soon™. As a little workaround you have to navigate to your Songs of Syx mod folder which is under AppDataRoamingsongsofsyxmods on Windows.
To get to that folder you just have to open explorer (Win+E) and type in %appdata% into the searchfield.

The modfolder should contain all your installed mods. To delete a mod just delete the respektive folder (please make sure that you unsbscribed it first to prevent Steam from downloading it again).

Uploading a mod

For uploading mods to the workshop we made a little tool which is seperated from the normal game. You can download the tool from your steam library under tools.

Due to a bug in SteamAPI the tool download is not available at the moment. You can get the uploader as a standalone from the official discord!

Creating a Workshop item
After launching the tool for the first time you first of all have to create a new item. That can be done by typing in a name for your item in the respective field and hitting the Create Item button.

Inserting your mod files
After creating the item the tool should automatically create a new folder for your mod. You can find it inside the WorkshopContent folder in the install directory of the tool. The mod content folder should be filled with the actual content of your mod(red). In the folder above (WorkshopContent) you should also put an image which acts as the thumbnail for your mod(blue). The image shuld be less than 1mb in size and ideally in 16:9.

After succesfully creating the item the upload tool should automatically open its detailview. Alternatively you can select your mod in the list on the left side.All you have to do now is populating the detail input mask on the right with data. It is possible to define the thumbnail picture (should be the name of the file you did put into the WorkshopContent folder), the name of your mod as it will appear in the Workshop, the description of the mod, the tags to categorize your mod, the visibility of the mod in the Workshop and the changenotes for your update.

After that is done you just have to hit the submit button to skyrocket your mod to the Workshop!
If that works without giving an error message you should be able to find you mod on the Workshop oage and also your Steam profile.

To update your mod simply do anychanges (in metadata or content), give your update a new changelog by filling the changelog field and hit submit again!