Steam browser protocol: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Recent steam update "Tools tab can now be opened with steam://open/tools")
mNo edit summary
Line 32: Line 32:
**<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  
**<code>{{SteamLinkTitled|steam://open/registerproduct|registerproduct}}</code> - Allows registering of keys from different games (e.g [[Prey]])
**<code>{{SteamLinkTitled|steam://open/tools|tools}}</code>
**<code>{{SteamLinkTitled|steam://open/tools|tools}}</code>
(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>
Line 43: Line 42:
* '''<code>steam://purchase/<id></code>''' Opens a dialog box to buy an application from Steam.
* '''<code>steam://purchase/<id></code>''' Opens a dialog box to buy an application from Steam.
* '''<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://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>''' Uninstalls the specified add-on.
* '''<code>steam://removeaddon/<addon></code>''' Uninstalls th
**Example: {{SteamLink|steam://removeaddon/halflifehd}} uninstalls HL High-Def Pack
* '''<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>
**<code>{{SteamLinkTitled|steam://settings/friends|friends}}</code>
**<code>{{SteamLinkTitled|steam://settings/interface|interface}}</code>
**<code>{{SteamLinkTitled|steam://settings/ingame|ingame}}</code>
**<code>{{SteamLinkTitled|steam://settings/downloads|downloads}}</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://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>''' 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>
** <code>{{SteamLinkTitled|steam://url/DownloadsSupportInfo|DownloadsSupportInfo}}</code> - Opens support.valvesoftware.com in your default browser
** <code>GroupEventsPage/<id></code>
** <code>GroupSteamIDPage/<id></code>
** <code>GroupSteamIDAdmin/<id></code>
** <code>{{SteamLinkTitled|steam://url/LeaveGroupPage|LeaveGroupPage}}</code>
** <code>{{SteamLinkTitled|steam://url/steamIDControlPage|SteamIDControlPage}}</code>
** <code>{{SteamLinkTitled|steam://url/SteamIDEditPage|SteamIDEditPage}}</code>
** <code>SteamIDLoginPage/...</code> - ???
** <code>SteamIDPage/<id></code>
** <code>StoreFrontPage</code> - ???
** <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.
 
==Suggested commands==
 
The following commands are community suggestions and are not presently featured in Steam:
===Connect protocol===
* '''<code>steam://connect/<IP or DNS name>[:port]/<password></code>'''
**Connects to the specified server with the right password --[[User:Semi|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. --[[User:pumakuma|pumakuma]]
* '''<code>steam://connect/<IP or DNS name>[:port]/'command1 "arg1" "arg2";command2 "arg1";password "blah";etc..'</code>'''
**Connects to the specified server after executing the specified commands --[[User:ts2do|ts2do]]
**An alternate syntax which makes more sense if you're familiar with HTTP URL syntax:  '''<code>steam://connect/<IP or DNS name>[:port]/?cvar1=value&cvar2=value&password=blah&etc..</code>''' --[[User:The MAZZTer|The MAZZTer]] 21:03, 31 Jul 2008 (PDT)
**A similar syntax could be: '''<code>steam://connect/?ip=<ip>:<port>&password=<password>&[[SourceTV|hltv]]=<true/false>&gamedetails=<true/false>&[[ConVar|cvars]]="<cvar1> <value>;<cvar2> <value>;"</code>''' 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. -- [[User:JRod|JRod]] 17:13, 22 Nov 2008 (PST)
* '''<code>steam://open/bandwidth</code>'''
** 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. --[[User:Gth|Gth]] 02:05, 13 March 2009 (UTC)
 
===Overlay Browser===
* '''<code>steam://overlay/<Website or Arguments From Steam://url></code>'''
**Opens the overlay ingame with the specified parameter, helpful for opening steam groups ingame so players can join. --[[User:DontWannaName|DontWannaName]]
*** Second this request, would be great for creating communities for/in L4D [[User:Captain-p0t-n00dle|Captain-p0t-n00dle]] 10:02, 10 May 2009 (UTC)
 
===Other===
* '''<code>steam://vdc/<page title></code>'''
**Open title page on the VDC. -- [[User:AiusEpsi|AiusEpsi]] and [[User:ts2do|ts2do]]
***Why would this be useful? We already have <code>'''steam://openurl/<url>'''</code>. -- [[User:WildCat|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 --[[User:Alph Tech STUART|Alph Tech STUART]] 17:13, 9 Jun 2006 (PDT).
* '''<code>steam://gameinfo/<IP or DNS name>[:port]</code>'''
**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. --[[User:Koraktor|Koraktor]]
::: Appreciated -[[User:Rotzi|Rotzi]]
* '''<code>steam://runsingle/<AppID></code>'''
**Runs an app, then shuts down Steam once the game closes. -- [[User:AiusEpsi|AiusEpsi]]
***This is stupid. All Source games needs Steam open in order to do anything concerning gcf files, which is the game itself.--[[User:Sortie|Sortie]] 23:53, 5 Apr 2007 (PDT)
:::it shuts down steam AFTER the game ran and closed! [[User:Leopard84|Leopard84]]
* '''<code>steam://forceupdate/<AppID></code>'''
:: I don't get the point. Useless in my point of view. -[[User:Rotzi|Rotzi]]
**Forces update (if autoupdate fails) of all files (including all linked .gcf) for defined AppID. -- [[User:Dwarden|Dwarden]]
:Restarting Steam would be simpler, and have the same effect. --[[user:TomEdwards|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 -- [[User:Dwarden|Dwarden]]
:Yea, my steam REFUSES to update ANYTHING, even after re-installing it.  A force update would be nice. --[[user:PanFrie|PanFrie]] 04:50, 1 Feb 2008 (EST)
 
* '''<code>steam://checkbuild/<AppID></code>'''
**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.
 
[[Category:Steam]] [[Category:technical]] [[Category:Feedback]]

Revision as of 23:54, 10 June 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.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Steam_browser_protocol&oldid=119701"