Steam browser protocol: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(→‎Connect protocol: remove password as implemented)
(badly moved multipage rest of page history at Archived Page History/Steam browser protocol/en)
 
(59 intermediate revisions by 32 users not shown)
Line 1: Line 1:
{{LanguageBar}}
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).
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).


{{warning|Some commands are no longer functional, and some commands might be missing on this list.}}
Also see [https://revuln.com/files/ReVuln_Steam_Browser_Protocol_Insecurity.pdf "Steam Browser Protocol Insecurity (When Local Bugs Go Remote)"]
== Implemented commands ==
== Implemented commands ==


* '''<code>steam:<commands></code>''' Opens Steam with command line arguments, [[Command_Line_Options#Steam_(Windows)|which can be found here]].
; <code><nowiki>steam:"<commands>"</nowiki></code>
{{note|If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.}}
: Opens Steam with command line arguments, [[Command Line Options#Steam (Windows)|which can be found here]].
* '''<code>steam://advertise/<id></code>''' Opens up the store for an application.
{{note|If you forget the closing quote for a steam:"<command>", an assertion failed error will be raised by Steam.exe/BootStrapperApp.cpp.}}
* '''<code>steam://ackMessage/ackGuestPass/<pass></code>''' Accepts the Gift or Guest Pass.
; <code><nowiki>steam://AddNonSteamGame</nowiki></code>
* '''<code>steam://appnews/<id></code>''' Opens up the news page for an app.
: Opens the Steam checklist menu to add non-Steam games.
* '''<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.
{{note|If you would like to programmatically add or remove non-Steam games, see [[Add Non-Steam Game|Adding Non-Steam Games]]}}
* '''<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.
; <code><nowiki>steam://advertise/<id></nowiki></code>
**Example: <code>steam://connect/1.0.0.27:27015</code>
: Opens the store to an application's page.
**Example: <code>steam://connect/dns.server.com</code>
; <code><nowiki>steam://ackMessage/ackGuestPass/<pass></nowiki></code>
* '''<code>steam://defrag/<id></code>''' Defragments files of the application.
: Accepts the specified Gift or Guest Pass.
* '''<code>steam://friends/</code>'''
; <code><nowiki>steam://appnews/<id></nowiki></code>
**<code>add/<id></code> - Adds user with specified id number
: Opens up the news page for an app.
**<code>players</code> - Shows list of users with whom you recently played
; <code><nowiki>steam://backup/<id></nowiki></code>
**<code>joinchat/<id></code> - Joins a chat with a specified id number
: Opens up the Backup Wizard and checks the specified application. If an application is not specified then nothing will be checked.
**<code>message/<id></code> -
; <code><nowiki>steam://broadcast/watch/<steamid64></nowiki></code>
* '''<code>{{SteamLink|steam://guestpasses/}}</code>''' Opens up the Guest Passes window
; <code><nowiki>steam://browsemedia</nowiki></code>
* '''<code>steam://hardwarepromo/</code>''' Executes hardware promo method.
; <code><nowiki>steam://cdkeys/<appid></nowiki></code>
**Example: {{SteamLink|steam://hardwarepromo/305}} gets the products for [http://www.steampowered.com/ati_offer1a/ this offer].
; <code><nowiki>steam://checksysreqs/<id></nowiki></code>
**Example: {{SteamLink|steam://hardwarepromo/609}} gets the products for [http://www.steampowered.com/nvidia1/ this offer].
: Checks if users computer meets system requirements of app.
* '''<code>steam://install/<id></code>''' Installs an application.
; <code><nowiki>steam://connect/<IP>[:<port>][/<password>]</nowiki></code>
**Example: {{SteamLink|steam://install/8230}} installs [http://steampowered.com/v/index.php?area=game&AppId=8230 Sam & Max: Episode 4].
: Connects the user to the server specified by the IP. You don't have to specify anything else to connect to a third party mod server, everything will be automatically detected.
* '''<code>steam://installaddon/<addon></code>''' Installs the specified add-on.
{{note|DNS names no longer work here}}
**Example: {{SteamLink|steam://installaddon/halflifehd}} installs HL High-Def Pack.
:* Example: <code><nowiki>steam://connect/192.0.2.1:27015</nowiki></code>
* '''<code>steam://open/<component></code>''' Opens a Steam window. Known <component> values:
:* Example: <code><nowiki>steam://connect/:27015</nowiki></code>
**<code>{{SteamLinkTitled|steam://open/friends|friends}}</code>
; <code><nowiki>steam://controllerconfig/<id></nowiki></code>
**<code>{{SteamLinkTitled|steam://open/games|games}}</code>
: Opens the controller configurator (Steam Input) for the specified game.
**<code>{{SteamLinkTitled|steam://open/main|main}}</code>
; <code><nowiki>steam://defrag/<id></nowiki></code>
**<code>{{SteamLinkTitled|steam://open/mymedia|mymedia}}</code>
: Defragments files of the application.
**<code>{{SteamLinkTitled|steam://open/news|news}}</code>
; <code><nowiki>steam://exit</nowiki></code>
**<code>{{SteamLinkTitled|steam://open/registerproduct|registerproduct}}</code> - Allows registering of keys from different games (e.g [[Prey]])
: Exits the Steam application.
**<code>{{SteamLinkTitled|steam://open/tools|tools}}</code>
; <code><nowiki>steam://friends/</nowiki></code>
**<code>{{SteamLinkTitled|steam://open/servers|servers}}</code>
: Opens Friends. These sub-commands are accepted:
**<code>{{SteamLinkTitled|steam://open/settings|settings}}</code>
:; <code>add/<id></code>
* '''<code>steam://openurl/<url></code>''' Opens URL in default web browser.
:: Adds user with specified id number
* '''<code>steam://paypal/cancel</code>''' Cancels an ongoing PayPal transaction.
:; <code>friends/<id></code>
* '''<code>steam://preload/<id></code>''' Preloads an application.
:: Shows list of users with whom you recently played
* '''<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>joinchat/<id></code>
* '''<code>steam://purchase/<id></code>''' Opens a dialog box to buy an application from Steam.
:: Joins a chat with a specified id number
* '''<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>message/<id></code>
* '''<code>steam://removeaddon/<addon></code>''' Uninstalls the specified add-on.
:: Send a message
**Example: {{SteamLink|steam://removeaddon/halflifehd}} uninstalls HL High-Def Pack
:; <code>players</code>
* '''<code>steam://run/<id></code>''' Runs an application.
:: Shows table of recent players you've played with
* '''<code>steam://runsafe/<id></code>''' Resets CVARs of an app.
:; <code>settings/hideoffline</code>
* '''<code>{{SteamLink|steam://settings/}}</code>''' Same as <code>{{SteamLink|steam://open/settings}}</code>, but also allows for subcommands for each page:
:: Toggle offline friends from friends list
**<code>{{SteamLinkTitled|steam://settings/account|account}}</code>
:; <code>settings/showavatars</code>
**<code>{{SteamLinkTitled|steam://settings/friends|friends}}</code>
:: Toggle avatars in friends list
**<code>{{SteamLinkTitled|steam://settings/interface|interface}}</code>
:; <code>settings/sortbyname</code>
**<code>{{SteamLinkTitled|steam://settings/ingame|ingame}}</code>
:: Sorts friends list by name
**<code>{{SteamLinkTitled|steam://settings/downloads|downloads}}</code>
:; <code>status/away</code>
**<code>{{SteamLinkTitled|steam://settings/voice|voice}}</code>
:: Sets status as away
* '''<code>steam://store/<id></code>''' Opens up the store for an app, if no app is specified then the default one is opened.
:; <code>status/busy</code>
* '''<code>steam://support/<params></code>''' Launches the Steam Support utility, running all tests. Enter [[Steam Support strings|valid support string]] to filter results.
:: Sets status as busy
* '''<code>steam://uninstall/<id></code>''' Deletes the specified apps' cache files.
:; <code>status/invisible</code>
* '''<code>steam://updatenews/<id></code>''' Opens the news about the latest updates for an app.
:: Sets status as invisible
* '''<code>steam://url/<page>[/<params>]</code>''' Opens a specified Steam Community page
:; <code>status/trade</code>
** <code>ChatBanListAdmin/...</code>
:: Sets status as looking to trade
** <code>{{SteamLinkTitled|steam://url/DownloadsSupportInfo|DownloadsSupportInfo}}</code> - Opens support.valvesoftware.com in your default browser
:; <code>status/play</code>
** <code>GroupEventsPage/<id></code>
:: Sets status as looking to play
** <code>GroupSteamIDPage/<id></code>
:; <code>status/offline</code>
** <code>GroupSteamIDAdmin/<id></code>
:: Sets status as offline
** <code>{{SteamLinkTitled|steam://url/LeaveGroupPage|LeaveGroupPage}}</code>
:; <code>status/online</code>
** <code>{{SteamLinkTitled|steam://url/steamIDControlPage|SteamIDControlPage}}</code>
:: Sets status as online
** <code>{{SteamLinkTitled|steam://url/SteamIDEditPage|SteamIDEditPage}}</code>
; <code><nowiki>steam://flushconfig/</nowiki></code>
** <code>SteamIDLoginPage/...</code> - ???
: Flushes and reloads the configs for each application (beta availability, etc.)
** <code>SteamIDPage/<id></code>
; <code><nowiki>steam://forceinputappid/<id|shortcut name></nowiki></code>
** <code>{{SteamLinkTitled|steam://url/StoreFrontPage|StoreFrontPage}}</code> - Opens store homepage in Steam store tab.
: Forces the steam controller driver to use the layout for the given game or shortcut, without the need to use the in-game overlay, big picture mode, or even run the application at all.
** <code>{{SteamLinkTitled|steam://url/SupportFrontPage|SupportFrontPage}}</code> - Opens support.valvesoftware.com in your default browser
; <code><nowiki>steam://gameproperties/<id></nowiki></code>
* '''<code>steam://validate/<id></code>''' Validates the GCFs of an app.
: Opens the properties for the specified game.
 
; <code><nowiki>steam://guestpasses/</nowiki></code>
==Suggested commands==
: Opens up the Guest Passes window.
 
; <code><nowiki>steam://hardwarepromo/</nowiki></code>
The following commands are community suggestions and are not presently featured in Steam:
: Tests whether the user has hardware that matches a promotional offer. No longer works.
===Connect protocol===
:* Example: <code><nowiki>steam://hardwarepromo/305</nowiki></code> ([http://www.steampowered.com/ati_offer1a/ ATI/AMD], [http://web.archive.org/web/20071009200748/http://www.steampowered.com/ati_offer1a/ Archived])
* '''<code>steam://connect/<IP or DNS name>[:port]/'command1 "arg1" "arg2";command2 "arg1";password "blah";etc..'</code>'''
:* Example: <code><nowiki>steam://hardwarepromo/609</nowiki></code> ([http://www.steampowered.com/nvidia1/ Nvidia], [http://web.archive.org/web/20100726041716/http://www.steampowered.com:80/nvidia/ Archived])
**Connects to the specified server after executing the specified commands --[[User:ts2do|ts2do]]
; <code><nowiki>steam://install/<id></nowiki></code>
**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)
: Installs an application.
**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)
:* Example: <code><nowiki>steam://install/8230</nowiki></code> installs [http://steampowered.com/v/index.php?area=game&AppId=8230 Sam & Max: Episode 4].
* '''<code>steam://open/bandwidth</code>'''
; <code><nowiki>steam://installaddon/<addon></nowiki></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)
: Installs the specified add-on.
 
:* Example: <code><nowiki>steam://installaddon/halflifehd</nowiki></code> installs HL High-Def Pack.
===Overlay Browser===
:* Example: <code><nowiki>steam://installaddon/hl2russian</nowiki></code> installs HL2 Russian Pack.
* '''<code>steam://overlay/<Website or Arguments From Steam://url></code>'''
; <code><nowiki>steam://musicplayer/<command></nowiki></code>
**Opens the overlay ingame with the specified parameter, helpful for opening steam groups ingame so players can join. --[[User:DontWannaName|DontWannaName]]
: Commands related to the Steam music player.
*** 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)
:; <code>play</code>
 
:; <code>pause</code>
===Other===
:; <code>toggleplaypause</code>
* '''<code>steam://runadv/<AppID> <parameters></code>'''
:; <code>playprevious</code>
**Runs an app allowing you to specify advanced parameters like -windowed. -[[User:ultradude25|ultradude25]]
:; <code>playnext</code>
* '''<code>steam://vdc/<page title></code>'''
:; <code>togglemute</code>
**Open title page on the VDC. -- [[User:AiusEpsi|AiusEpsi]] and [[User:ts2do|ts2do]]
:; <code>increasevolume</code>
***Why would this be useful? We already have <code>'''steam://openurl/<url>'''</code>. -- [[User:WildCat|WildCat]]
:; <code>decreasevolume</code>
****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>toggleplayingrepeatstatus</code>
* '''<code>steam://gameinfo/<IP or DNS name>[:port]</code>'''
:; <code>toggleplayingshuffled</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]]
; <code><nowiki>steam://launch/<id></nowiki></code>
::: Appreciated -[[User:Rotzi|Rotzi]]
: Same as <code>run</code>, but with support for multiple launch options.
* '''<code>steam://runsingle/<AppID></code>'''
:; <code><nowiki>steam://launch/<id>/dialog</nowiki></code>
**Runs an app, then shuts down Steam once the game closes. -- [[User:AiusEpsi|AiusEpsi]]
:: Launches the game using the user's preferred launch option, or asks which to use.
***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)
; <code><nowiki>steam://nav/<component></nowiki></code>
:::it shuts down steam AFTER the game ran and closed! [[User:Leopard84|Leopard84]]
: Opens a Steam window, but doesn't make the Steam window active. Known <component> values:
* '''<code>steam://forceupdate/<AppID></code>'''
:; <code>console</code>
:: I don't get the point. Useless in my point of view. -[[User:Rotzi|Rotzi]]
:; <code>downloads</code>
**Forces update (if autoupdate fails) of all files (including all linked .gcf) for defined AppID. -- [[User:Dwarden|Dwarden]]
:; <code>games</code>
:Restarting Steam would be simpler, and have the same effect. --[[user:TomEdwards|TomEdwards]] 08:23, 13 Sep 2006 (PDT)
:; <code>games/details</code>
: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]]
:; <code>games/details/<nowiki><id></nowiki></code>
: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>games/grid</code>
* '''<code>steam://friends/message/<id OR username></code>'''
:; <code>games/list</code>
**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.
:; <code>library/collection/hidden</code>
 
:; <code>media</code>
* '''<code>steam://checkbuild/<AppID></code>'''
:; <code>music</code>
**Compares actual local build of AppID with latest version available at Steam servers for defined AppID.
:; <code>tools</code>
**Results displayed in way: '<AppID> - <ActualLocalBuild>:<LatestBuildAtSteamServers>
; <code><nowiki>steam://open/<component></nowiki></code>
** and if they not match it offers user dialog to force update to latest build.
: Opens a Steam window. Known <component> values:
 
:; <code>activateproduct</code>
[[Category:Steam]] [[Category:technical]] [[Category:Feedback]]
:; <code>bigpicture</code>
:; <code>console</code>
:: The steam developer console
:; <code>downloads</code>
:; <code>friends</code>
:; <code>games</code>
;; <code>games/details</code>
;; <code>games/grid</code>
;; <code>games/list</code>
;; <code>largegameslist</code>
;; <code>minigameslist</code>
:; <code>main</code>
:: Your "favorite window".
:; <code>music</code>
:; <code>musicplayer</code>
:; <code>mymedia</code>
:; <code>news</code>
:; <code>registerproduct</code>
:: CD key registration (e.g [[Prey]])  
:; <code>screenshots/<gameid></code>
:; <code>servers</code>
:; <code>settings</code>
:; <code>tools</code>
; <code><nowiki>steam://openurl/<url></nowiki></code>
: Opens URL in the system's default web browser.
; <code><nowiki>steam://openurl_external/<url></nowiki></code>
; <code><nowiki>steam://paypal/cancel</nowiki></code>
: Cancels an ongoing PayPal transaction.
; <code><nowiki>steam://preload/<id></nowiki></code>
: Preloads an application.
; <code><nowiki>steam://publisher/<name></nowiki></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><nowiki>steam://purchase/<id></nowiki></code>
: Opens a dialog box to buy an application from Steam.
; <code><nowiki>steam://purchase/subscription/<id></nowiki></code>
: Opens up a dialog box to buy a subscription to a Steam product/service. None are available yet.
; <code><nowiki>steam://removeaddon/<addon></nowiki></code>
: Uninstalls the specified add-on.
:* Example: <code><nowiki>steam://removeaddon/halflifehd</nowiki></code> uninstalls HL High-Def Pack
; <code><nowiki>steam://run/<id>//<args>/</nowiki></code>
: Runs an application. It will be installed if necessary.
: The <code><nowiki>//<args></nowiki></code> is optional, args are passed to the application as launch parameters.
; <code><nowiki>steam://runsafe/<id></nowiki></code>
: Resets CVARs of a Source game.
; <code><nowiki>steam://rungameid/<id></nowiki></code>
: Same as <code>run</code>, but with support for mods and non-Steam shortcuts.
; <code><nowiki>steam://settings/</nowiki></code>
: Same as <code><nowiki>steam://open/settings</nowiki></code>, but also allows for subcommands for each page:
:; <code>account</code>
:; <code>friends</code>
:; <code>interface</code>
:; <code>ingame</code>
:; <code>downloads</code>
:; <code>voice</code>
; <code><nowiki>steam://stopstreaming</nowiki></code>
: Stops a currently running in-home streaming session
; <code><nowiki>steam://store/<id></nowiki></code>
: Opens up the store for an app, if no app is specified then the default one is opened.
; <code><nowiki>steam://subscriptioninstall/<id1>/<id2>/...</nowiki></code>
: Opens a dialog box with a checklist of the games specified allowing you to install them all at once.
; <code><nowiki>steam://support/<params></nowiki></code>
: Launches the Steam Support utility, and runs all of its tests. Enter a [[Steam Support strings|valid support string]] to filter results.
<code><nowiki>steam://takesurvey/<id></nowiki></code>
: Takes a survey.
:* Example: <code><nowiki>steam://takesurvey/1</nowiki></code>
; <code><nowiki>steam://uninstall/<id></nowiki></code>
: Deletes the specified apps' cache files.
; <code><nowiki>steam://UpdateFirmware</nowiki></code>
: Opens the Steam Controller firmware update screen.
; <code><nowiki>steam://updatenews/<id></nowiki></code>
: Opens the news about the latest updates for an app.
<span id="NamedPages"></span>
; <code><nowiki>steam://url/<named page></nowiki></code>
: Opens a special, named web pages:
:; <code>ChatBanListAdmin/...</code>
;; <code>CommentNotifications</code>
;; <code>CommunityFilePage/<nowiki><id></nowiki></code>
:: Opens a Workshop/Greenlight submission.
;; <code>CommunityFriendsThatPlay/<nowiki><id></nowiki></code>
;; <code>CommunityGroupSearch/<nowiki><search term></nowiki></code>
;; <code>CommunityHome/</code>
;; <code>CommunityInventory</code>
;; <code>CommunitySearch/</code>
:; <code>DownloadsSupportInfo</code>
;; <code>EventAnnouncementPage/<appid>/<nowiki><EventAnnouncementID></nowiki></code>
:: https://store.steampowered.com/news/app/593110/view/2173495126269399731
:; <code>FamilySharing</code>
:: Opens the Manage Family Library Sharing page from Store -> Account.
:; <code>GameHub/<nowiki><app ID></nowiki></code>
:; <code>GroupEventsPage/<id></code>
:; <code>GroupSteamIDPage/<id></code>
:; <code>GroupSteamIDAdmin/<id></code>
:; <code>LeaveGroupPage</code>
:; <code>LegalInformation</code>
:; <code>MyHelpRequests</code>
:: Opens your recent steam support requests
:; <code>ParentalSetup</code>
:: Opens the Family View page from Store -> Account.
:; <code>PrivacyPolicy</code>
:; <code>SSA</code>
:; <code>SteamIDAchievementsPage/<nowiki><id></nowiki></code>
:; <code>SteamIDControlPage</code>
:; <code>SteamIDEditPage</code>
:; <code>SteamIDFriendsPage</code>
:; <code>SteamIDLoginPage/<pass></code>
:: Opens the internal automatic sign in page. It won't work unless the correct one-time password is specified.
:; <code>SteamIDMyProfile</code>
:; <code>SteamIDPage/<nowiki><id></nowiki></code>
:; <code>SteamWorkshop</code>
:; <code>SteamWorkshopPage/<id></code>
:; <code>SteamGreenlight</code>
:; <code>Store</code>
:; <code>StoreAccount</code>
:; <code>StoreAppPage/<nowiki><app ID></nowiki></code>
:; <code>StoreDLCPage/<nowiki><app ID></nowiki></code>
:: Opens the store page showing all DLC available for the provided app id
:; <code>StoreCart</code>
:; <code>Storefront</code>
:; <code>StoreFrontPage</code>
:: Opens store homepage in Steam store tab.
:; <code>SupportFrontPage</code>
:: Opens [https://support.steampowered.com/ support.steampowered.com] in your default browser.
; <code><nowiki>steam://validate/<id></nowiki></code>
: Validates the local files of an app.
; <code><nowiki>steam://viewfriendsgame/<64ID></nowiki></code>
: Views friends game
[[Category:Steam]] [[Category:technical]]

Latest revision as of 06:43, 14 July 2024

English (en)Translate (Translate)

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

Warning.pngWarning:Some commands are no longer functional, and some commands might be missing on this list.

Also see "Steam Browser Protocol Insecurity (When Local Bugs Go Remote)"

Implemented commands

steam:"<commands>"
Opens Steam with command line arguments, which can be found here.
Note.pngNote:If you forget the closing quote for a steam:"<command>", an assertion failed error will be raised by Steam.exe/BootStrapperApp.cpp.
steam://AddNonSteamGame
Opens the Steam checklist menu to add non-Steam games.
Note.pngNote:If you would like to programmatically add or remove non-Steam games, see Adding Non-Steam Games
steam://advertise/<id>
Opens the store to an application's page.
steam://ackMessage/ackGuestPass/<pass>
Accepts the specified 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://broadcast/watch/<steamid64>
steam://browsemedia
steam://cdkeys/<appid>
steam://checksysreqs/<id>
Checks if users computer meets system requirements of app.
steam://connect/<IP>[:<port>][/<password>]
Connects the user to the server specified by the IP. You don't have to specify anything else to connect to a third party mod server, everything will be automatically detected.
Note.pngNote:DNS names no longer work here
  • Example: steam://connect/192.0.2.1:27015
  • Example: steam://connect/:27015
steam://controllerconfig/<id>
Opens the controller configurator (Steam Input) for the specified game.
steam://defrag/<id>
Defragments files of the application.
steam://exit
Exits the Steam application.
steam://friends/
Opens Friends. These sub-commands are accepted:
add/<id>
Adds user with specified id number
friends/<id>
Shows list of users with whom you recently played
joinchat/<id>
Joins a chat with a specified id number
message/<id>
Send a message
players
Shows table of recent players you've played with
settings/hideoffline
Toggle offline friends from friends list
settings/showavatars
Toggle avatars in friends list
settings/sortbyname
Sorts friends list by name
status/away
Sets status as away
status/busy
Sets status as busy
status/invisible
Sets status as invisible
status/trade
Sets status as looking to trade
status/play
Sets status as looking to play
status/offline
Sets status as offline
status/online
Sets status as online
steam://flushconfig/
Flushes and reloads the configs for each application (beta availability, etc.)
steam://forceinputappid/<id|shortcut name>
Forces the steam controller driver to use the layout for the given game or shortcut, without the need to use the in-game overlay, big picture mode, or even run the application at all.
steam://gameproperties/<id>
Opens the properties for the specified game.
steam://guestpasses/
Opens up the Guest Passes window.
steam://hardwarepromo/
Tests whether the user has hardware that matches a promotional offer. No longer works.
steam://install/<id>
Installs an application.
steam://installaddon/<addon>
Installs the specified add-on.
  • Example: steam://installaddon/halflifehd installs HL High-Def Pack.
  • Example: steam://installaddon/hl2russian installs HL2 Russian Pack.
steam://musicplayer/<command>
Commands related to the Steam music player.
play
pause
toggleplaypause
playprevious
playnext
togglemute
increasevolume
decreasevolume
toggleplayingrepeatstatus
toggleplayingshuffled
steam://launch/<id>
Same as run, but with support for multiple launch options.
steam://launch/<id>/dialog
Launches the game using the user's preferred launch option, or asks which to use.
steam://nav/<component>
Opens a Steam window, but doesn't make the Steam window active. Known <component> values:
console
downloads
games
games/details
games/details/<id>
games/grid
games/list
library/collection/hidden
media
music
tools
steam://open/<component>
Opens a Steam window. Known <component> values:
activateproduct
bigpicture
console
The steam developer console
downloads
friends
games
games/details
games/grid
games/list
largegameslist
minigameslist
main
Your "favorite window".
music
musicplayer
mymedia
news
registerproduct
CD key registration (e.g Prey)
screenshots/<gameid>
servers
settings
tools
steam://openurl/<url>
Opens URL in the system's default web browser.
steam://openurl_external/<url>
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: steam://removeaddon/halflifehd uninstalls HL High-Def Pack
steam://run/<id>//<args>/
Runs an application. It will be installed if necessary.
The //<args> is optional, args are passed to the application as launch parameters.
steam://runsafe/<id>
Resets CVARs of a Source game.
steam://rungameid/<id>
Same as run, but with support for mods and non-Steam shortcuts.
steam://settings/
Same as steam://open/settings, but also allows for subcommands for each page:
account
friends
interface
ingame
downloads
voice
steam://stopstreaming
Stops a currently running in-home streaming session
steam://store/<id>
Opens up the store for an app, if no app is specified then the default one is opened.
steam://subscriptioninstall/<id1>/<id2>/...
Opens a dialog box with a checklist of the games specified allowing you to install them all at once.
steam://support/<params>
Launches the Steam Support utility, and runs all of its tests. Enter a valid support string to filter results.

steam://takesurvey/<id>

Takes a survey.
  • Example: steam://takesurvey/1
steam://uninstall/<id>
Deletes the specified apps' cache files.
steam://UpdateFirmware
Opens the Steam Controller firmware update screen.
steam://updatenews/<id>
Opens the news about the latest updates for an app.

steam://url/<named page>
Opens a special, named web pages:
ChatBanListAdmin/...
CommentNotifications
CommunityFilePage/<id>
Opens a Workshop/Greenlight submission.
CommunityFriendsThatPlay/<id>
CommunityGroupSearch/<search term>
CommunityHome/
CommunityInventory
CommunitySearch/
DownloadsSupportInfo
EventAnnouncementPage/<appid>/<EventAnnouncementID>
https://store.steampowered.com/news/app/593110/view/2173495126269399731
FamilySharing
Opens the Manage Family Library Sharing page from Store -> Account.
GameHub/<app ID>
GroupEventsPage/<id>
GroupSteamIDPage/<id>
GroupSteamIDAdmin/<id>
LeaveGroupPage
LegalInformation
MyHelpRequests
Opens your recent steam support requests
ParentalSetup
Opens the Family View page from Store -> Account.
PrivacyPolicy
SSA
SteamIDAchievementsPage/<id>
SteamIDControlPage
SteamIDEditPage
SteamIDFriendsPage
SteamIDLoginPage/<pass>
Opens the internal automatic sign in page. It won't work unless the correct one-time password is specified.
SteamIDMyProfile
SteamIDPage/<id>
SteamWorkshop
SteamWorkshopPage/<id>
SteamGreenlight
Store
StoreAccount
StoreAppPage/<app ID>
StoreDLCPage/<app ID>
Opens the store page showing all DLC available for the provided app id
StoreCart
Storefront
StoreFrontPage
Opens store homepage in Steam store tab.
SupportFrontPage
Opens support.steampowered.com in your default browser.
steam://validate/<id>
Validates the local files of an app.
steam://viewfriendsgame/<64ID>
Views friends game
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Steam_browser_protocol&oldid=435702"