Steam browser protocol: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (<IP or DNS name>[:port])
Line 1: Line 1:
==Commands==
==Commands==
There are several 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.
There are several 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.
* '''steam:<commands>''' This opens Steam with command line arguments. Replace %c with command line arguments found here: [[Steam Command Line Options]]
* '''steam:<commands>''' This opens Steam with command line arguments, which can be found here: [[Steam Command Line Options]]
* '''steam://store/<id>''' This opens up the store for the specified product, if no product is specified then the default one is opened. Use a [[Steam Applaunch IDs|Steam Applaunch ID]] for the id.
* '''steam://store/<id>''' This opens up the store for the specified product, if no product is specified then the default one is opened. Use a [[Steam Applaunch IDs|Steam Applaunch ID]] for the id.
* '''steam://backup/<id>''' This opens up Steam's backup utility. If a product id is specified then the product is checkmarked automatically. Use a [[Steam Applaunch IDs|Steam Applaunch ID]] for the id.
* '''steam://backup/<id>''' This opens up Steam's backup utility. If a product id is specified then the product is checkmarked automatically. Use a [[Steam Applaunch IDs|Steam Applaunch ID]] for the id.
Line 13: Line 13:
* '''steam://installaddon/<addon>''' This installs the specified add-on. Example: steam://installaddon/halflifehd installs HL High-Def Pack
* '''steam://installaddon/<addon>''' This installs the specified add-on. Example: steam://installaddon/halflifehd installs HL High-Def Pack
* '''steam://removeaddon/<addon>''' This uninstalls the specified add-on. Example: steam://removeaddon/halflifehd uninstalls HL High-Def Pack
* '''steam://removeaddon/<addon>''' This uninstalls the specified add-on. Example: steam://removeaddon/halflifehd uninstalls HL High-Def Pack
* '''steam://connect/<ip or dns name>''' This connects the user to the server specified by the IP or [[Wikipedia:DNS|DNS name]].  Using this, you can connect to servers for third party mods without needing to know the mod's installation path.
* '''steam://connect/<IP or DNS name>[:port]''' This connects the user to the server specified by the IP or [[Wikipedia:DNS|DNS name]].  Using this, you can connect to servers for third party mods without needing to know the mod's installation path.
**Example: steam://connect/1.0.0.27:27015
**Example: steam://connect/1.0.0.27:27015
**Example: steam://connect/dns.server.com
**Example: steam://connect/dns.server.com
Line 20: Line 20:


===Suggested===
===Suggested===
* '''steam://connect/<ip or dns name>/<password>'''
* '''steam://connect/<IP or DNS name>[:port]/<password>'''
**Connects to the specified server with the right password --[[User:Semi|Semi]]
**Connects to the specified server with the right password --[[User:Semi|Semi]]
* '''steam://connect/<ip or dns name>/'command1 "arg1" "arg2";command2 "arg1";password "blah";etc..''''
* '''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 --[[User:ts2do|ts2do]]
**Connects to the specified server after executing the specified commands --[[User:ts2do|ts2do]]
* '''steam://vdc/<page title>'''
* '''steam://vdc/<page title>'''
Line 30: Line 30:
* '''steam://friends/chat/<user>'''
* '''steam://friends/chat/<user>'''
**Open chat window with user (if online). --[[User:Alph Tech STUART|STUART]] <sup>([[User talk:Alph Tech STUART|TALK]]{{e-|stuart@testtrack4.com}}{{-|http://www.testtrack4.com}})</sup>
**Open chat window with user (if online). --[[User:Alph Tech STUART|STUART]] <sup>([[User talk:Alph Tech STUART|TALK]]{{e-|stuart@testtrack4.com}}{{-|http://www.testtrack4.com}})</sup>
* '''steam://gameinfo/<ip or dns name>'''
* '''steam://gameinfo/<IP or DNS name>[:port]'''
**Opens the "game info" window 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. --[[User:Koraktor|Koraktor]]
**Opens the "game info" window 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. --[[User:Koraktor|Koraktor]]


Line 41: Line 41:
'''steam:"-applaunch 70 -game "<mod>" +map "<map>""''' - This starts up [[Half-Life]] running the specified mod then loads a specified map.
'''steam:"-applaunch 70 -game "<mod>" +map "<map>""''' - This starts up [[Half-Life]] running the specified mod then loads a specified map.


'''steam://connect/<ip or dns name>[:port]"''' - If a mod was running at the specified server, Steam would attempt to start up that mod and connect there. This applies to any kind of [[Goldsource]]/[[Source]] server.
'''steam://connect/<IP or DNS name>[:port]"''' - If a mod was running at the specified server, Steam would attempt to start up that mod and connect there. This applies to any kind of [[Goldsource]]/[[Source]] server.


To view this browser based command system in action look at this [http://www.bgmod.com/index.php?module=servers server browser website] and click on one of the servers.
To view this browser based command system in action look at this [http://www.bgmod.com/index.php?module=servers server browser website] and click on one of the servers.

Revision as of 15:13, 15 April 2006

Commands

There are several 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.

Suggested

Ability

What can be done with these commands from a websites point of view? Its a pretty open and powerful system. A website link can start up steam and not only change any ConVar of a user, but it can also execute ConCommands like making a player join a specific server running a specific mod. It can even get the player to start up a dedicated server with a single click.

Here some examples:

steam:"-applaunch 70 -game "<mod>" +map "<map>"" - This starts up Half-Life running the specified mod then loads a specified map.

steam://connect/<IP or DNS name>[:port]" - If a mod was running at the specified server, Steam would attempt to start up that mod and connect there. This applies to any kind of Goldsource/Source server.

To view this browser based command system in action look at this server browser website and click on one of the servers.

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