/SteamPS

Module that utilizes PowerShell as a wrapper for SteamCMD.

Primary LanguagePowerShellMIT LicenseMIT

SteamPS

Build Status

AppVeyor master AppVeyor tests (master) Codacy master grade

Introduction

PowerShell Version PowerShell Gallery

This cmdlet utilizes SteamCMD and eases the installation and updating of servers.

Install or update a Steam application using SteamCMD. You can either enter the specific Application ID or search for the application by name. If there are multiple hits on the name, an Out-GridView will be presented letting you choose the right application to install.

Requirements

PowerShell 5.0

You can find your version of PowerShell by using:

$PSVersionTable.PSVersion

Installation

The module is published in the PowerShell Gallery.

  1. Run the following in an elevated prompt:
Install-Module -Name SteamPS

When SteamPS is installed we will need to use the cmdlet Install-SteamCMD from the module to install SteamCMD. 2. This is done by calling Install-SteamCMD from an elevated prompt:

Install-SteamCMD

By using the parameter -InstallPath you can specify an install location of SteamCMD.

Cmdlets

Cmdlet Description
Find-SteamAppID Find a Steam AppID by searching the name of the application.
Get-SteamServerInfo Query a running steam based game server.
Install-SteamCMD Install SteamCMD.
Update-SteamApp Install or update a Steam application using SteamCMD.
Update-SteamServer Update a Steam based game server through a particular workflow.

Examples

The cmdlets must be executed from an elevated prompt.

Update single app / game server

Add a game / server by searching for its name. Because there are multiple hits when searching for Arma 3, the user will be promoted to select the right application.

Update-SteamApp -GameName 'Arma 3' -Credential Toby -Path 'C:\Servers\Arma3'

Here we use anonymous login because the particular application (ARK: SurvivalEvolved Dedicated Server) doesn't require authentication to install the server.

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

Update Steam server automatically

The cmdlet Update-SteamServer is, at least for my own use case, applied to automatically keep a server up-to-date. It will check the if the server is empty before updating it.

Please see the wiki for further information: Update Steam server automatically