Class

SteamCmd

SteamCmd(auth, confignullable)

Manager of a SteamCmd instance. SteamCmd is used to download the Slay the Spire game files. To do so, a Steam account with a purchased copy of Slay the Spire is required. Documentation for SteamCmd can be found here. This module only works on Windows

Constructor

# new SteamCmd(auth, confignullable)

Create an instance of SteamCmd with the credentials of a specified Steam account
Parameters:
Name Type Attributes Description
auth SteamAuth Steam account authentication for Steam account with a copy of Slay the Spire
config SteamCmdConfig <nullable>
 Optional config for steam cmd

View Source SteamCmd/SteamCmd.ts, line 39

Example
const steamAuth: SteamAuth = { username: 'example_user', password: 'P@55W0RD' };
const steamCmd = new SteamCmd(steamAuth);

Classes

SteamCmd

Members

# installDirectory

SteamCmd install directory

View Source SteamCmd/SteamCmd.ts, line 53

# isInstalled

Is SteamCmd installed

View Source SteamCmd/SteamCmd.ts, line 60

Methods

# static getExitCodeDescription(code) → {string}

Get the description of a specified SteamCmd SteamCmdExitCode
Parameters:
Name Type Description
code SteamCmdExitCode The exit code to get the description of

View Source SteamCmd/SteamCmd.ts, line 160

string
Example
const exitDescription: string = getExitCodeDescription(
     SteamCmdExitCode.UNABLE_TO_INSTALL_APP);
console.log(exitDescription); // 'unable to install app'

# static isAppInstalled(gameInstallDir) → {boolean}

Check if a steam app is installed
Parameters:
Name Type Description
gameInstallDir string Install directory of steam app

View Source SteamCmd/SteamCmd.ts, line 177

boolean
Example
const isSlayTheSpireInstalled: boolean = SteamCmd.isAppInstalled('./.sts'); // false

# async install()

Download and extract SteamCmd files to the specified install directory. If no install directory was specified in the constructor with SteamCmdConfig, then SteamCmd is installed to the default install directory (./.steamcmd)

View Source SteamCmd/SteamCmd.ts, line 76

Example
// Install SteamCmd to './.steamcmd'
const steamAuth: SteamAuth = { username: 'example_user', password: 'P@55W0RD' };
const steamCmd = new SteamCmd(steamAuth);
await steamCdm.install();

# async installApp(guardCode, appId, gameInstallDir)

Install a Steam game with the specified app ID
Parameters:
Name Type Description
guardCode string Steam guard code
appId number ID of the steam app to install
gameInstallDir string Directory to install the game to

View Source SteamCmd/SteamCmd.ts, line 146

Example
// Install Slay the Spire to './.sts'
const steamAuth: SteamAuth = { username: 'example_user', password: 'P@55W0RD' };
const steamCmd = new SteamCmd(steamAuth);
await steamCmd.installApp(646570, './.sts', '12345');

# async runCommand(guardCode, command) → {Promise.<SteamCmdExitCode>}

Run a SteamCmd command
Parameters:
Name Type Description
guardCode string Steam guard code
command Array.<string> The SteamCmd command to run

View Source SteamCmd/SteamCmd.ts, line 111

Promise.<SteamCmdExitCode>
Example
// Install and validate the Counter Strike: Global Offensive dedicated server
const steamAuth: SteamAuth = { username: 'example_user', password: 'P@55W0RD' };
const steamCmd = new SteamCmd(steamAuth);
await steamCmd.runCommand(['+force_install_directory', './cs_go/', '+app_update', '740',
     'validate', '+quit'], '12345');