Garry's Mod
Garry's Mod

Workshop Addon Creation Instructions

Create and upload your own Garry's Mod addons to Steam Workshop. Learn file organization, packaging, and the Uploader tool for sharing creations.

Workshop Addon Creation Instructions

Creating and uploading your own addons to the Garry's Mod Steam Workshop allows you to share your creations with the world. The process involves organizing your addon files correctly, packaging them, and then using Steam's Workshop Uploader tool. Understanding the required file structure and the steps involved is crucial for a successful upload, ensuring your addon is compatible and easily accessible by others.

Creating and uploading your own Garry's Mod addon to the Steam Workshop involves several key steps:

1. Organize Your Addon Files

Your addon needs to be structured correctly within a dedicated folder. This folder should be placed inside your Garry's Mod `addons` directory (usually found at `Steam/steamapps/common/GarrysMod/garrysmod/addons/`).

The basic structure looks like this:

MyAwesomeAddon/
├── lua/
│ ├── autorun/
│ │ └── server/
│ │ └── my_server_script.lua
│ ├── client/
│ │ └── my_client_script.lua
│ └── shared/
│ └── my_shared_script.lua
├── materials/
│ └── my_addon_textures/
│ └── my_texture.vmt
│ └── my_texture.vtf
├── models/
│ └── my_custom_model.mdl
├── sound/
└── readme.txt (Optional but recommended)
  • `lua/`: Contains all your Lua scripts. Subfolders like `autorun/`, `server/`, `client/`, and `shared/` dictate where and when scripts are executed.
  • `materials/`: Holds texture files (.vmt and .vtf).
  • `models/`: Contains custom 3D models (.mdl).
  • `sound/`: For custom sound files.
  • `readme.txt`: A text file for descriptions, instructions, or credits.

2. Create Your Addon Content

Develop your Lua scripts, create or import models and textures, and des any other assets your addon will use.

3. Use the Workshop Manager (or Uploader Tool)

Garry's Mod includes a built-in tool for managing and uploading addons.

  1. Launch Garry's Mod.
  2. Go to the 'Addons' menu.
  3. Click 'Manage Addons'.
  4. Find your addon folder in the list. If it's not listed, ensure it's correctly placed in the `garrysmod/addons/` directory.
  5. Select your addon and click 'Upload to Workshop'.

This will open the Steam Workshop Uploader interface.

4. Configure Your Workshop Item

In the Steam Workshop Uploader:

  • Addon Name: Give your addon a clear and descriptive title.
  • Description: Write a detailed description explaining what your addon does, its features, any dependencies, and how to use it.
  • Thumbnail: Upload a compelling image that represents your addon. This is what users will see in the Workshop.
  • Visibility: Choose whether your addon is Public, Friends Only, or Private.
  • Tags: Select relevant tags (e.g., Playermodel, Weapon, Map, Roleplay) to help users find your addon.
  • Root Directory: Ensure the correct addon folder is selected.

5. Upload and Publish

Once everything is configured, click the 'Publish' or 'Update' button. Steam will upload your files. After the upload is complete, your addon will be available on the Garry's Mod Steam Workshop.

Important Considerations:

  • Dependencies: If your addon requires other specific addons to function, clearly state this in the description and link to them if possible.
  • Testing: Thoroughly test your addon on both single-player and multiplayer servers before uploading.
  • Updates: To update your addon, make changes to your local files, then repeat the upload process. Steam will recognize it as an update.