SteamCMD

From Valve Developer Community
Revision as of 18:46, 9 September 2012 by RavuAlHemio (talk | contribs) (Known issues: restructure 64-bit library section)

Jump to: navigation, search

The Steam Console Client or SteamCMD is a new tool to install and update dedicated servers using a command line interface. It only works with games that have switched over to the Steam Pipe content system. Eventually all Steam games will switch from HLDSUpdateTool to this.

Downloading and Running SteamCMD

1. Download the SteamCMD Update Tool

2. Extract the contents to a directory

Note:Do not extract the contents of the updater tool to the regular Steam Client folder or to a folder that has the older HLDSUpdateTool program.
  • Linux: type tar xvfz steamcmd.tar.gz

3. Launch SteamCMD for the first time

1. Open a command prompt in that directory and start SteamCmd
  • Windows: type steamcmd
  • Linux: type ./steam.sh
If this doesn't work, try STEAMEXE=steamcmd ./steam.sh
The program will automatically update and enter you in to a Steam> prompt. Type help for more information.
2. Log in with your Steam Account
Note:You must log out of the regular Steam client in order to properly log in to SteamCMD Update Tool.
login <username> <password>
If you receive a Steam Guard error, check your e-mail for your access code and login using the following command (you'll only need to do this once per computer):
login <username> <password> <steam guard code>
3. You should see a message stating that you have successfully logged in with your account.

Downloading an app

1. Start SteamCMD and set your app install directory. (note: use forward slashes for Linux and backslashes for Windows)

force_install_dir <path>
Bug: On some Linux distributions the path cannot contain any capital letters - see #Known issues
Example:
  • cs_go directory in the current directory:
force_install_dir ./cs_go/

2. Install or update the app. To also validate the app add validate to the command.

app_update <app_id>
Example:
  • To install and validate CS:GO:
app_update 740 validate

3. Once finished, type quit to properly log off of the Steam servers.

Automating SteamCMD

There are two ways to automate SteamCMD.

1. Add commands to the command line. Example:

SteamCMD +login user password +force_install_dir ../csgo_ds +app_update 740 validate

2. Create a script.

a. Put your SteamCMD commands in a text file. Example:
// update_csgo_ds.txt
//
login user password
force_install_dir ../csgo_ds
app_update 740 validate
exit
b. Run SteamCMD with the +runscript option. Example:
SteamCMD +runscript csgo_ds.txt

Protect your AccountLogin with gpg under Linux

Write your loginscript like the example and save the file as update_csgo_ds.txt. You have to encrypt with gpg the textfile with a symmetric encryption:

gpg -c --force-mdc update_csgo_ds.txt
# enter your password
# the new encrypted file update_csgo_ds.txt.gpg will be created
# delete the original file with
# rm update_csgo_ds.txt

You can check the decryption with:

gpg -d update_csgo_ds.txt.gpg
# enter you password
# the text will be written to stdout, when your password is ok

When everything is ok, you can use a little shell script to pipe the stdout from gpg to steam.sh:

#!/bin/sh
read -p "Enter your password: " -s pass
gpg --passphrase $pass -d login.gpg 2>/dev/null | STEAMEXE=steamcmd ./steam.sh
pass=""

Known issues

I was able to download or update the server package with SteamCMD, but the server fails to start

Common causes:

  • Linux: Some games on some distributions have issues with uppercase letters in directory/filenames.

32-bit libraries on 64-bit Linux systems

Since steamcmd is a 32-bit program, a few 32-bit libraries are required, even if you already have their 64-bit versions installed.

Symptomatic error messages look like this: steamcmd: error while loading shared libraries: libstdc++.so.6: cannot open shared object file: No such file or directory

= Debian and derivatives

sudo apt-get install ia32-libs-gtk

CentOS

sudo yum install glibc.i686 libstdc++.i686

Download Failed

On windows computers, the initial download may fail if proxy settings are not set to automatically detect settings.