Steam browser protocol: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
m (Robot: fixing template case.)
Line 27: Line 27:
**Example: {{SteamLink|steam://installaddon/halflifehd}} installs HL High-Def Pack.
**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:
**<code>{{steamlinktitled|steam://open/friends|friends}}</code>
**<code>{{SteamLinkTitled|steam://open/friends|friends}}</code>
**<code>{{steamlinktitled|steam://open/games|games}}</code>
**<code>{{SteamLinkTitled|steam://open/games|games}}</code>
**<code>{{steamlinktitled|steam://open/main|main}}</code>
**<code>{{SteamLinkTitled|steam://open/main|main}}</code>
**<code>{{steamlinktitled|steam://open/mymedia|mymedia}}</code>
**<code>{{SteamLinkTitled|steam://open/mymedia|mymedia}}</code>
**<code>{{steamlinktitled|steam://open/news|news}}</code>
**<code>{{SteamLinkTitled|steam://open/news|news}}</code>
**<code>{{steamlinktitled|steam://open/registerproduct|registerproduct}}</code> - Allows registering of keys from different games (e.g [[Prey]])
**<code>{{SteamLinkTitled|steam://open/registerproduct|registerproduct}}</code> - Allows registering of keys from different games (e.g [[Prey]])
**<code>{{steamlinktitled|steam://open/servers|servers}}</code>
**<code>{{SteamLinkTitled|steam://open/servers|servers}}</code>
**<code>{{steamlinktitled|steam://open/settings|settings}}</code>
**<code>{{SteamLinkTitled|steam://open/settings|settings}}</code>
* '''<code>steam://openurl/<url></code>''' Opens URL in default web browser.
* '''<code>steam://openurl/<url></code>''' Opens URL in default web browser.
* '''<code>steam://paypal/cancel</code>''' Cancels an ongoing PayPal transaction.
* '''<code>steam://paypal/cancel</code>''' Cancels an ongoing PayPal transaction.
Line 46: Line 46:
* '''<code>steam://runsafe/<id></code>''' Resets CVARs of an app.
* '''<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>{{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>
**<code>{{SteamLinkTitled|steam://settings/account|account}}</code>
**<code>{{steamlinktitled|steam://settings/friends|friends}}</code>
**<code>{{SteamLinkTitled|steam://settings/friends|friends}}</code>
**<code>{{steamlinktitled|steam://settings/interface|interface}}</code>
**<code>{{SteamLinkTitled|steam://settings/interface|interface}}</code>
**<code>{{steamlinktitled|steam://settings/ingame|ingame}}</code>
**<code>{{SteamLinkTitled|steam://settings/ingame|ingame}}</code>
**<code>{{steamlinktitled|steam://settings/downloads|downloads}}</code>
**<code>{{SteamLinkTitled|steam://settings/downloads|downloads}}</code>
**<code>{{steamlinktitled|steam://settings/voice|voice}}</code>
**<code>{{SteamLinkTitled|steam://settings/voice|voice}}</code>
* '''<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://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://support/<params></code>''' Launches the Steam Support utility, running all tests. Enter [[Steam Support strings|valid support string]] to filter results.
Line 58: Line 58:
* '''<code>steam://url/<page>[/<params>]</code>''' Opens a specified Steam Community page
* '''<code>steam://url/<page>[/<params>]</code>''' Opens a specified Steam Community page
** <code>ChatBanListAdmin/...</code>
** <code>ChatBanListAdmin/...</code>
** <code>{{steamlinktitled|steam://url/DownloadsSupportInfo|DownloadsSupportInfo}}</code> - Opens support.valvesoftware.com in your default browser
** <code>{{SteamLinkTitled|steam://url/DownloadsSupportInfo|DownloadsSupportInfo}}</code> - Opens support.valvesoftware.com in your default browser
** <code>GroupEventsPage/<id></code>
** <code>GroupEventsPage/<id></code>
** <code>GroupSteamIDPage/<id></code>
** <code>GroupSteamIDPage/<id></code>
** <code>GroupSteamIDAdmin/<id></code>
** <code>GroupSteamIDAdmin/<id></code>
** <code>{{steamlinktitled|steam://url/LeaveGroupPage|LeaveGroupPage}}</code>
** <code>{{SteamLinkTitled|steam://url/LeaveGroupPage|LeaveGroupPage}}</code>
** <code>{{steamlinktitled|steam://url/steamIDControlPage|SteamIDControlPage}}</code>
** <code>{{SteamLinkTitled|steam://url/steamIDControlPage|SteamIDControlPage}}</code>
** <code>{{steamlinktitled|steam://url/SteamIDEditPage|SteamIDEditPage}}</code>
** <code>{{SteamLinkTitled|steam://url/SteamIDEditPage|SteamIDEditPage}}</code>
** <code>SteamIDLoginPage/...</code> - ???
** <code>SteamIDLoginPage/...</code> - ???
** <code>SteamIDPage/<id></code>
** <code>SteamIDPage/<id></code>
** <code>StoreFrontPage</code> - ???
** <code>StoreFrontPage</code> - ???
** <code>{{steamlinktitled|steam://url/SupportFrontPage|SupportFrontPage}}</code> - Opens support.valvesoftware.com in your default browser
** <code>{{SteamLinkTitled|steam://url/SupportFrontPage|SupportFrontPage}}</code> - Opens support.valvesoftware.com in your default browser
* '''<code>steam://validate/<id></code>''' Validates the GCFs of an app.
* '''<code>steam://validate/<id></code>''' Validates the GCFs of an app.



Revision as of 20:14, 19 January 2009

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

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)

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://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.