Steam browser protocol: Difference between revisions

Revision as of 15:30, 3 May 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).

steam:<commands> Opens Steam with command line arguments, which can be found here.

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

steam://advertise/<id> Opens up the store for an application.
steam://ackMessage/ackGuestPass/<pass> Accepts the Gift or Guest Pass.
steam://appnews/<id> Opens up the news page for an app.
steam://backup/<id> Opens up the Backup Wizard and checks the specified application. If an application is not specified then nothing will be checked.
steam://connect/<IP or DNS name>[:<port>] Connects the user to the server specified by the IP or DNS name. You don't have to specify anything for connecting a third party mod server, it will be automaticly detected.
- Example: steam://connect/1.0.0.27:27015
- Example: steam://connect/dns.server.com
steam://defrag/<id> Defragments files of the application.
steam://friends/
- add/<id> - Adds user with specified id number
- players - Shows list of users with whom you recently played
- joinchat/<id> - Joins a chat with a specified id number
- message/<id> -
Template:Steamlink Opens up the Guest Passes window
steam://hardwarepromo/ Executes hardware promo method.
- Example: Template:Steamlink gets the products for this offer.
- Example: Template:Steamlink gets the products for this offer.
steam://install/<id> Installs an application.
- Example: Template:Steamlink installs Sam & Max: Episode 4.
steam://installaddon/<addon> Installs the specified add-on.
- Example: Template:Steamlink installs HL High-Def Pack.
steam://open/<component> Opens a Steam window. Known <component> values:
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled - Allows registering of keys from different games (e.g Prey)
- Template:Steamlinktitled
- Template:Steamlinktitled
steam://openurl/<url> Opens URL in default web browser.
steam://paypal/cancel Cancels an ongoing PayPal transaction.
steam://preload/<id> Preloads an application.
steam://publisher/<name> Loads the specified publisher catalogue in the Store. Type the publisher's name in lowercase, e.g. activision or valve.
steam://purchase/<id> Opens a dialog box to buy an application from Steam.
steam://purchase/subscription/<id> Opens up a dialog box to buy a subscription to a Steam product/service. None are available yet.
steam://removeaddon/<addon> Uninstalls the specified add-on.
- Example: Template:Steamlink uninstalls HL High-Def Pack
steam://run/<id> Runs an application.
steam://runsafe/<id> Resets CVARs of an app.
Template:Steamlink Same as Template:Steamlink, but also allows for subcommands for each page:
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
steam://store/<id> Opens up the store for an app, if no app is specified then the default one is opened.
steam://support/<params> Launches the Steam Support utility, running all tests. Enter valid support string to filter results.
steam://uninstall/<id> Deletes the specified apps' cache files.
steam://updatenews/<id> Opens the news about the latest updates for an app.
steam://url/<page>[/<params>] Opens a specified Steam Community page
- ChatBanListAdmin/...
- Template:Steamlinktitled - Opens support.valvesoftware.com in your default browser
- GroupEventsPage/<id>
- GroupSteamIDPage/<id>
- GroupSteamIDAdmin/<id>
- Template:Steamlinktitled
- Template:Steamlinktitled
- Template:Steamlinktitled
- SteamIDLoginPage/... - ???
- SteamIDPage/<id>
- StoreFrontPage - ???
- Template:Steamlinktitled - Opens support.valvesoftware.com in your default browser
steam://validate/<id> Validates the GCFs of an app.

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>
- Open title page on the VDC. -- AiusEpsi and ts2do
  - Why would this be useful? We already have steam://openurl/<url>. -- WildCat
    - Saves us from having to type http://developer.valvesoftware.com/wiki/ for everything. We're not completely obsessed, we don't use steam:// to open hypertext pages --Alph Tech STUART 17:13, 9 Jun 2006 (PDT).
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

steam://forceupdate/<AppID>

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.

@@ Line 1: / Line 1: @@
 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 IDs|Steam Application ID]] in place of <id> (i.e. 211 for the Source SDK).
-* '''<code>steam:<commands></code>''' This opens Steam with command line arguments, [[Command_Line_Options#Steam_(Windows)|which can be found here]].
+* '''<code>steam:<commands></code>''' Opens Steam with command line arguments, [[Command_Line_Options#Steam_(Windows)|which can be found here]].
 {{note|If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.}}
-* '''<code>steam://advertise/<id></code>''' This opens up the store for an app.
+* '''<code>steam://advertise/<id></code>''' Opens up the store for an application.
-* '''<code>steam://ackMessage/ackGuestPass/<id></code>''' Accepts the Guest Pass Sent
+* '''<code>steam://ackMessage/ackGuestPass/<pass></code>''' Accepts the Gift or Guest Pass.
-* '''<code>steam://appnews/<id></code>''' This opens up the appnews web page for an app.
+* '''<code>steam://appnews/<id></code>''' Opens up the news page for an app.
-* '''<code>steam://backup/<id></code>''' This opens up Steam's backup utility. If an AppId is specified then the product is checkmarked automatically.
+* '''<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>''' 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.
+* '''<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.
 **Example: <code>steam://connect/1.0.0.27:27015</code>
 **Example: <code>steam://connect/dns.server.com</code>
-* '''<code>steam://defrag/<id></code>''' This defragments the [[GCF]]s associated with an installed application.
+* '''<code>steam://defrag/<id></code>''' Defragments files of the application.
 * '''<code>steam://friends/</code>'''
 **<code>add/<id></code> - Adds user with specified id number
@@ Line 16: / Line 16: @@
 **<code>joinchat/<id></code> - Joins a chat with a specified id number
 **<code>message/<id></code> -
-* '''<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].
 **Example: {{steamlink|steam://hardwarepromo/609}} gets the products for [http://www.steampowered.com/nvidia1/ this offer].
 * '''<code>steam://install/<id></code>''' Installs an application.
 **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>''' 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>{{steamlinktitled|steam://open/friends|friends}}</code>
@@ Line 35: / Line 35: @@
 * '''<code>steam://openurl/<url></code>''' Opens URL in default web browser.
 * '''<code>steam://paypal/cancel</code>''' Cancels an ongoing PayPal transaction.
-* '''<code>steam://preload/<id></code>''' This preloads an app.
+* '''<code>steam://preload/<id></code>''' Preloads an application.
 * '''<code>steam://publisher/<name></code>''' Loads the specified publisher catalogue in the Store. Type the publisher's name in lowercase, e.g. <code>activision</code> or <code>valve</code>.
-* '''<code>steam://purchase/<id></code>''' This opens a dialog box to buy an app from Steam.
+* '''<code>steam://purchase/<id></code>''' Opens a dialog box to buy an application from Steam.
-* '''<code>steam://purchase/subscription/<id></code>''' This opens up a dialog box to buy a subscription to a Steam product/service. None are available yet.
+* '''<code>steam://purchase/subscription/<id></code>''' Opens up a dialog box to buy a subscription to a Steam product/service. None are available yet.
-* '''<code>steam://removeaddon/<addon></code>''' This uninstalls the specified add-on. Example: {{steamlink|steam://removeaddon/halflifehd}} uninstalls HL High-Def Pack
+* '''<code>steam://removeaddon/<addon></code>''' Uninstalls the specified add-on.
-* '''<code>steam://run/<id></code>''' This opens an app.
+**Example: {{steamlink|steam://removeaddon/halflifehd}} uninstalls HL High-Def Pack
-* '''<code>steam://runsafe/<id></code>''' This resets CVARs of an app.
+* '''<code>steam://run/<id></code>''' Runs an application.
+* '''<code>steam://runsafe/<id></code>''' Resets CVARs of an app.
 * '''<code>{{steamlink|steam://settings/}}</code>''' Same as <code>{{steamlink|steam://open/settings}}</code>, but also allows for subcommands for each page:
 **<code>{{steamlinktitled|steam://settings/account|account}}</code>
@@ Line 49: / Line 50: @@
 **<code>{{steamlinktitled|steam://settings/downloads|downloads}}</code>
 **<code>{{steamlinktitled|steam://settings/voice|voice}}</code>
-* '''<code>steam://store/<id></code>''' This opens up the store for an app, if no app is specified then the default one is opened.
+* '''<code>steam://store/<id></code>''' Opens up the store for an app, if no app is specified then the default one is opened.
 * '''<code>steam://support/<params></code>''' Launches the Steam Support utility, running all tests. Enter [[Steam Support strings|valid support string]] to filter results.
 * '''<code>steam://uninstall/<id></code>''' Deletes the specified apps' cache files.
-* '''<code>steam://updatenews/<id></code>''' This opens the news about the latest updates for an app.
+* '''<code>steam://updatenews/<id></code>''' Opens the news about the latest updates for an app.
 * '''<code>steam://url/<page>[/<params>]</code>''' Opens a specified Steam Community page
 ** <code>ChatBanListAdmin/...</code>
@@ Line 66: / Line 67: @@
 ** <code>StoreFrontPage</code> - ???
 ** <code>{{steamlinktitled|steam://url/SupportFrontPage|SupportFrontPage}}</code> - Opens support.valvesoftware.com in your default browser
-* '''<code>steam://validate/<id></code>''' This validates the GCFs of an app.
+* '''<code>steam://validate/<id></code>''' Validates the GCFs of an app.
 ==Suggested commands==

Steam browser protocol: Difference between revisions

Revision as of 15:30, 3 May 2008

Suggested commands

Navigation menu

Search