Viscera Cleanup Detail

Viscera Cleanup Detail

Not enough ratings
Steam Workshop Publishing Guide v2.0
By BlackEagle and 1 collaborators
Official guide on using the RUST Mk2 utility in Viscera Cleanup Detail versions 1.1 onward.

This'll let you use Steam Workshop to publish and distribute your mods for VCD.
   
Award
Favorite
Favorited
Unfavorite
Preface
This guide will primarily cover the process involved in actually uploading and submitting your Mod to VCD's Steam Workshop.
It will NOT cover how to actually make a mod/level or any of the processes involved in that.
To learn more about that side of things, head on over to the Level Creation Guide.

Likewise, this guide will not cover how Steam Workshop itself works, or anything of that nature.
It really only applies to the system used in VCD.


Be aware that this is a guide for the system employed in VCD after v1.1.
If you are looking for information on the system used in previous versions...well, you really shouldn't be, as it's now obsolete and we've hidden the guide.

What this tool does:

  • Creates new Workshop Items
  • Manages your existing Workshop Items
  • Uploads a folder structure
  • Controls your Mod's visiblity
  • Allows you to change your Mod's meta-data
  • Publishes your Mod on Steam Workshop

What this tool does NOT do:

  • Make Mods
  • Defeat tough stains
  • Organize Crates
File Structure
A few important things need to be done before you can even consider uploading your mod, and that is arranging and naming your files correctly.
First and foremost, make sure you have your mod files in the right place for testing and creating your mod.

  • .INI files go under UDKGame\Config\
  • .INT files go under UDKGame\Content\Mods\Localization\INT\
  • And finally, for everyone's sake, put your content packages(and script) under UDKGame\Content\Mods\*UniqueName*\

This will guarantee that users of your mod, as well as yourself can easily find your files and avoid file conflicts.
The next important thing is to name your mod something appropriate.
Once again, for everyone's sake, make sure you choose a name that is distinct and recognizable. Ideally something that matches what is seen on Steam Workshop.

Likewise, do not give your mod files generic names like "Textures.upk" or "MyMod.udk".
These kinds of names are certain to cause conflicts with other mod files, as well as infuriate players.
Try naming things using this formula: *UniqueName*_GameplayTextures_01.upk, or *UniqueName*_LevelSounds_01.upk.
Replace *UniqueName* with the name of your mod.
Be sure to never use spaces or any other whitespace, always use underscores: _


The next thing is to make sure you have a separate folder outside of VCD's install directory where you will place your mod in preparation for uploading.
This is the folder that "RUST Mk2" will want to use, and it really helps to keep things clean and separate.
You do NOT want to be uploading anything straight from the game's install directory!

Inside this separate folder(referred to as a "root" folder) you'll still want to preserve the same folder structure however.
Here is an example of a correctly arranged upload("root") folder named DarkPlace.
Note: Darkplace is for illustration purposes only. You are meant to replace it with a name of your choosing, following the naming advice above.

  • Darkplace\UDKGame\Content\Mods\DarkPlace\VC_DarkPlace.udk
  • Darkplace\UDKGame\Content\Mods\DarkPlace\DarkPlace_GameplayTextures_01.upk
  • Darkplace\UDKGame\Content\Mods\Localization\INT\Darkplace.int
  • Darkplace\UDKGame\Config\Darkplace.ini


Follow this example, and there will be no problems.
Fail to do so, and you'll have a headache from all the other people with headaches screaming at you to fix it.
Getting Started And Uploading
Now that you know how to sanely keep your files in order, it's time to get started with the actual tool.

First things first, make sure the Steam Client is running.
The tool needs it open to be able to access Steam Workshop and check your items.
No Client; no Uploading, no nuffin'.

To open the tool, simply find it on your computer under the game's install folder.
There you will see a RUSTUGC folder, and inside the folder is a RUSTUGC.exe file, launch that.

A window will open with a few important options available, and the "[New Item]" option already selected.
If you already have VCD workshop entries, then they will be visible in the list on the left.

To create a new entry, simply have the "[New Item]" option selected in the list.
Then, on the right panel, begin to fill in your mod's information.

You can leave your mod on private for now if you wish to simply test the tool, or review the submition on Steam Workshop before actually making it public.
This is usually a good idea.

Fill in a Title for your mod, and a Description and any Tags that might help people search your mod.

Finally, click on "Browse" below the "Content" field.
This must point to that nice neat folder outside of VCD that you made earlier.
If you haven't already done that properly, do it now!
Simply navigate into the folder and click on "Open".
The folder in question should be your "root" mod folder. See the "Darkplace" example above.
The folder should not be named "Content", despite the confusing name of the tool's field.




Lastly, you'll need a preview image for your workshop item.
The image must be under 1MB and use one of the following common formats:
JPG, PNG, GIF

Once you have a suitable file, click on "Browse" below the "Preview image" field.
Simply navigate to the file and click on "Open".


Hoorah! Your mod is now ready for upload!
Simply click on the "Create Item" button at the bottom to send it onward!
NOTE: If you haven't already, you may have to agree to Steam's legal agreement allowing your mods to be available to the public.
This can be done by simply clicking on the blue text.


After clicking on "Create Item", you mod will be uploaded and submited to Steam Workshop.
You can see what the tool is doing at the top of the window, and follow its upload progress.
Once complete and successful, the Steam Client window will browse to your workshop item.
Here you can make further changes and see if everything is how you want it.
Performing Updates
Once you have one or more workshop items already submitted, you can use the tool to make updates.
If you relaunch the tool, you should now see your named entry in the list on the left.

Simply click on this item and then change the fields as you see fit.
If your mod was set to "Private", you may want to change it to "Public".
Or maybe you want to change the preview image or Description.

Make your changes and then click the "Submit Update" button.
Maybe you want to include a note about the changes?
Simply enter it into the "Update Note" field.
These will appear in the "Change Notes" tab on Steam Workshop.

If you wish to undo your changes before you've submitted them, simply click "Revert" on the left.
Conclusion
That's pretty much all there is to it. Enjoy!

Let us know if you have any problems, or need advice by heading over to the Workshop Discussion forums.
Troubleshooting
If you run into trouble, here is a short list of some issues you might encounter.

  • Fails to upload an unreleased mod.
    This could be due to Steam Cloud Sync being active.
    Make sure you disable it for VCD, then delete all the files in the following folders(under the game's install directory):
    \Viscera\UDKGame\Autosaves\
    \Viscera\UDKGame\Autosaves\Backup\

  • Game becomes bricked and stops working for all subscribers
    Could be you changed the filenames for your level or one of its content packages and then re-uploaded.
    Don't ever change filenames!
    Be sure to delete the now wrongly named files, and instruct your subscribers on how to do the same on their end.

  • Can't select a root folder in Rust mk2's content upload box.
    If this happens, then select a terminating folder(one with no other folders below it).
    Then, in the actual "Content" field, remove parts of the text field until it points to your mod's root folder as it should.
25 Comments
A JANITOR 13 Nov, 2021 @ 6:08am 
hello the gaming realms or anyone else who made a map n cant figure out how to upload it:steamfacepalm:

here is template of the desktop upload directories to make it easy for anyone to upload the map they made in the right folders lol
https://www.dropbox.com/sh/c92rf3eraa5a6e1/AAAa9UOs0FxmWlM678ZSRHJ2a?dl=0

delete the txt files before upload=instructions in txt files
follow this guide here its pretty easy
happy workshopping
make it public=the community will help ya fix it if it goes awry:albedothumbsup:
A JANITOR 13 Nov, 2021 @ 4:47am 
My tv is occupied= annoying PC hogs
Anyway when I regain PC privileges
I can give you a template folder for uploading your level that shows what files go where it be just the directory tree with txt files that says what goes where n after copying the files to the right folders simply delete the blank txt files and use this guide to upload your level
Make it public so the community can tell you if it works or if something is wrong..
Probably the best way to solve the issue n if it still not visible to everyone then I suggest contacting steam support or trying steam beta n try it with that...
A JANITOR 13 Nov, 2021 @ 2:58am 
heyo
gaming realms profile says it has 8 workshop items but only 5 are visible
they said the vcd map is set to friends only=i see nothing
what could cause this?
steam workshop agreement not accepted perhaps
they said some of their friends subbed to it but i see nothing to sub to=odd:cryptothink:
only thing i can think of is make it visible to the public n if nobody can find it do the stuff in this guide again and re upload the map
A JANITOR 11 Nov, 2021 @ 4:55am 
There's a bug in the rust MK2 tool
How to fix that problem=

In the content to upload Box
To select the content to upload
Click browse open the folder you gonna upload
Copy the address at the top of the window
Press cancel
Paste the address in the content to upload Box
Upload map or submit map update

Stupid Bugrosoft Bugrows 10 bug fails to select the folder to upload n ya end up uploading the int file cuz it keeps opening sub folders until it chooses the Last file=missing files vs workshop
A JANITOR 11 Nov, 2021 @ 4:02am 
Verify game cache 8-10 files missing do it 6784367646 times=still broken
Nuke it n keep the saves folder so ya don't lose ya office stash
Verify the game cache 1000+ files missing=fixed
I reinstall VCD monthly incase I break something the editor will tell me if something is broken...
Therefore I can tell if someone else's map broke the game n not my maps cuz I spent 8 years debugging VCD

Just remember verify game cache in every steam game is useless steam skips old and corrupt files
You have to Nuke it 1st to fix it n steam cloud breaks games after game updates cuz it reinstalls corrupt autosaves every single time you start said game
Postal 4 a good example
Disable the cloud fy that delete the game and the appdata files for that then verify the game cache
Then when RWS release an update it won't crash on ya n half the map won't self destruct n delete itself n ya won't be skydiving into the void lol
A JANITOR 11 Nov, 2021 @ 3:54am 
For debugging it's a good idea to backup the files you made unsubscribe from everything you subbed to
Open the viscera folder keep the saves folder and delete everything else in the viscera folder
Now verify the game cache to reinstall the game
Get freinds to do that too
Don't resub to soda factory it screws the game up

Also if you have medical rust n freinds don't have that map every single map will fail to join in multiplayer cuz medical rust plays 2csgo songs on every Radio in every level
All sub to medical rust or all unsubscribe from it to stop multiplayer from failing to connect...

Do not sub to Soda Factory reinstalling vcd isn't fun
Soda factory is corrupt

BlackEagle has a good point about subbing to something that altered the base game files
All vanilla files stay vanilla
A JANITOR 11 Nov, 2021 @ 3:43am 
Make sure you upload the desktop copy not from the game copy
Every time you edit the game copy n save that you copy the game copy to the desktop upload copy n ya upload the desktop copy.
Send me an invite cuz you're map isn't visible to the public...
If it set to freinds only then only friends can sub to it
A JANITOR 11 Nov, 2021 @ 3:25am 
Don't sub to your own map or you be editing the Same old version that is on workshop over n over again.
If you unsubscribe from your own map the game deletes it. Copy the desktop files back into the game copy after unsub
Only test subbing to your own map to make sure it installed the right files in the right locations.

Read all the comments here it helps a lot:albedothumbsup:

Still not sure send me an invite make your map visible to freinds n I will tell ya what's missing or broken..
Hope ya UDK file name doesn't have a space in its name..
Also make sure ini and int files are not missing...


1000 character limit here sorry for 3 posts

Hopefully that helps you sort out the problem
A JANITOR 11 Nov, 2021 @ 3:25am 
If it doesn't say lighting need rebuilt on your end and it says it on your subs end=
Did you upload the updated version???

You edit the game copy after you save that you copy the updated files to the desktop upload copy then you update your map

Right click vcd in library disable steam cloud sync permanently
Delete all autosave files including backup autosave files in the games autosaves folder.
This will stop uploads from failing to upload...
A JANITOR 11 Nov, 2021 @ 3:24am 
Gaming realms
Best way to find out what is happening esp if you uploaded all the right files is to unsubscribe from everything you subbed to on the workshop
Restart the game a few times
Start the level editor and load your map

If the editor chucks missing package/files errors it will tell you what assets are missing
Chances are that you used content from someone elses map/s
In that case if you don't remove the conflicting content on your workshop page for your level there is an add remove required items section
Go in that and add the map or maps that you're map is using assets from
It's similar to city's skylines in that department
If it uses Hoh or vulcan DLC go on the add remove required DLC and tick the appropriate boxes

Those options will tell your subscribers which content to sub to so when they play it it won't have missing files.