> For the complete documentation index, see [llms.txt](https://puck.gitbook.io/modding/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://puck.gitbook.io/modding/publishing/steamcmd.md). # SteamCMD [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD) is a command-line version of the Steam client. Amongst many things, it's most often used to push content to or pull content directly from Steam. This includes publishing games, uploading game files, downloading dedicated server executables and in our case, uploading content to the Steam Workshop. 1. Installation of SteamCMD highly depends on the host platform you use. Official documentation is extensive and offers steps to get SteamCMD installed for either [Windows](https://developer.valvesoftware.com/wiki/SteamCMD#_Windows), [Linux](https://developer.valvesoftware.com/wiki/SteamCMD#_Linux) or [macOS](https://developer.valvesoftware.com/wiki/SteamCMD#_macOS). 2. Once you have the SteamCMD downloaded, extract the `steamcmd.exe` to a new empty folder.
3. Run the executable and let the application go through its update process.
4. Now that we have our SteamCMD installed and ready, create a new folder.\ \ Within this folder, we will need a sub-folder (content) containing our mod content, a mod preview image and an `upload.vdf` file that will tell Steam what we are uploading and which application we are targeting.
5. The contents of `upload.vdf` should be as follows:
``` "workshopitem" { "appid" "2994020" "publishedfileid" "" "contentfolder" "C:\Users\user\Desktop\MyPuckMod\content" "previewfile" "C:\Users\user\Desktop\MyPuckMod\preview.png" "visibility" "0" "title" "My Puck Mod" "description" "This is a sample mod for [b]Puck[/b]!" "changenote" "v1.0" } ``` \ `appid` should be left with the value of `2994020`, since this is the unique identifier for Puck on Steam. All other fields should be filled in based on your own needs. `publishedfileid` should be left empty, since we are creating a new Steam Workshop item.

Use absolute paths for both contentfolder and previewfile

6. Launch `steamcmd.exe` again. We will be entering a `login` command first to log into your Steam account.
``` login YOUR_STEAM_USERNAME ``` \ Replace `YOUR_STEAM_USERNAME` with the same username you use for logging into Steam Client and execute the command. Steam might ask for your password and if you have Steam Guard set up, it will additionally ask for confirmation from that too. Just follow the instructions in the terminal.
7. Once we are logged in, we can point SteamCMD to our `upload.vdf` file.
``` workshop_build_item ABSOLUTE_PATH_TO_UPLOAD_VDF ``` \ Replace `ABSOLUTE_PATH_TO_UPLOAD_VDF` with an absolute path to `upload.vdf` we created earlier. Execute the command and wait for SteamCMD to upload your mod to the Workshop.
8. Your mod is now available on the Steam Workshop! :clap:
{% hint style="info" %} SteamCMD will automatically edit the `upload.vdf` file's `publishedfileid` entry with your Steam Workshop item ID. In order to update your mod, you need to execute steps 6 to 7.\ \ For official documentation, see [Steam Workshop Implementation Guide](https://partner.steamgames.com/doc/features/workshop/implementation#SteamCmd)! {% endhint %}