How to upload your add-on to 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)
- go to Fistful of Frags/sdk/bin
- locate vpk.exe
- drag and drop mymod folder into vpk.exe
- 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
- 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:
- Get the full path to the content to be uploaded (either a VPK or a folder containing a map and/or a VPK)
- Get the full path to a preview image (must be jpg or png and less than 1MB)
- Write a title and description for your mod/addon, it can be edited later
- 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.
- 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"
- 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"
- 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:
- content should fit the game's theme and age, this is 19th century remember.
- did you created the provided content or do you have permission to use it? we don't want to infringe someone's copyright
- no actual gameplay advantage should be obtained from your mod, for instance glowing skins
- no memes
- 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:- it's just a reskin
- 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)
- gives a noticeable gameplay advantage (in that case it may even get banned)
- doesn't work as intended or major flaws are present
Links
This guide was created by its original author on the Steam Community. Are you the author and want it removed? Request removal.