Skip to content

Update-SteamApp.md

Latest commit

 

History

History
207 lines (157 loc) · 4.94 KB

Update-SteamApp.md

File metadata and controls

207 lines (157 loc) · 4.94 KB
Raw
external help file SteamPS-help.xml
Module Name SteamPS
online version https://hjorslev.github.io/SteamPS/Update-SteamApp.html
schema 2.0.0

Update-SteamApp

SYNOPSIS

Install or update a Steam application using SteamCMD.

SYNTAX

ApplicationName

Update-SteamApp [-ApplicationName] <String> -Path <String> [-Credential <PSCredential>] [-Arguments <String>]
 [-Force] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

ApplicationID

Update-SteamApp [-ApplicationID] <Int32> -Path <String> [-Credential <PSCredential>] [-Arguments <String>]
 [-Force] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Install or update a Steam application using SteamCMD. If SteamCMD is missing, it will be installed first. You can either search for the application by name or enter the specific Application ID.

EXAMPLES

EXAMPLE 1

Update-SteamApp -ApplicationName 'Arma 3' -Credential 'Toby' -Path 'C:\DedicatedServers\Arma3'

Because there are multiple hits when searching for Arma 3, the user will be promoted to select the right application.

EXAMPLE 2

Update-SteamApp -AppID 376030 -Path 'C:\DedicatedServers\ARK-SurvivalEvolved'

Here we use anonymous login because the particular application (ARK: Survival Evolved Dedicated Server) doesn't require login.

PARAMETERS

-ApplicationID

Enter the application ID you wish to install.

Type: Int32
Parameter Sets: ApplicationID
Aliases: AppID

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ApplicationName

Enter the name of the app to make a wildcard search for the application.

Type: String
Parameter Sets: ApplicationName
Aliases: GameName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Arguments

Enter any additional arguments here.

Beware, the following arguments are already used:

If you use Steam login to install/upload the app the following arguments are already used: "+login $SteamUserName $SteamPassword +force_install_dir $Path +app_update $SteamAppID $Arguments +quit"

If you use anonymous login to install/upload the app the following arguments are already used: "+login anonymous +force_install_dir $Path +app_update $SteamAppID $Arguments +quit"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

If the app requires login to install or update, enter your Steam username and password.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

-Force

The Force parameter allows the user to skip the "Should Continue" box.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Path

Path to installation folder.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Author: Frederik Hjorslev Nylander

SteamCMD CLI parameters: https://developer.valvesoftware.com/wiki/Command_Line_Options#Command-line_parameters_4

RELATED LINKS

https://hjorslev.github.io/SteamPS/Update-SteamApp.html