Steam

Initialization

setup

Used to set up SteamCMD.

Parameters

steamcmdFolder (optional): The folder in which the SteamCMD executable is located. If the SteamCMD executable can not be found in this folder, it is downloaded instead.

Example

steam.setup();

steam.setup('C:/Program Files/SteamCMD');

Creating Manifests

createAppManifest

Used to create an app manifest needed to push an application to Steam.

Parameters

appID: The App ID that was assigned to your application.

depotID: The Depot ID that was assigned to your depot.

contentRoot: The root folder in which your application's content is located.

buildDescription (optional): A description for the new build, visible on your application's build page.

setLiveOnBranch (optional): The branch to automatically put this build on. If left empty, the build isn't set live on any branch. Can't be default.

buildOutputFolder (optional): The folder in which build logs, chunk cache and intermediate output are stored. Steam recommends placing this on a separate disk for increased performance, but this isn't mandatory.

isPreview (optional): True if the this build is a preview build. It is recommended that you set this to true while initially setting up shipping to ensure that the depot manifest contains the correct files.

localContentServerPath (optional): The path to the local content server, if it is enabled. Using a LCS improves depot iteration time since they are not uploaded and distributed through the public Steam network.

Return Value

This function returns a String representing the path to the created app manifest.

Example

steam.createAppManifest('1000', '1001', "${env.WORKSPACE}/Build/WindowsNoEditor");

steam.createAppManifest('1000', '1001', "${env.WORKSPACE}/Build/WindowsNoEditor", "Jenkins build ${env.BUILD_NUMBER}", 'beta');

steam.createAppManifest('1000', '1001', "${env.WORKSPACE}/Build/WindowsNoEditor", "Jenkins build ${env.BUILD_NUMBER}", 'beta', false, "${env.STEAMWORKS_SDK}\tools\ContentServer\htdocs");

createDepotManifest

Used to create a depot manifest needed to push an application to Steam.

Parameters

depotID: The Depot ID that was assigned to your depot.

contentRoot: The root folder in which your depot's content is located.

excludes (optional): Files to exclude from the depot.

localPath (optional): The path relative to your contentRoot where the depot's file is located. Defaults to *, meaning all files in contentRoot are included.

depotPath (optional): The path, relative to the game's install folder, where your depot's content is placed. Defaults to ., meaning all of the depot's files are placed directly in the game's install folder.

addContentRecursively (optional): If localPath contains wildcards, setting this to true means that all matching files within subdirectories of localPath are also included.

Return Value

This function returns a String representing the path to the created depot manifest.

Example

steam.createDepotManifest('1001', "${env.WORKSPACE}/Build/WindowsNoEditor", '*.pdb');

steam.createDepotManifest('1001', "${env.WORKSPACE}/Build", '*.pdb', './DLC/MapPack1/*', './Maps');

Deploying

tryDeploy

This function is used to deploy your application to Steam. If a 2FA code is required, the console output will contain a link asking for your Steam Guard code. The Steam Guard code has to be entered within 2 minutes, or this stage will fail.

Parameters

steamCredentials: The ID of the credentials that should be used to log into Steam.

appManifest: The path to the created app manifest.

Example

steam.tryDeploy(${params.STEAM_CREDENTIALS}, "${env.WORKSPACE}/app_build_1000.vdf");