Difference between revisions of "Steam browser protocol"

From Valve Developer Community
Jump to: navigation, search
(steam://runadv/)
(Implemented commands: add password)
Line 9: Line 9:
 
* '''<code>steam://appnews/<id></code>''' Opens up the news page for an app.
 
* '''<code>steam://appnews/<id></code>''' Opens up the news page for an app.
 
* '''<code>steam://backup/<id></code>''' Opens up the Backup Wizard and checks the specified application. If an application is not specified then nothing will be checked.
 
* '''<code>steam://backup/<id></code>''' Opens up the Backup Wizard and checks the specified application. If an application is not specified then nothing will be checked.
* '''<code>steam://connect/<IP or DNS name>[:<port>]</code>''' Connects the user to the server specified by the IP or [[Wikipedia:DNS|DNS name]]. You don't have to specify anything for connecting a third party mod server, it will be automaticly detected.
+
* '''<code>steam://connect/<IP or DNS name>[:<port>][/<password>]</code>''' Connects the user to the server specified by the IP or [[Wikipedia:DNS|DNS name]]. You don't have to specify anything for connecting a third party mod server, it will be automaticly detected.
 
**Example: <code>steam://connect/1.0.0.27:27015</code>
 
**Example: <code>steam://connect/1.0.0.27:27015</code>
 
**Example: <code>steam://connect/dns.server.com</code>
 
**Example: <code>steam://connect/dns.server.com</code>

Revision as of 06:59, 19 January 2010

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).

Implemented commands

Note: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:

Connect protocol

  • 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
    • An alternate syntax which makes more sense if you're familiar with HTTP URL syntax: steam://connect/<IP or DNS name>[:port]/?cvar1=value&cvar2=value&password=blah&etc.. --The MAZZTer 21:03, 31 Jul 2008 (PDT)
    • A similar syntax could be: steam://connect/?ip=<ip>:<port>&password=<password>&hltv=<true/false>&gamedetails=<true/false>&cvars="<cvar1> <value>;<cvar2> <value>;" where gamedetails refers to Server Info (similar to proposed protocol below); and all data under cvars is automatically compiled into a one-time .cfg file. -- JRod 17:13, 22 Nov 2008 (PST)
  • steam://open/bandwidth
    • Opens the bandwidth monitor panel, which is currently rather buried and unreachable without opening another window. Considering the potential impact of large downloads it'd be nice if it was easier to see what was happening. Case in point: here in Australia you can quickly run up hundreds, even thousands of dollars if you don't consider your quotas and peak/off-peak download periods and excess download fees. --Gth 02:05, 13 March 2009 (UTC)

Overlay Browser

  • steam://overlay/<Website or Arguments From Steam://url>
    • Opens the overlay ingame with the specified parameter, helpful for opening steam groups ingame so players can join. --DontWannaName
      • Second this request, would be great for creating communities for/in L4D Captain-p0t-n00dle 10:02, 10 May 2009 (UTC)

Other

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://friends/message/<id OR username>
    • This would update the /friends/message/ command to allow users to more easily add their IM links to their webpages (i.e. social networking sites). It just seems a little odd that you have to know your numerical steam ID in order to use this command. The /friends/add/ command could also include this functionality.
  • 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.