How to upload your add-on to Workshop

This guide explains the steps necessary to upload your creations to Fistful of Frags workshop

1. Preparatives: file structure and VPK packing

You are supposed to use the custom folder to create your add-ons and mods, it can be found in Fistful of Frags/fof. This special folder allows you to replace any game file just by replicating the game folder and file structure inside it. Most game assets are packed into VPK files though (fof_dir.vpk), to explore them use a tool called GCFScape.

Once you have a working mod, for instance:

Example for materials, models, sounds, scripts, particles:
Fistful of Frags/fof/custom/mymod/materials/console/background01.vtf
(this replaces the existing main menu's background image)

Fistful of Frags/fof/custom/mymod/particles/blood_impact.pcf
(this replaces the default blood impact particles)

1. go to Fistful of Frags/sdk/bin
2. locate vpk.exe
3. drag and drop mymod folder into vpk.exe
4. a file called mymod.vpk has been created, that's what you'll be uploading to Workshop

Example for maps (maps shouldn't be packed into VPK because engine can't read them right)
Create a folder structure like this:
Fistful of Frags/fof/custom/mymap/maps/fof_map.bsp
Fistful of Frags/fof/custom/mymap/maps/fof_map.nav

1. just copy the full url location where mod folder is, something like "c:\Steam\SteamApps\common\Fistful of Frags/fof/custom/mymap"

Note that if your map also includes other assets than bsp and nav file, those must be packed either into the bsp itself or into a VPK as explained above, then VPK must be copied to ".../custom/mymap/"

2. Creating a new Workshop item

Follow these steps:

1. Get the full path to the content to be uploaded (either a VPK or a folder containing a map and/or a VPK)
2. Get the full path to a preview image (must be jpg or png and less than 1MB)
3. Write a title and description for your mod/addon, it can be edited later
4. put it all together like this:

ugc_create "path-to-content" "path-to-preview-image" "Title" "Description"

Example:

ugc_create "c:\mods\mymod.vpk" "c:\mods\mymod_preview.jpg" "Best ever mod" "Not much more to say"

(map related item)
ugc_create "c:\Steam\SteamApps\common\Fistful of Frags/fof/custom/mymap" "c:\mods\mymod_preview.jpg" "A FoF map" "Not much more to say"

Copy your line and start Fistful of Frags (console is required!). Once in main menu, paste the line into console, execute. If everything goes well, your item will show in workshop site (a pop-up will appear). Edit anything else from there.

Please note that items are "friends only" visible by default.

Important: make sure you accept the Steam's Workshop "Legal Agreement" or your item won't be visible to others.

3. Updating an already existing Workshop item

You got a new version of your mod or addon? updating is similar except a different console command is used.

1. Get your published file ID from Workshop: go to your item's webpage, look at the url, copy the numbers at the end. Something like "/sharedfiles/filedetails/?id=762489165"

2. Put together a command line like this and copy it (also save it somewhere, just in case):

For non-maps based mods:
ugc_update 762489165 "c:\mods\mymod.vpk" "c:\mods\mymod_preview.jpg"

For map based workshop items:
ugc_update 762489165 "c:\mods\mymap" "c:\mods\mymap_preview.jpg"

3. Start the game, paste the line in console and execute it. All done.

Note: some users report that updating existing mods doesn't work for them, no solution has been found until now.

Addendum: guidelines to get your work accepted.

Here are a few recommendations to get your addons/mods accepted:

1. content should fit the game's theme and age, this is 19th century remember.
2. did you created the provided content or do you have permission to use it? we don't want to infringe someone's copyright
3. no actual gameplay advantage should be obtained from your mod, for instance glowing skins
4. no memes
5. lacks proper description or misleading

Regarding categories (tags)

We'll be tagging any entry appropriately for easy discovery, reply here if you think your item should be tagged. Some items may not get tagged if:

1. it's just a reskin
   
2. art style doesn't fit at all, is out of place or simply doesn't belong to the Wild West (exceptions: item may be worth due other considerations)
   
3. gives a noticeable gameplay advantage (in that case it may even get banned)
   
4. doesn't work as intended or major flaws are present

Links

This guide is also available in other languages:

• Russian: https://steamcommunity.com/sharedfiles/filedetails/?id=2522475640

[omar]

Thanks to crazy_y0 for finding a solution to the issue I had earlier today:

https://www.reddit.com/r/RocketLeagueMods/comments/5hzin2/guide_how_to_update_your_steam_workshop_maps/

You can follow this guide for updating Rocket League maps, but replace the appid with 265630, which is the appid for Fistful of Frags

Rebel_Y - would be great if you could update the guide with this :)

[omar]

I have the same problem as Finn (UGC could not be uploaded, error 'file was not found'), trying to update my workshop map Canyum

I tried:
- using the exact same filename and file structure as the original (fof_canyum_r1.bsp, etc.)
- using new filenames (fof_canyum_r2.bsp, etc.)
- putting the folder on different drives (C:\, E:\)
- ensuring folder is not write protected
- ensuring there are no spaces in file name and directory

[Shlorf]

Hi, could you tag my item as sound fx? I currently only have one Workshop item ever.

[Lil Alvaro]

Thx

[H1ceHavvk即将突破终结]

@Rebel_Y ok, I hope this can make sence :D
https://www.amazon.com/clouddrive/share/8MpxROVXRKpmLjRH3ugrFBi6DrWuCgegYVSgSWNlDAT
Thankyou for your reply, have a good day. You can reply again if this link is not useful :P

[!^]

@睚眦鸟_YeziBD feel free to post a link and I'll add it to the game files

[H1ceHavvk即将突破终结]

hello, I made a new fof_schinese.cfg, it's a little bit better than that old one, but i changed something by myself. Please tell me how can I Make these into a mod? I'm not quite an official folk translator, but I want to share my works.

[Finn]

I seem to be having issues with updating an existing map. I can upload it just fine but when updating it using ugc_update I get the error UGC could not be uploaded, error 'file was not found'. I have tried using the exact same file paths that I used for ugc_create plus the file ID from workshop but no bueno. Any idea what I could be missing?

[ArthurAzedão]

Jogo irado de mais da conta! MEU PAU NA SUA MÃO HEHEHE

[Trinity]

Plaes!!!