Steam browser protocol: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
Warning:Some commands are no longer functional, and some commands might be missing on this list.
Note:If you forget the closing quote for a steam:"<command>", an assertion failed error will be raised by Steam.exe/BootStrapperApp.cpp.
Note:If you would like to programmatically add or remove non-Steam games, see Adding Non-Steam Games
Note:DNS names no longer work here
		
	
TomEdwards (talk | contribs) m (→Commands:  Alphabeticised)  | 
				 (badly moved multipage rest of page history at Archived Page History/Steam browser protocol/en)  | 
				||
| (153 intermediate revisions by 63 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).  | |||
{{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 ==  | |||
; <code><nowiki>steam:"<commands>"</nowiki></code>  | |||
: Opens Steam with command line arguments, [[Command Line Options#Steam (Windows)|which can be found here]].  | |||
{{note|If you forget the closing quote for a steam:"<command>", an assertion failed error will be raised by Steam.exe/BootStrapperApp.cpp.}}  | |||
; <code><nowiki>steam://AddNonSteamGame</nowiki></code>  | |||
: Opens the Steam checklist menu to add non-Steam games.  | |||
{{note|If you would like to programmatically add or remove non-Steam games, see [[Add Non-Steam Game|Adding Non-Steam Games]]}}  | |||
; <code><nowiki>steam://advertise/<id></nowiki></code>  | |||
: Opens the store to an application's page.  | |||
; <code><nowiki>steam://ackMessage/ackGuestPass/<pass></nowiki></code>  | |||
: Accepts the specified Gift or Guest Pass.  | |||
[[  | ; <code><nowiki>steam://appnews/<id></nowiki></code>  | ||
: Opens up the news page for an app.  | |||
; <code><nowiki>steam://backup/<id></nowiki></code>  | |||
: Opens up the Backup Wizard and checks the specified application. If an application is not specified then nothing will be checked.  | |||
; <code><nowiki>steam://broadcast/watch/<steamid64></nowiki></code>  | |||
; <code><nowiki>steam://browsemedia</nowiki></code>  | |||
; <code><nowiki>steam://cdkeys/<appid></nowiki></code>  | |||
; <code><nowiki>steam://checksysreqs/<id></nowiki></code>  | |||
: Checks if users computer meets system requirements of app.  | |||
; <code><nowiki>steam://connect/<IP>[:<port>][/<password>]</nowiki></code>  | |||
: 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|DNS names no longer work here}}  | |||
:* Example: <code><nowiki>steam://connect/192.0.2.1:27015</nowiki></code>  | |||
:* Example: <code><nowiki>steam://connect/:27015</nowiki></code>  | |||
; <code><nowiki>steam://controllerconfig/<id></nowiki></code>  | |||
: Opens the controller configurator (Steam Input) for the specified game.  | |||
; <code><nowiki>steam://defrag/<id></nowiki></code>  | |||
: Defragments files of the application.  | |||
; <code><nowiki>steam://exit</nowiki></code>  | |||
: Exits the Steam application.  | |||
; <code><nowiki>steam://friends/</nowiki></code>  | |||
: Opens Friends. These sub-commands are accepted:  | |||
:; <code>add/<id></code>  | |||
:: Adds user with specified id number  | |||
:; <code>friends/<id></code>  | |||
:: Shows list of users with whom you recently played  | |||
:; <code>joinchat/<id></code>  | |||
:: Joins a chat with a specified id number  | |||
:; <code>message/<id></code>  | |||
:: Send a message  | |||
:; <code>players</code>  | |||
:: Shows table of recent players you've played with  | |||
:; <code>settings/hideoffline</code>  | |||
:: Toggle offline friends from friends list  | |||
:; <code>settings/showavatars</code>  | |||
:: Toggle avatars in friends list  | |||
:; <code>settings/sortbyname</code>  | |||
:: Sorts friends list by name  | |||
:; <code>status/away</code>  | |||
:: Sets status as away  | |||
:; <code>status/busy</code>  | |||
:: Sets status as busy  | |||
:; <code>status/invisible</code>  | |||
:: Sets status as invisible  | |||
:; <code>status/trade</code>  | |||
:: Sets status as looking to trade  | |||
:; <code>status/play</code>  | |||
:: Sets status as looking to play  | |||
:; <code>status/offline</code>  | |||
:: Sets status as offline  | |||
:; <code>status/online</code>  | |||
:: Sets status as online  | |||
; <code><nowiki>steam://flushconfig/</nowiki></code>  | |||
: Flushes and reloads the configs for each application (beta availability, etc.)  | |||
; <code><nowiki>steam://forceinputappid/<id|shortcut name></nowiki></code>  | |||
: 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><nowiki>steam://gameproperties/<id></nowiki></code>  | |||
: Opens the properties for the specified game.  | |||
; <code><nowiki>steam://guestpasses/</nowiki></code>  | |||
: Opens up the Guest Passes window.  | |||
; <code><nowiki>steam://hardwarepromo/</nowiki></code>  | |||
: Tests whether the user has hardware that matches a promotional offer. No longer works.  | |||
:* 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])  | |||
:* 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])  | |||
; <code><nowiki>steam://install/<id></nowiki></code>  | |||
: Installs an application.  | |||
:* Example: <code><nowiki>steam://install/8230</nowiki></code> installs [http://steampowered.com/v/index.php?area=game&AppId=8230 Sam & Max: Episode 4].  | |||
; <code><nowiki>steam://installaddon/<addon></nowiki></code>  | |||
: Installs the specified add-on.  | |||
:* Example: <code><nowiki>steam://installaddon/halflifehd</nowiki></code> installs HL High-Def Pack.  | |||
:* Example: <code><nowiki>steam://installaddon/hl2russian</nowiki></code> installs HL2 Russian Pack.  | |||
; <code><nowiki>steam://musicplayer/<command></nowiki></code>  | |||
: Commands related to the Steam music player.  | |||
:; <code>play</code>  | |||
:; <code>pause</code>  | |||
:; <code>toggleplaypause</code>  | |||
:; <code>playprevious</code>  | |||
:; <code>playnext</code>  | |||
:; <code>togglemute</code>  | |||
:; <code>increasevolume</code>  | |||
:; <code>decreasevolume</code>  | |||
:; <code>toggleplayingrepeatstatus</code>  | |||
:; <code>toggleplayingshuffled</code>  | |||
; <code><nowiki>steam://launch/<id></nowiki></code>  | |||
: Same as <code>run</code>, but with support for multiple launch options.  | |||
:; <code><nowiki>steam://launch/<id>/dialog</nowiki></code>  | |||
:: Launches the game using the user's preferred launch option, or asks which to use.  | |||
; <code><nowiki>steam://nav/<component></nowiki></code>  | |||
: Opens a Steam window, but doesn't make the Steam window active. Known <component> values:  | |||
:; <code>console</code>  | |||
:; <code>downloads</code>  | |||
:; <code>games</code>  | |||
:; <code>games/details</code>  | |||
:; <code>games/details/<nowiki><id></nowiki></code>  | |||
:; <code>games/grid</code>  | |||
:; <code>games/list</code>  | |||
:; <code>library/collection/hidden</code>  | |||
:; <code>media</code>  | |||
:; <code>music</code>  | |||
:; <code>tools</code>  | |||
; <code><nowiki>steam://open/<component></nowiki></code>  | |||
: Opens a Steam window. Known <component> values:  | |||
:; <code>activateproduct</code>  | |||
:; <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 05:43, 14 July 2024
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).
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.
 
steam://AddNonSteamGame- Opens the Steam checklist menu to add 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://browsemediasteam://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.
 
- Example: 
steam://connect/192.0.2.1:27015 - Example: 
steam://connect/:27015 
- Example: 
 
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.
- Example: 
steam://install/8230installs Sam & Max: Episode 4. 
 - Example: 
 
steam://installaddon/<addon>- Installs the specified add-on.
- Example: 
steam://installaddon/halflifehdinstalls HL High-Def Pack. - Example: 
steam://installaddon/hl2russianinstalls HL2 Russian Pack. 
 - Example: 
 
steam://musicplayer/<command>- Commands related to the Steam music player.
playpausetoggleplaypauseplaypreviousplaynexttogglemuteincreasevolumedecreasevolumetoggleplayingrepeatstatustoggleplayingshuffled
 
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:
consoledownloadsgamesgames/detailsgames/details/<id>games/gridgames/listlibrary/collection/hiddenmediamusictools
 
steam://open/<component>- Opens a Steam window. Known <component> values:
activateproductbigpictureconsole- The steam developer console
 downloadsfriendsgamesgames/detailsgames/gridgames/listlargegameslistminigameslistmain- Your "favorite window".
 musicmusicplayermymedianewsregisterproduct- CD key registration (e.g Prey)
 screenshots/<gameid>serverssettingstools
 
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. 
activisionorvalve. 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/halflifehduninstalls HL High-Def Pack 
 - Example: 
 
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:accountfriendsinterfaceingamedownloadsvoice
 
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 
 - Example: 
 
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/...CommentNotificationsCommunityFilePage/<id>- Opens a Workshop/Greenlight submission.
 CommunityFriendsThatPlay/<id>CommunityGroupSearch/<search term>CommunityHome/CommunityInventoryCommunitySearch/DownloadsSupportInfoEventAnnouncementPage/<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>LeaveGroupPageLegalInformationMyHelpRequests- Opens your recent steam support requests
 ParentalSetup- Opens the Family View page from Store -> Account.
 PrivacyPolicySSASteamIDAchievementsPage/<id>SteamIDControlPageSteamIDEditPageSteamIDFriendsPageSteamIDLoginPage/<pass>- Opens the internal automatic sign in page. It won't work unless the correct one-time password is specified.
 SteamIDMyProfileSteamIDPage/<id>SteamWorkshopSteamWorkshopPage/<id>SteamGreenlightStoreStoreAccountStoreAppPage/<app ID>StoreDLCPage/<app ID>- Opens the store page showing all DLC available for the provided app id
 StoreCartStorefrontStoreFrontPage- 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