Plugin Settings
This section describes all settings available for PloxTools: Steam Integration in Unreal Engine.
Plugin settings can be found under:
Edit → Project Settings → Plugins → PloxTools: Steam Integration
The settings are stored in the project's configuration and are grouped by their purpose.
Steam App
Steam App ID
| Property | Value |
|---|---|
| Type | int32 |
| Default | 480 |
| Config Property | SteamAppId |
Defines the Steam App ID used by the plugin.
This App ID is used by both:
- Runtime Steam integration
- Steam Publishing Tool
The default value 480 is Steam's Spacewar test App ID. When working with your own Steamworks application, replace it with the App ID assigned to your game.
Note
The Steam App ID is read when the Steam module starts.
Restart Unreal Engine after changing this setting before testing Steam integration.
For initial App ID setup, see Getting Started.
Multiplayer
Automatically Update Multiplayer Rich Presence
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
| Config Property | bAutomaticallyUpdateMultiplayerRichPresence |
Controls whether the managed Multiplayer system automatically publishes multiplayer information through Steam Rich Presence.
When enabled, the plugin automatically updates:
- Current map
- Player count
- Steam player group
The Multiplayer connect string remains managed automatically regardless of this setting.
Disable this option if you want to manage these Rich Presence values yourself.
Multiplayer Version
| Property | Value |
|---|---|
| Type | FString |
| Default | 1 |
| Config Property | MultiplayerVersion |
Defines the network compatibility version used by the managed Multiplayer system.
The plugin automatically uses this value for:
- Host Steam Game
- Start Steam Game From Current Lobby
- Find Steam Games
- Join Steam Game
- Automatic joining of existing Steam Lobby members when the host starts a match
All compatible game builds must use the same Multiplayer Version. The plugin uses this value when creating, searching for, and joining Steam multiplayer sessions.
Change this setting when an update introduces network or gameplay changes that are incompatible with older game builds.
The Multiplayer Version is independent of the Unreal Engine version and the project's Project Version.
Note
Multiplayer Version is configured globally in the plugin settings and no longer needs to be specified in individual Blueprint nodes.
If you are upgrading from an older plugin version, existing Blueprint nodes may need to be refreshed. Any previously customized Multiplayer Version must be transferred to this setting.
Development
The following setting is available only in the Unreal Editor.
Enable Steam In Editor
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
| Config Property | bEnableSteamInEditor |
Controls whether Steamworks is initialized while the project is running from the Unreal Editor.
When enabled, Steam functionality can be tested directly in:
- Play In Editor (PIE)
- Standalone Game
The Steam client must be running and logged in.
When disabled, Steam is not initialized for game instances launched from the Unreal Editor. Packaged builds are not affected.
Note
This setting is read when the Steam module starts.
Restart Unreal Engine after changing it before testing Steam integration.
For detailed testing information, see Testing Steam Functionality.
Steam Publishing
The following settings are used by the Steam Publishing Tool and are available only in the Unreal Editor.
For the complete publishing workflow, see Steam Publishing Tool.
Account
Steam Username
| Property | Value |
|---|---|
| Type | FString |
| Default | Empty |
| Config Property | PublishingSteamUsername |
Steam account name used when authenticating through SteamCMD.
The account password is never stored in the plugin settings.
Steam App
Depot ID
| Property | Value |
|---|---|
| Type | int32 |
| Default | 0 |
| Config Property | PublishingDepotID |
Steam Depot ID where the build will be uploaded.
The depot must already exist and be configured for the application in Steamworks.
Build Description
| Property | Value |
|---|---|
| Type | FString |
| Default | Empty |
| Config Property | PublishingBuildDescription |
Short description assigned to the uploaded build in Steamworks.
Use this to identify the build in the Steamworks build history.
Target Branch
| Property | Value |
|---|---|
| Type | FString |
| Default | Empty |
| Config Property | PublishingTargetBranch |
Optional Steam branch to promote the uploaded build to after a successful upload.
Leave this field empty to skip automatic branch promotion.
Do not enter the default branch. Steam does not allow builds to be promoted to the default branch through this workflow.
Build
Build Mode
| Property | Value |
|---|---|
| Type | EPloxToolsSteamPublishingBuildMode |
| Default | PackageProjectAndUpload |
| Config Property | PublishingBuildMode |
Controls where the Publishing Tool gets the build that will be uploaded.
Available modes:
- Package Project and Upload — package the Unreal Engine project first, then upload the resulting build
- Upload Existing Build Folder — skip Unreal packaging and upload an already packaged build folder
Build Configuration
| Property | Value |
|---|---|
| Type | EPloxToolsSteamPublishingBuildConfiguration |
| Default | Shipping |
| Config Property | PublishingBuildConfiguration |
Defines the Unreal Engine build configuration used when Build Mode is set to Package Project and Upload.
Available configurations:
- Shipping
- Development
- DebugGame
- Debug
Package Directory
| Property | Value |
|---|---|
| Type | FDirectoryPath |
| Default | Empty |
| Config Property | PublishingPackageDirectory |
Directory where Unreal Engine writes the packaged project before it is uploaded.
This setting is used when Build Mode is set to Package Project and Upload.
Existing Build Folder
| Property | Value |
|---|---|
| Type | FDirectoryPath |
| Default | Empty |
| Config Property | PublishingExistingBuildFolder |
Path to an existing packaged game build.
This setting is used when Build Mode is set to Upload Existing Build Folder.
The Publishing Tool uploads the contents of this folder without running the Unreal Engine packaging process first.
Behavior
Preview Upload Only
| Property | Value |
|---|---|
| Type | bool |
| Default | false |
| Config Property | bPublishingPreviewUploadOnly |
Runs SteamPipe in preview mode.
When enabled, the Publishing Tool prepares and validates the SteamPipe upload without actually uploading the build.
This is useful for validating build configuration before a real upload.
Keep Generated SteamPipe Files
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
| Config Property | bPublishingKeepGeneratedSteamPipeFiles |
Controls whether generated SteamPipe configuration files are kept after the publishing process.
When enabled, generated VDF files remain available for inspection and debugging.
Save Upload Log
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
| Config Property | bPublishingSaveUploadLog |
Controls whether the Publishing Tool saves the SteamCMD upload log.
When enabled, the log is stored together with the generated publishing files and can be used for troubleshooting failed or unexpected uploads.
Summary
| Setting | Default | Scope |
|---|---|---|
| Steam App ID | 480 |
Runtime and Publishing |
| Automatically Update Multiplayer Rich Presence | true |
Runtime |
| Multiplayer Version | 1 |
Runtime |
| Enable Steam In Editor | true |
Editor / Development |
| Steam Username | Empty | Publishing |
| Depot ID | 0 |
Publishing |
| Build Description | Empty | Publishing |
| Target Branch | Empty | Publishing |
| Build Mode | Package Project and Upload | Publishing |
| Build Configuration | Shipping | Publishing |
| Package Directory | Empty | Publishing |
| Existing Build Folder | Empty | Publishing |
| Preview Upload Only | false |
Publishing |
| Keep Generated SteamPipe Files | true |
Publishing |
| Save Upload Log | true |
Publishing |