rFactor 2

rFactor 2

26 ratings
Publishing to the Steam Workshop
By marrs
The workshop is basically a marketplace to share content, making it a nice fit for rFactor 2. For users it’s a great way to add new content easily, as all they need to do is subscribe to that content and it will get downloaded, installed and updated automatically. For content creators (mod teams) it’s a great way to share their content as Steam will provide them with all the bandwidth they need and creating and updating workshop items is relatively straightforward. This guide is for mod teams that create content and want to publish it.
 
Rate  
Favorite
Favorited
Unfavorite
Prerequisites
Before you can publish anything, you need to create the car or track and package it like you normally would for rFactor 2. This is a complicated process that will not be discussed here. At this point in time we assume you already have one or more packages that you want to publish in the workshop.

Furthermore, you have to have a Steam account that satisfies the following conditions:
  • Your account has to be at least "level 1".
  • You need to have accepted the Steam Subscriber Agreement.
  • You need to have bought a copy of rFactor 2 on Steam (you don't need an on-line subscription, just the base simulation).
Setting up SteamCMD
You need to download a small tool called SteamCMD. If you’ve ever downloaded dedicated server packages on Steam, you might be familiar with it. Instructions on how to download and install it can be found here: https://developer.valvesoftware.com/wiki/SteamCMD
Publishing and Updating
Create a new folder somewhere on disk where you’re going to keep all your workshop related content. I propose a structure somewhat like this:

C:\dev\workshop\mycooltrack\ metadata.vdf preview.jpg C:\dev\workshop\mycooltrack\content\ MyCoolTrack-v1.rfcmp

The preview.jpg is actually a small preview image that will be shown in the workshop. You can later add more images or videos manually. The MyCoolTrack-v1.rfcmp is just a normal component which you create like you always do with the rFactor 2 modding tools. The only thing you need to then do is create a textfile called metadata.vdf which contains the following text:

"workshopitem" { "appid" "365960" "publishedfileid" "0" "contentfolder" "C:\dev\workshop\mycooltrack\content" "previewfile" "C:\dev\workshop\mycooltrack\preview.jpg" "visibility" "0" "title" "My Cool Track" "description" "My Cool Track is a road circuit designed by famed Mister Modding. It is a 3-mile road circuit with elevation changes and 12 corners. Situated in the lovely countryside, this track is a favorite of both drivers and fans, with good weather throughout the year." "changenote" "Version 1 is the first public release of this track." }

That’s all you need in terms of setup. Going over each line in the file:
  • appid is the unique identifier for rFactor 2, so there is no need to change this;
  • publishedfileid should be zero for all new items and after running SteamCMD once, that tool will fill out a unique identifier for your workshop item, which use can use to update this item later;
  • contentfolder must contain an absolute path to a folder with all the content for this item and the convention we use for rFactor 2 is that you can put one or more components in that folder that get installed automatically by the package manager;
  • previewfile points to an image that will be shown in the workshop;
  • visibility can be left at zero, which means your item is visible to the public ("1" makes it visible to friends only and "2" makes it private, so only you and other co-creators can see it);
  • title is the title of the item in the workshop;
  • description is a multi-line description of your item and can contain some “bbcode” for formatting;
  • changenote is a message that is specific to the version you are uploading and normally includes a version number and a change log.

If everything is setup, open a command shell and run SteamCMD like this (you should probably make a small batch file for it that you can quickly re-run):

SteamCMD.exe +login USERNAME PASSWORD +workshop_build_item c:\dev\workshop\mycooltrack\metadata.vdf +quit

One word of warning here. If you use the same USERNAME and PASSWORD to log into the Steam Client on the same computer, there seem to be some unwanted interactions between those two accounts. Therefore, in that case, please quit your Steam Client while SteamCMD is running!

Watch the output for any errors. If everything worked you should be able to view your item in the workshop and others can subscribe to it. More details can be configured using the Steam Client of website of Steam.

That's it. You can further enhance your workshop item in the web interface where you can add further screenshots, movies and many other things that you cannot do with the command line tool.

Updating your item is also simple. Just make changes to the content folder and the metadata file and re-run the command to update your item.
< >
36 Comments
nosalisCZ Sep 14 @ 11:31am 
oh silly me, of course the metadata.vdf.txt issue
nosalisCZ Sep 14 @ 11:09am 
thanks for the tutorial how to do this,
I'm getting error about the build file, not sure if that's becasue of the file itself, or if the installer can't find it ?

ERROR! Failed to load build config file "d:\work\modding\workshop\nissanPrimera\metadata.vdf".

batch file to launch it should live where I isntalled steamCMD ?? or should it be in my dev folder?
Rodrrico Jul 29 @ 4:05am 
Can someone please make a video tutorial. I can't figure this out???
JJ May 5 @ 2:19pm 
how do i shut off workshop i have unscribed to items and it just keeps reloading them I just want to shut it off
14_roy_wynn May 4 @ 12:23pm 
Hello Marrs
I keep getting a ERROR ! Missing build config file. Its a simple rfmod file only 9kb and jpeg file is 16kb.
=fab= Apr 28 @ 8:27am 
hi all
i have an errors "Failed to load build config file ..metadata.vdf"
and the file is a VDF file ..
someone got a idea ?? marss Help ??
FlashQld Feb 11 @ 10:08pm 
Hi Marrs - is there a way to update a mod but not have it go live. Maybe only to friends for testing. I'm about to update a mod with complete new listing. I don't want to delete it yet until we have tested its online operation?
Street7890 Feb 10 @ 6:45pm 
I followed this tutorial exactly but my rfcmp package is downloading to "C:\Program Files (x86)\Steam\SteamApps\workshop\content\365960\860705939\content" and isn't automatically installing. Any idea why?
simtek Dec 17, 2016 @ 12:55pm 
Thanks for your reply Marrs, i figured it out after looking on google for same error. i needed to reduce preview .jpg size.....
marrs  [author] Dec 17, 2016 @ 12:39pm 
Two tips: 1) reduce the size (dimensions) and size (on disk) of your preview image (you can always edit it later) and 2) try deleting long descriptions in your metadata.vdf as sometimes one "bad" character can cause issues (again you can edit it later).