Steam browser protocol: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (fixing connect syntax)
m (Added steam://install example (Sam&Max e4).)
Line 18: Line 18:
* '''<code>{{steamlink|steam://guestpasses/}}</code>''' Opens up the Guest Passes Window
* '''<code>{{steamlink|steam://guestpasses/}}</code>''' Opens up the Guest Passes Window
* '''<code>steam://hardwarepromo/</code>''' Executes hardware promo method. Example: {{steamlink|steam://hardwarepromo/305}} gets the products for [http://www.steampowered.com/ati_offer1a/ this offer].
* '''<code>steam://hardwarepromo/</code>''' Executes hardware promo method. Example: {{steamlink|steam://hardwarepromo/305}} gets the products for [http://www.steampowered.com/ati_offer1a/ this offer].
* '''<code>steam://install/<id></code>''' This installs an app.
* '''<code>steam://install/<id></code>''' This installs an app. Example: {{steamlink|steam://install/8230}} installs [http://steampowered.com/v/index.php?area=game&AppId=8230 Sam & Max: Episode 4].
* '''<code>steam://installaddon/<addon></code>''' This installs the specified add-on. Example: {{steamlink|steam://installaddon/halflifehd}} installs HL High-Def Pack
* '''<code>steam://installaddon/<addon></code>''' This installs the specified add-on. Example: {{steamlink|steam://installaddon/halflifehd}} installs HL High-Def Pack
* '''<code>steam://open/<component></code>''' Opens a Steam window. Known <component> values:
* '''<code>steam://open/<component></code>''' Opens a Steam window. Known <component> values:

Revision as of 10:24, 24 March 2008

There are numerous system-wide commands available that interact with Steam. All of them open up Steam if it is not open. They can either be typed into a command box (Start-> Run) or through your browser's address bar (you can normally create links to them as you would web page links). Use a Steam Application ID in place of <id> (i.e. 211 for the Source SDK).

Note.pngNote:If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.

Suggested commands

The following commands are community suggestions and are not presently featured in Steam:

  • steam://connect/<IP or DNS name>[:port]/<password>
    • Connects to the specified server with the right password --Semi
      • I think that this is a must due to the fact that the appid's are complete bs when it comes to launching steam remotely. --pumakuma
  • steam://connect/<IP or DNS name>[:port]/'command1 "arg1" "arg2";command2 "arg1";password "blah";etc..'
    • Connects to the specified server after executing the specified commands --ts2do
  • steam://vdc/<page title>
  • steam://gameinfo/<IP or DNS name>[:port]
    • Opens the "Game Info" dialog for the specified server. Maybe also integrated into the server browser, so you don't have to add a server to the favorites to have access to that window. --Koraktor
Appreciated -Rotzi
  • steam://runsingle/<AppID>
    • Runs an app, then shuts down Steam once the game closes. -- AiusEpsi
      • This is stupid. All Source games needs Steam open in order to do anything concerning gcf files, which is the game itself.--Sortie 23:53, 5 Apr 2007 (PDT)
it shuts down steam AFTER the game ran and closed! Leopard84
I don't get the point. Useless in my point of view. -Rotzi
    • Forces update (if autoupdate fails) of all files (including all linked .gcf) for defined AppID. -- Dwarden
Restarting Steam would be simpler, and have the same effect. --TomEdwards 08:23, 13 Sep 2006 (PDT)
i'm afraid it's not that simple, see my post there http://forums.steampowered.com/forums/showthread.php?s=&threadid=485982 -- Dwarden
Yea, my steam REFUSES to update ANYTHING, even after re-installing it. A force update would be nice. --PanFrie 04:50, 1 Feb 2008 (EST)
  • steam://checkbuild/<AppID>
    • Compares actual local build of AppID with latest version available at Steam servers for defined AppID.
    • Results displayed in way: '<AppID> - <ActualLocalBuild>:<LatestBuildAtSteamServers>
    • and if they not match it offers user dialog to force update to latest build.