Public/Update-SteamApp.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
function Update-SteamApp {
    <#
    .SYNOPSIS
    Install or update a Steam application using SteamCMD.
 
    .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.
 
    .PARAMETER GameName
    Enter the name of the app to make a wildcard search for the game.
 
    .PARAMETER AppID
    Enter the application ID you wish to install.
 
    .PARAMETER Credential
    If the app requires login to install or update, enter your Steam username and password.
 
    .PARAMETER Path
    Path to installation folder.
 
    .PARAMETER 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) validate +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) validate +quit"
 
    .EXAMPLE
    Update-SteamApp -GameName 'Arma 3' -Credential 'Toby' -Path 'C:\Servers\Arma3'
    Because there are multiple hits when searching for Arma 3, the user will be promoted to select the right application.
 
    .EXAMPLE
    Update-SteamApp -AppID 376030 -Path 'C:\Servers'
    Here we use anonymous login because the particular application (ARK: Survival Evolved Dedicated Server) doesn't require login.
 
    .NOTES
    Author: Frederik Hjorslev Poulsen
 
    SteamCMD CLI parameters: https://developer.valvesoftware.com/wiki/Command_Line_Options#Command-line_parameters_4
 
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = 'Medium'
    )]
    param
    (

        [Parameter(
            Position = 0,
            Mandatory = $true,
            ValueFromPipelineByPropertyName = $true,
            ParameterSetName = 'GameName'
        )]
        [string[]]$GameName,

        [Parameter(
            Position = 0,
            Mandatory = $true,
            ValueFromPipelineByPropertyName = $true,
            ParameterSetName = 'AppID'
        )]
        [int]$AppID,

        [System.IO.FileInfo]$Path,

        [ValidateNotNull()]
        [System.Management.Automation.PSCredential]
        [System.Management.Automation.Credential()]
        $Credential = [System.Management.Automation.PSCredential]::Empty,

        [string]$Arguments
    )

    begin {
        # Make Secure.String to plain text string.
        if ($null -eq $Credential) {
            $SecureString = $Credential | Select-Object -ExpandProperty Password
            $BSTR = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureString)
            $PlainPassword = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($BSTR)
        }

        $SteamCMDx64Location = 'C:\SteamCMD'
        $SteamCMDExecutable = "$($SteamCMDx64Location)\steamcmd.exe"

        # If SteamCMD is not located in the following path we install it.
        if (-not (Test-Path -Path $SteamCMDExecutable)) {
            Install-SteamCMD
        }

        # We only retrieve all Steam apps ID and name if ParameterSetName is GameName.
        if ($PSCmdlet.ParameterSetName -eq 'GameName') {
            # Get most recent list with all Steam Apps ID and corresponding title and put it into a variable.
            $SteamApps = (Invoke-WebRequest -Uri 'https://api.steampowered.com/ISteamApps/GetAppList/v0002/' -UseBasicParsing).Content | ConvertFrom-Json

            # Access nested object app in apps in applist.
            $SteamApps = $SteamApps.applist.apps
        }
    } # Begin

    process {
        function Use-SteamCMD {
            # If Steam username and Steam password are not empty we use them for logging in.
            if ($null -ne $Credential.UserName) {
                Write-Verbose -Message "Logging into Steam as $($Credential | Select-Object -ExpandProperty UserName)."
                Start-Process -FilePath $SteamCMDExecutable -NoNewWindow -ArgumentList "+login $($Credential | Select-Object -ExpandProperty UserName) $($PlainPassword) +force_install_dir `"$($Path)`" +app_update $($SteamAppID) $($Arguments) validate +quit" -Wait
            }
            # If Steam username and Steam password are empty we use anonymous login.
            elseif ($null -eq $Credential.UserName) {
                Write-Verbose -Message 'Using anonymous Steam login.'
                Start-Process -FilePath $SteamCMDExecutable -NoNewWindow -ArgumentList "+login anonymous +force_install_dir `"$($Path)`" +app_update $($SteamAppID) $($Arguments) validate +quit" -Wait
            }
        }

        # If game is found by searching for game name.
        if ($PSCmdlet.ParameterSetName -eq 'GameName') {
            try {
                $SteamApps = $SteamApps | Where-Object -FilterScript {$PSItem.name -like "$($GameName)*"}

                # If only one game is found when searching by game name.
                if (($SteamApps | Measure-Object).Count -eq 1) {
                    Write-Verbose -Message "Only one game found: $($SteamApps.appid) - $($SteamApps.name)."
                    # Put Steam AppID into variable $SteamAppID.
                    $SteamAppID = $SteamApps.appid
                }
                # If more than one game is found the user is promted to select the exact game.
                elseif (($SteamApps | Measure-Object).Count -ge 1) {
                    # An OutGridView is presented to the user where the exact AppID can be located. This variable contains the AppID selected in the Out-GridView.
                    $SteamAppID = $SteamApps | Out-GridView -Title 'Select the game you wish to update or install' -PassThru | Select-Object -ExpandProperty appid
                    Write-Verbose -Message "$($SteamAppID) selected from Out-GridView."
                }

                # Install selected Steam application if a SteamAppID has been selected.
                if (-not ($null -eq $SteamAppID)) {
                    Use-SteamCMD
                }
            } catch {
                Throw "$($GameName) couldn't be updated."
            }
        } # ParameterSet GameName

        # If game is found by using a unique AppID.
        if ($PSCmdlet.ParameterSetName -eq 'AppID') {
            try {
                $SteamAppID = $AppID
                Write-Verbose -Message "The game with Steam AppID $($SteamAppID) is being updated. Please wait for SteamCMD to finish."

                # Install selected Steam application.
                Use-SteamCMD
            } catch {
                Throw "$($SteamAppID) couldn't be updated."
            }
        } # ParameterSet AppID
    } # Process
} # Cmdlet