[EN] Uploading workshop items via SteamCMD

This guide explains how to upload your mods bypassing default baro's publishing tool by using Steam Command Line.

What to begin with

First thing you should do is getting SteamCMD installed. It can be downloaded from here. Download the archive, unzip it and install according to specific instructions for your system.

Other thing you should have is a content folder with all mod files labelled. To label mod files, you need to create a file list document for your content package named filelist.xml, which can look like this:

<?xml version="1.0" encoding="utf-8"?>
<contentpackage name="ExampleMod" path="Mods\ExampleMod\filelist.xml" corepackage="false" gameversion="0.9.1.1">
  <Submarine file="Mods\ExampleMod\Humpback2.sub" />
  <Character file="Mods\ExampleMod\Redcrawler\Redcrawler.xml" />
</contentpackage>

After preparing the file list and installing SteamCMD, you can proceed with next step - Making a descriptor for workshop item.

Making a Descriptor File

Descriptor file is something like identificational document for item publishing tool. It should specify folder location, item's preview picture, name+description and change note.

Example of descriptor file:

"workshopitem"
{
	"appid"		"602960"
	"publishedfileid"	"1848221064"
	"contentfolder"		"C:\\Program Files (x86)\\Steam\\steamapps\\common\\Barotrauma\\Mods\\ExampleMod"
	"previewfile"		"C:\\Homework\\MyModPicture.png"
	"visibility"		"0"
	"title"		"ExampleMod"
	"description"		"My first mod for baro."
	"changenote"		"Initial Release."
}

NOTE: Item's name should match mod's folder name written in filelist.xml

Descriptor file should be saved in .txt format in any folder. After saving, we can proceed with pushing your masterpiece to Workshop.

Pushing item to Workshop

First, you need to launch SteamCMD and log into your account.

> login [account_name]

Program should ask a password and 2FA code (if you have SteamGuard active). After logging in, you can finally upload your content package.

> workshop_build_item [path_to_descriptor]

Following lines should appear:

Creating new Workshop item...
Preparing content..................................
Uploading content...
Uploading preview image...
Committing update...Success.

If something goes wrong, command line would describe the reason of error. Otherwise, item will be available on Workshop for anyone's disposal.

Additional info

• Number in "visibility" attribute means following: 0 - open to all, 1 - friends only, 2 - hidden
  
• "publishfield" attribute can be used to update existing items. It'll be automatcally filled upon creating new item.

[Drew P Bahlz]

@Noble Hopefully this helps. This is the steam documentation that discusses the descriptor file and using steamcmd for uploading to the Workshop
https://partner.steamgames.com/doc/features/workshop/implementation?l=finnish&language=english#SteamCmd

[Noble]

This is like, the only guide on uploading mods with steamcmd.
Are there other options in descriptor options?

[Articulate Llama]

Thanks for this, but how do we include a proper description file formatted already for steam with headers and the like? Is that something we do from our steam client after we have uploaded it?