Settings
This page describes the settings available in Publishing Configuration.
The settings are grouped into four sections:
- Account
- Steam App
- Build
- Behavior
For the initial setup workflow, see Setup. For the upload workflow, see Publishing a Build.
Account
Steam Username
| Property | Value |
|---|---|
| Required | Yes |
| Used by | SteamCMD authorization and publishing |
| Stored password | No |
The Steam username used by SteamCMD when authorizing and uploading builds.
The plugin does not store the Steam password. If SteamCMD requires a password or Steam Guard code, the tool asks for it during the authorization attempt.
Use a Steam developer account that has access to the Steamworks application and permission to upload builds for the configured depot.
Steam App
Steam App ID
| Property | Value |
|---|---|
| Required | Yes |
| Used by | SteamPipe upload |
| Example | 1234560 |
The Steamworks application ID that will receive the uploaded build.
You can find the App ID in Steamworks. Open the application and go to:
SteamPipe → Depots
The App ID is shown with the application name at the top of the page.
Depot ID
| Property | Value |
|---|---|
| Required | Yes |
| Used by | SteamPipe upload |
| Example | 1234561 |
The Steam depot where the build files will be uploaded.
The Steam account used for publishing must have permission to upload builds for this depot.
Build Description
| Property | Value |
|---|---|
| Required | No |
| Used by | Steamworks build metadata |
An optional description for the uploaded Steam build.
Use this to identify the build later in Steamworks, for example:
Windows test build
or:
UE 5.8 compatibility update
Target Branch
| Property | Value |
|---|---|
| Required | No |
| Used by | Optional branch promotion |
An optional Steam branch to set live after the upload finishes.
Leave this field empty if you only want to upload the build without automatically promoting it to a branch.
Warning
Do not use default as the Target Branch. Valve does not allow setting the default branch live through this SteamCMD option.
Build
Build Mode
| Property | Value |
|---|---|
| Required | Yes |
| Used by | Publishing workflow selection |
Controls how the build is prepared before upload.
| Mode | Description |
|---|---|
| Package Project and Upload | Packages the current Unreal project first, then uploads the packaged build. |
| Upload Existing Build Folder | Uploads an already packaged build folder without running Unreal packaging. |
Build Configuration
| Property | Value |
|---|---|
| Required | Yes for Package Project and Upload |
| Used by | Unreal packaging |
The Unreal build configuration used when the tool packages the project.
Common values are:
- Shipping
- Development
- DebugGame
- Debug
For public or near-release Steam builds, Shipping is usually the expected configuration.
Package Directory
| Property | Value |
|---|---|
| Required | Yes for Package Project and Upload |
| Used by | Unreal packaging output |
The directory where Unreal Engine writes the packaged build before the upload starts.
This setting is used only when Build Mode is set to Package Project and Upload.
The tool packages the project into this location, resolves the packaged build folder, generates the SteamPipe files, and uploads the result through SteamCMD.
Existing Build Folder
| Property | Value |
|---|---|
| Required | Yes for Upload Existing Build Folder |
| Used by | Direct upload workflow |
An already packaged build folder to upload without running Unreal packaging.
This setting is used only when Build Mode is set to Upload Existing Build Folder.
Warning
Do not select the Unreal project source folder. Select the packaged build folder that contains the final game executable or macOS app bundle.
Behavior
Preview Upload Only
| Property | Value |
|---|---|
| Required | No |
| Default | Disabled |
Runs SteamPipe in preview mode.
When enabled, SteamCMD checks the upload process without performing the actual upload. Use this to validate the generated SteamPipe setup before uploading a real build.
Keep Generated SteamPipe Files
| Property | Value |
|---|---|
| Required | No |
| Default | Disabled |
Keeps the generated SteamPipe VDF files after the operation finishes.
This is useful when you want to inspect the generated app and depot configuration files or debug a SteamPipe issue.
Save Upload Log
| Property | Value |
|---|---|
| Required | No |
| Default | Enabled |
Saves the SteamCMD upload output to a log file.
This is useful for reviewing the upload result later or sharing details when troubleshooting a failed publish operation.
Required Settings Summary
The required settings depend on the selected Build Mode.
| Setting | Package Project and Upload | Upload Existing Build Folder |
|---|---|---|
| Steam Username | Required | Required |
| Steam App ID | Required | Required |
| Depot ID | Required | Required |
| Build Mode | Required | Required |
| Build Configuration | Required | Not used |
| Package Directory | Required | Not used |
| Existing Build Folder | Not used | Required |
| Build Description | Optional | Optional |
| Target Branch | Optional | Optional |
| Preview Upload Only | Optional | Optional |
| Keep Generated SteamPipe Files | Optional | Optional |
| Save Upload Log | Optional | Optional |