Difference between revisions of "Steam browser protocol"
From Valve Developer Community
m |
m (→Implemented commands) |
||
(167 intermediate revisions by 58 users not shown) | |||
Line 1: | Line 1: | ||
− | There are | + | 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). |
− | + | == 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> | |
− | * | + | ; <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://browsemedia</nowiki></code> | |
− | + | ; <code><nowiki>steam://checksysreqs/<id></nowiki></code> | |
− | * | + | : Checks if users computer meets system requirements of app. |
− | + | ; <code><nowiki>steam://connect/<IP or DNS name>[:<port>][/<password>]</nowiki></code> | |
− | + | : Connects the user to the server specified by the IP or [[Wikipedia:DNS|DNS name]]. You don't have to specify anything else to connect to a third party mod server, everything will be automatically detected. | |
− | + | :* Example: <code><nowiki>steam://connect/1.0.0.27:27015</nowiki></code> | |
− | + | :* Example: <code><nowiki>steam://connect/:27015</nowiki></code> | |
− | + | :* Example: <code><nowiki>steam://connect/dns.server.com</nowiki></code> | |
− | + | ; <code><nowiki>steam://defrag/<id></nowiki></code> | |
− | + | : Defragments files of the application. | |
− | + | ; <code><nowiki>steam://ExitSteam</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 | |
− | [[Category:Steam]] | + | :; <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/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://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. | ||
+ | :* Example: <code><nowiki>steam://hardwarepromo/305</nowiki></code> ([http://www.steampowered.com/ati_offer1a/ ATi]) | ||
+ | :* Example: <code><nowiki>steam://hardwarepromo/609</nowiki></code> ([http://www.steampowered.com/nvidia1/ nVidia]) | ||
+ | ; <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://nav/<component></nowiki></code> | ||
+ | : Opens a Steam window, but doesn't make the Steam window active. Known <component> values: | ||
+ | :; <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>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>tools</code> | ||
+ | :; <code>screenshots</code> | ||
+ | :; <code>servers</code> | ||
+ | :; <code>settings</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. | ||
+ | ; <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>CommunitySearch/</code> | ||
+ | :; <code>DownloadsSupportInfo</code> | ||
+ | :; <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>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>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. | ||
+ | [[Category:Steam]] [[Category:technical]] |
Latest revision as of 21:26, 11 December 2019
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
-
steam:"<commands>"
- Opens Steam with command line arguments, which can be found here.

-
steam://AddNonSteamGame
-
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://browsemedia
-
steam://checksysreqs/<id>
- Checks if users computer meets system requirements of app.
-
steam://connect/<IP or DNS name>[:<port>][/<password>]
- Connects the user to the server specified by the IP or DNS name. You don't have to specify anything else to connect to a third party mod server, everything will be automatically detected.
- Example:
steam://connect/1.0.0.27:27015
- Example:
steam://connect/:27015
- Example:
steam://connect/dns.server.com
- Example:
-
steam://defrag/<id>
- Defragments files of the application.
-
steam://ExitSteam
- 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/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://guestpasses/
- Opens up the Guest Passes window.
-
steam://hardwarepromo/
- Tests whether the user has hardware that matches a promotional offer.
-
steam://install/<id>
- Installs an application.
- Example:
steam://install/8230
installs Sam & Max: Episode 4.
- Example:
-
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.
- Example:
-
steam://musicplayer/<command>
- Commands related to the Steam music player.
-
play
-
pause
-
toggleplaypause
-
playprevious
-
playnext
-
togglemute
-
increasevolume
-
decreasevolume
-
toggleplayingrepeatstatus
-
toggleplayingshuffled
-
-
steam://nav/<component>
- Opens a Steam window, but doesn't make the Steam window active. Known <component> values:
-
downloads
-
games
-
games/details
-
games/details/<id>
-
games/grid
-
games/list
-
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)
-
tools
-
screenshots
-
servers
-
settings
-
-
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
orvalve
. -
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
- 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:-
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
- 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/...
-
CommentNotifications
-
CommunityFilePage/<id>
- Opens a Workshop/Greenlight submission.
-
CommunityFriendsThatPlay/<id>
-
CommunityGroupSearch/<search term>
-
CommunityHome/
-
CommunitySearch/
-
DownloadsSupportInfo
-
FamilySharing
- Opens the Manage Family Library Sharing page from Store -> Account.
-
GameHub/<app ID>
-
GroupEventsPage/<id>
-
GroupSteamIDPage/<id>
-
GroupSteamIDAdmin/<id>
-
LeaveGroupPage
-
LegalInformation
-
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>
-
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.