How to create content for the Workshop

tl;dr You can skip the introduction if you want to get to the meaty stuff.

Welcome to this guide on how to utilize the Steam Workshop for Coffee Stain Studios' Goat Simulator. First of: thanks for buying the game and thanks for taking an interest in producing content for the Steam Workshop.

Secondly a bit of a disclaimer. The Workshop implementation in Goat Simulator is not perfect. It's was done during the very limited development time that Goat Simulator had as a whole. We hope it will suffice for now and if enough crazy user created content surfaces on the Workshop we will try to improve support over time.

Goat Simulator is made in the Unreal Engine 3. Some of you might be familiar with making mods for it in the past, some of you won't. No worries, it's quite easy and there are huge amounts of information on the internet to help out.

We here at Coffee Stain Studios do not have extensive experience in making mods, just games. So we don't know what is possible to make, but we're sure you will be able to create some mind blowing goat bending content.

First, go to your Steam Library and filter it by Tools. If you haven't already, download the Goat Simulator Development Kit and start it up. This will start up the Unreal Frontend, from here you can open the Unreal Editor.

This guide won't go into detail about how to use the Editor here because the subject is too vast to cover here. Google "udk tutorial" or something like that.

When you are satisfied with your map, make sure to select GGGameInfo or a subclass of it in world properties. World properties can be found under "view". And then under game type you should be able to select the appropriate Game Info. Important!
Don't use spaces in your mapname!
After saving your map, use the Unreal Frontend. Here you need to name your mod something appropriate. Be sure to select your map to cook as well. If it doesn't locate your map it may be because you have named the map wrong. It needs to have .goat as an ending. If the map is named correctly but does still not show up make sure it is placed in the correct folder. The correct folder is ..\GoatSimulator\GoatGame\Content\Maps\. After this is done just click the green start button.

If everything finishes successfully you can press the "Package Mod" button. This will put your stuff at the right place, in ..\GoatSimulator\GoatGame\Mods\MyMods\%modname%\.

Almost finished! Check out the other tutorial on how to add it to the game.

A mutator is basically a textfile with some code in it. We have provided GGMutator as a base class for your mutators with some Goat Simulator specific hooks.

A hook is what we call a function that get's called when something specific happens in the game so that you can modify what should happen. Or "mutate" the behaviour.

First you need to set up a directory in your development\src folder located int the root of the game. This is usually something like "C:\Program Files (x86)\Steam\SteamApps\common\GoatSimulator\". This should be named something like "mymutators" but you can name it whatever.

Inside of that you create yet another folder. This must be named classes. So now you should have a working directory with this layout: "..\Development\Src\MyMutators\classes"

This is where you are going to create your own mutators!

So go ahead and create one now. You can do this by creating a regular text document. Name the file the same as the mutator is going to be called. And set the ending to .uc. So in this example we create a file called MyMutator.uc.

Now you can edit this file in whichever editor you prefer. You can even use notepad. Open up the file and add this to the beginning:
"class MyMutator extends GGMutator;"

Now you just need to start coding!

To see which hooks are available you can check out:
"Development\Src\Engine\classes\Mutator.uc" and "Development\Src\GoatGame\classes\GGMutator.uc".

To do something with these hooks, you will need to override the function in your class. If you do, be sure to always call the super function as well! So if you want to do something when a quest is completed you should override:

If you don't do this it might break other mutators, and that wouldn't be very polite of you!

I won't go into more detail about how you actually code, that is up to you to go and find out!

When you are satisfied with your mutator you need to compile the script. Start the Goat Simulator Development Kit from Steam.

Add your mutator folder from the "scripts to compile"-drop down list. Now you can hit the big green button at the top left corner.

If that completes withour errors, you can hit "Package Mod". This will take all your compiled script files located in "..\GoatSimulator\GoatGame\Mods\" and put them in a new folder inside MyMods named after your Mod.

You will probably see some yellow text warning you about files you don't have yet, as well as some red text telling you about GoatMod.ini. Go check out "Adding a map or mutator to the game" guide to fix that issue!

In order for your Map or Mutator to be selectable in game, from the Play menu of the Main Menu you will need to create a "GoatMod.ini". Place that file in the root of your mod.
This should be something like "GoatSimulator\GoatGame\Mods\MyMods\%modname%"

If you want to add a map, the file should look like this:
Where FileName is the name you have given the file for your Map. Display Name is what is going to be displayed in the games Play menu. The Description will be displayed when your item is moused over in the Play Menu. Adding mutator is pretty much like adding a map, but a different variable:
MyStuff is the name of the package and FastGoat is the name of the actual mutator. You can add many Maps or Mutators in the same mod, or a combination of both.

First off, start Goat Simulator, and enter the Workshop menu of the Main Menu. There you can open the My Mods sub menu, select a mod and upload it to the workshop. To successfully do this, you will need a couple of files. These are to be placed in the root of your mod, i.e. "GoatSimulator\GoatGame\Mods\MyMods\%myModName%".

The Preview File, the image that is displayed for your item when browsing the Workshop, has to be named "previewfile.jpg", and of course be a JPG. The image should be 512x512 pixels in size. The Workshop Tags describing the content, that are used to filter the Workshop when browsing, will be taken from a file named "tags.txt". Write one tag per line. Save the file with ANSI Encodig, it's default in the Windows Notepad. Once the content has finished uploading and has been published to the Workshop you can change all the other metadata. Click on the "View on Workshop" button. On the lower right you will find the "Owner Controls". Here you can "Edit title & description" and "Add/edit images & videos". You will also have to "Change Visibility" in order for the item to show up on the Workshop for other users. You can not change the Preview File or the Tags through the Steam Client. That you will have to do in game, read the "Updating content on the Workshop" section of this guide.

If you've previously uploaded content to the Workshop which you wish to update. Select the piece of local content, that you wish to upload, in the My Mods menu in the Workshop menu in the game. Press Update. Then select the piece of content on the Workshop which you wish to update. Use the check boxes "Content", "Preview File" or "Tags" to toggle what you want to update and press Confirm. The game will then take the selected items from the selected folder and upload it to the selected Workshop item.

In order to download content all you have to do is subscribe to a peice of content on the Workshop, either while the game is running, or start the game for the download to start. You can view the download progress in the "Downloaded" menu under the "Workshop" menu in the game.

If something goes wrong with the download or if it gets stuck, try restarting the game and it should start/resume the download.

Our excellent comunity member Geneosis have made a more in depth guide, have a look at that one if this wasn't enough! http://steamcommunity.com/sharedfiles/filedetails/?id=1168365238