How to Upload to Steam Worksohp Gmod

Creating a Workshop Addon

This article will teach you how to prepare and upload an addon to the Steam Workshop.

Earlier you begin - Rules

There are a few rules before you outset uploading addons.

Please see this folio for complete set of rules: Steam Workshop Rules

The easy manner

You can apply alternative tools such every bit GUIs (graphical user interfaces) made by community members to create, excerpt and upload addons to Steam Workshop.

Links to such known tools: (feel gratuitous to expand)

• gmpublisher (GUI for Windows, macOS and Linux)
• Garry's Modern Addon Tool (Windows)
• Garry'south Mod Publishing Utility - Coffee based GUI wrapper
• gmosh - Command line interface wrapper
• Garry's Mod Easy Addon Uploader (for Windows only)
• LuaWorkshopper - Quick tool for Addon making and publishing
• Garry'due south Modern Workshop Utility (Piece of cake create, upload..etc)
• Crowbar (Unpack, Publish, and Pack) -- Publish to Workshop via Crowbar (Guide)

Alternatively, the guide beneath describes how to upload addons to the Steam Workshop using Garry's Mod's shipped tools, gmad.exe and gmpublish.exe.

Preparing your addon

To upload an addon to workshop you volition demand the following things:

• A folder anywhere on your computer containing addon files
• A 512x512 .jpg icon for your addon.

If you're going to make your addon public, please make sure it's unique and will add something new to Garry's Mod. Don't upload addons you didn't make, even fixed versions, without the writer's consent.

Folder with addon files

The structure of addon for Steam Workshop is the same as the archetype addon system of Garry's Mod 12, except for those differences:

• info.txt or addon.txt are not needed
• Y'all tin only upload files that would normally be mounted by the game, except for:
  • .dll, .exe, .htm, .html, .css and .js files are restricted
  • .txt files are restricted too, except for vehicle scripts
  • Full file path whitelist can be found here:
    • https://github.com/garrynewman/gmad/blob/principal/include/AddonWhiteList.h

You addon folder structure must expect somewhat like this: (below is only an case)

my_addon/ my_addon/lua/autorun/myScript.lua my_addon/materials/myMaterial.png my_addon/maps/gm_examplemap.bsp my_addon/maps/thumb/gm_examplemap.png my_addon/gamemodes/mygamemode/mygamemode.txt my_addon/gamemodes/mygamemode/gamemode/stuff.lua my_addon/gamemodes/mygamemode/content/materials/mycontent.vtf my_addon/gamemodes/mygamemode/entities/weapons/weapon_mygun.lua my_addon/gamemodes/mygamemode/...

Hither'southward all the binder names that your addon may contain, next to the addon.json file:

maps backgrounds gamemodes materials lua scenes models scripts particles audio - This is not a typo, there is no "s" for audio binder. resource

my_addon is the folder you volition need to input to gmad.exe or any other Workshop uploader and it's name could be anything, addon's name is divers on the Workshop Page for that addon and NOT by the folder name.

Example

Sample Addon is the folder you will need to provide to the gmad.exe to catechumen it to .gma.

Before uploading - test your addon

Information technology is generally a expert idea to do a terminal test of your addon earlier uploading it to workshop to make certain everything works properly.

Doing then is easy, only put your addon folder (in this example information technology would exist chosen my_addon) into the game'south steamapps/GarrysMod/garrysmod/addons/ folder and load up the game.

The icon

This must be a 512x512 Baseline JPEG epitome ( Progressive JPEG or a PNG image will Not piece of work! ). If gmpublish.exe does non accept your icon, endeavor reexporting it with Pigment or Paint.Net, that should convert information technology to Baseline. The chroma must be 4:two:0, for instance Photoshop and GIMP can utilize 4:2:ii or 4:4:iv, which are not accepted.

Exercise non apply an image unrelated to your addon - this is stupid and volition get your addon removed. Express your addon in image form.

Make it relevant to your addon. Delight don't but stitch together something horrible in MS Paint. It should expect good, otherwise y'all'll be making the workshop wait dingy. Besides, who wants to download something that looks similar a 3-year-old fabricated information technology?

addon.json

When creating an addon the folder should have an addon.json - which looks like this..

{ "championship" : "My Server Content", "type" : "ServerContent", "tags" : [ "roleplay", "realism" ], "ignore" : [ "*.psd", "*.vcproj", "*.svn*" ] }

championship is the name of your addon.

type is the blazon of addon, ane of:

"ServerContent" "gamemode" "map" "weapon" "vehicle" "npc" "tool" "effects" "model" "entity"

tags is up to two of these:

"fun" "roleplay" "scenic" "movie" "realism" "cartoon" "water" "comic" "build"

Ignore is a simple wildcard list of files to ignore. You can have as many of these every bit y'all want - and they don't take to exist wildcarded, they can exist specific files.

Creating a .gma for upload

For Windows, yous tin simply navigate to your GMad.exe in <STEAM LOCATION>/steamapps/common/garrysmod/bin and elevate'n'drop your addon folder ( my_addon in this example'' ) onto GMad.exe.

GMad.exe will now create your .gma. It will place it to the same location where your binder is, with the same name.

Practise not motility GMad.exe anywhere!

Alternatively You can open the command prompt (cmd.exe), cd to the gmod bin folder

(<tt>cd "<STEAM Binder>/steamapps/common/garrysmod/bin"</tt>, include quotes), then enter the following control (including quotes):

gmad.exe create -binder "<Full PATH TO ADDON FOLDER>" -out "<Total PATH TO OUTPUT .gma FILE>"

Windows users tin can besides create a .bat file to automate this process:

"C:\Programme Files (x86)\Steam\steamapps\mutual\garrysmod\bin\gmad.exe" create -folder %1 pause

Simply make sure to insert correct path to your GMad.exe.

Common Errors

[Files does not laissez passer whitelist]

You have either dragged a wrong folder onto GMad.exe, your addon contains forbidden files or your addon has wrong binder structure. See example above for right addon folder structure and file whitelist.

Couldn't parse json

Your JSON file is missing or it is invalid. Use any JSON validators to find and fix errors.

Uploading your addon

There are multiple ways of doing that, we are going to embrace only the most convenient mode of doing this, if you are on Windows.

At this point you should have a .gma file and a .jpg file. For the sake of making this piece of cake, rename both files to have the same name, for example my_addon:

• my_addon.jpg
• my_addon.gma

Adjacent you want to create a .bat file somewhere and put these commands in the .bat file:

"C:\Program Files (x86)\Steam\steamapps\mutual\GarrysMod\bin\gmpublish.exe" create -addon "%~dpn1.gma" -icon "%~dpn1.jpg" intermission

Save it as something like gmpublish_create.bat.

Once you got the .bat file gear up, simply drag'n'drop your .gma or your .jpg onto that .bat file. It is essential that both files must have the aforementioned name.

Now gmpublish.exe will go through the procedure of compressing and uploading the addon to Steam Workshop.

Once that process is completed, open your Garry's Modernistic Steam Workshop, go to "My Shared Files" ( Yous can also get in that location from your contour ) and change visibility of your addon to Public.

You are done. Your addon is at present live. You can at present change the title, description, images and videos for your addon.

Note that rules also apply to your title, description, images, icon and videos:

• No questionable content
• No racism or offensive language/textile

Common Errors

Compression Failed

This is elementary - your addon is besides big. This is usually solved by downscaling your .vtf textures. Annotation that some video cards may not fifty-fifty support 4096x4096 textures! 1024x1024 or 512x512 are usually more than enough.

Brand sure that if yous are uploading a particularly texture-heavy addon that yous use DXT5 texture compression. DXT5 is exponentially smaller than RGBA or BGRA, saving not just time downloading and uploading but deject infinite.

Ran out of quota

If this happened to you, contact robotboy655@facepunchstudios.com for help.

Addon has invalid type!

Your addon.json has the "type" tag fix to an invalid value. You can see a list of allowed values above.

PublishWorkshopFile failed! (8)

This error happens when the addon.json contains invalid UTF-8 sequences. This happens if you utilise an upload script (.cmd, .bat, etc) that cannot create the addon.json with the UTF-8 character prepare. Please fix your addon.json by editing information technology every bit UTF-eight or apply a championship using only U.s.-ASCII characters (latin characters with no accents).

This error only happens afterwards the upload because the addon.json is packed inside of the sent GMA file.

PublishWorkshopFile failed! (9)

An icon must be provided.

PublishWorkshopFile failed! (X)

If you encountered an error with a number that is not listed on this page, you lot can find a list of all Steam related error codes on this handy website: https://steamerrors.com/

Delight note - that website is not associated with Steam, Valve or Facepunch in any fashion, and may be incomplete.

libsteam_api.so: cannot open shared object file: No such file or directory

This is an error that may happen on Linux when gmpublish fails to find its Steam API dependency. You tin resolve this by copying the libsteam_api.so dependency from the game's bin/ binder to /usr/lib/, or by setting the LD_LIBRARY_PATH environment variable appropriately. Come across #4542 for more info.

Afterward Going Live

Please make certain your addon isn't creating errors for people. If your addon is creating as well many errors it will be removed.

Y'all tin learn how to update existing workshop addons in this article: Workshop Addon Updating

villelapaboul.blogspot.com

Source: https://wiki.facepunch.com/gmod/Workshop_Addon_Creation#:~:text=For%20Windows%2C%20you%20can%20simply,is%2C%20with%20the%20same%20name.

Share this post