LOTUS-Simulator

LOTUS-Simulator

Not enough ratings
Uploading Workshop Content for LOTUS with SteamCMD
By [OS] Janine
There are different ways of uploading workshop content for LOTUS. The most comfortable way is to use the ContentTool itself. But if that fails for unknown reason, you can use the SteamCMD to upload the content. I'm going to show you, how you use it.
   
Award
Favorite
Favorited
Unfavorite
Preparations - getting SteamCMD and preparing the files
But why...?
Some people encounter problems with the Workshop upload in our ContentTool. The SteamCMD upload is not perfect, but it normally executes what it is supposed to do. Please note that I currently could not figure out, how to change your tags (categories) after the upload. This seems to only work inside the ContentTool. So use this guide to fix your upload problems, if neccessary. :)

Get SteamCMD
First, you need SteamCMD. Steam offers it for download here: https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip

Extract it were you want to store it, in our example we extract it to E:\SteamCMD\steamcmd.exe

Run it by double-clicking the executable and let it download and install its updates.

Prepare a folder
Now you need to prepare a folder for your upload. LOTUS exports your content in most cases in its MyContent folder. Locate it, since you need it later. In our example it is E:\SteamLibrary2\steamapps\common\LOTUS-Simulator\MyContent\

Now create your upload folder. It should be placed outside your LOTUS directory, as always and should contain the name of your addon for the sake of your personal overview. You need a content folder inside it, so you would create something like:
E:\LOTUS_Workshop\upload\MyFirstAddon\content\

Prepare the containers
I prefer the windows console to organize my content. I usually create batch files that contain the commands that I need over and over again.

If you want to skip this step, please just create a folder that should contain a content folder and the files (containers) you intend to upload to the workshop in it. In our example it is E:\LOTUS_Workshop\upload\MyFirstAddon\content\ - please copy the files you want to upload!

If you want to automate this process, please create an empty text file and rename it CopyWS_MyFirstAddon.bat (NOT CopyWS_MyFirstAddon.bat.txt !) and pay attention that this is now a batch file that executes on double click, instead of opening. If you want to edit its content, right click and set "edit" or open it with a good text editor.

We want to copy two pieces of content, since we want the two containers to be uploaded. The command we use is:
XCOPY <sourcefile> <destination folder> /m /y
I usually put the source and destination in quotes to make sure the path can be got even if I used a space in its name.

The names of our containers located in the MyContent folder are
  • Diörama_MäpStuff.lct
  • ЛОТУС.lct

So we now create two+1 lines in our batch file that are:
  • XCOPY "E:\SteamLibrary2\steamapps\common\LOTUS-Simulator\MyContent\Diörama_MäpStuff.lct" "E:\LOTUS_Workshop\upload\MyFirstAddon\content\" /m /y
  • XCOPY "E:\SteamLibrary2\steamapps\common\LOTUS-Simulator\MyContent\ЛОТУС.lct" "E:\LOTUS_Workshop\upload\MyFirstAddon\content\" /m /y
  • pause

The parameter /m ensures that - by use of the archive bit - only files are copied that have been changed, for example after newly exporting it. Hence if a file is not copied, it may be that you forget to export it before. The parameter /y suppresses the prompt to overwrite an existing file.

Save the file and execute it! If you did not use my example paths ;) the WindowsCMD should now copy two files into your newly created workshop upload folder.

Execute the file again - and it should not copy a single file, since nothing changed. Place your batch file or a link to it where you can reach it fastly after exporting new content, but possibly not into you LOTUS folder, MyContent folder oder the newly created content folder.

If you need more containers, add new lines, if you need less containers, remove lines. If you create further workshop content, create new directories like "MyFirstAddon" and edit the XCOPY command properly. Do not forget to create the extra content folder within it.

Prepare the Preview image
Steam requires - and I recommend - a preview image for your content. It should not exceed 1 MB in size and should be JPG or PNG.
Place it in the "MyFirstAddon" directory, but NOT in the "Content" directory where your containers are placed.

Starting situation for next step
SteamCMD downloaded and extracted in its own folder, successfully downloaded and installed its updates, hungry for your input.
Created a directory for Workshop uploads and - however - placed one or some containers in the content folder within it that you wish to upload.
Created a preview image and placed it NOT inside the content folder, but in the addon upload folder above.
Creating an upload script
All commands that we are placing in the script can be executed in the SteamCMD line, as well (of course). So if you just want to test, extract the commands from the guide and paste them directly into the command line tool.

Otherwise, follow my wise lines. :)

Creating the upload script file
Create a new, empty text file again and name it something like MyFirstAddon.vdf .
This is going to be your upload script that can be used every time you want to initially publish or to update your addon. If you want to change parameters of your workshop content (which is most likely the change of visibility (hidden/published) or the release note) you have to update the script in first place.

Place the file in your folder "MyFirstAddon", NOT in your "Content" folder. If you see your preview image, you are right. ;)

Edit the file content with your text editor:
"workshopitem" { "appid" "370350" "publishedfileid" "0" "contentfolder" "E:\LOTUS_Workshop\upload\MyFirstAddon\content\" "previewfile" "E:\LOTUS_Workshop\upload\MyFirstAddon\preview.jpg" "visibility" "2" "title" "My First Addon" "description" "Add a description to your project" "changenote" "First release" }

Please only change the lines "Contentfolder", "Previewfile", "Title" and "Description" according to your personal settings/demand. "AppID", "PublishedFileID" must NOT be changed. "Visibility" and "Changenote" may be changed later, if you want. Visibility 0 is "public", 1 is "friends only", 2 is "hidden", which I recommend until you are done.

Save the file.

Create an executing script file
I personally am not willing to write down the commands every time I update my content. Subsequently I create another script that executes the following commands in the tool:
  • login MyName
  • workshop_build_item "E:\LOTUS_Workshop\upload\MyFirstAddon\MyFirstAddon.vdf"

For testing purposes, start your SteamCMD.exe (or bring it to the front again). Enter login MyName - and answer the password prompt and SteamGuard, if neccessary. If you successfully logged in, type the second command and replace the path and file name with your own ones.

Normally the Command line tool should now do two things: First, it should start scanning and uploading the workshop content folder. Second, if that worked, it should have replaced the "PublishedFileID" in your own script file with a larger number. You MUST allow this!

If everything worked fine, you could place the two commands into another batch file. To do so, create an empty text file again and name it "StartScript_MyFirstAddon.bat" . Edit the file and add in a single line: E:\SteamCMD\steamcmd.exe +login MyName +workshop_build_item "E:\LOTUS_Workshop\upload\MyFirstAddon\MyFirstAddon.vdf"

If you execute this batch file, enter your password if asked for and the SteamCMD does anything else.

For upcoming updates do not forget to change the vdf file according to your progress. :)
Fixing problems
Problems with the login
...have to be fixed like you would do it with your normal Steam Client, as well. You need to know you password, as always, type it correctly (even if the cursor does not move in the command line!), enter your SteamGuard code if prompted.

Failed to load build config file
Most likely Steam can not find your script file, since you made a typo in the path or forgot the quotation marks, although there are spaces in the path. Also check, if the vdf file name is correct.

If you still fail...
...leave a note in our Support forum[www.lotus-simulator.de] and we are happy to help!

Editing tags, uploading screenshots
Open the LOTUS workshop page and enter the website that contains your uploaded items:

Open your recently uploaded file and edit every setting you want to change. :)

If you want to add tags (categories), switch to the ContentTool, if possible, or leave us a note in our forum and we change them for you.