Steam browser protocol: Difference between revisions
Jump to navigation
Jump to search
Note:If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.
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>{{ | **<code>{{SteamLinkTitled|steam://open/friends|friends}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://open/games|games}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://open/main|main}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://open/mymedia|mymedia}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://open/news|news}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://open/registerproduct|registerproduct}}</code> - Allows registering of keys from different games (e.g [[Prey]]) | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://open/servers|servers}}</code> | ||
**<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>{{ | **<code>{{SteamLinkTitled|steam://settings/account|account}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://settings/friends|friends}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://settings/interface|interface}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://settings/ingame|ingame}}</code> | ||
**<code>{{ | **<code>{{SteamLinkTitled|steam://settings/downloads|downloads}}</code> | ||
**<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>{{ | ** <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>{{ | ** <code>{{SteamLinkTitled|steam://url/LeaveGroupPage|LeaveGroupPage}}</code> | ||
** <code>{{ | ** <code>{{SteamLinkTitled|steam://url/steamIDControlPage|SteamIDControlPage}}</code> | ||
** <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>{{ | ** <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
steam:<commands>
Opens Steam with command line arguments, which can be found here.

steam://advertise/<id>
Opens up the store for an application.steam://ackMessage/ackGuestPass/<pass>
Accepts the 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://connect/<IP or DNS name>[:<port>]
Connects the user to the server specified by the IP or DNS name. You don't have to specify anything for connecting a third party mod server, it will be automaticly detected.- Example:
steam://connect/1.0.0.27:27015
- Example:
steam://connect/dns.server.com
- Example:
steam://defrag/<id>
Defragments files of the application.steam://friends/
add/<id>
- Adds user with specified id numberplayers
- Shows list of users with whom you recently playedjoinchat/<id>
- Joins a chat with a specified id numbermessage/<id>
-
steam://guestpasses/
Opens up the Guest Passes windowsteam://hardwarepromo/
Executes hardware promo method.- Example: steam://hardwarepromo/305 gets the products for this offer.
- Example: steam://hardwarepromo/609 gets the products for this offer.
steam://install/<id>
Installs an application.- Example: steam://install/8230 installs Sam & Max: Episode 4.
steam://installaddon/<addon>
Installs the specified add-on.- Example: steam://installaddon/halflifehd installs HL High-Def Pack.
steam://open/<component>
Opens a Steam window. Known <component> values:steam://openurl/<url>
Opens URL in default web browser.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
steam://run/<id>
Runs an application.steam://runsafe/<id>
Resets CVARs of an app.steam://settings/
Same assteam://open/settings
, but also allows for subcommands for each page:steam://store/<id>
Opens up the store for an app, if no app is specified then the default one is opened.steam://support/<params>
Launches the Steam Support utility, running all tests. Enter valid support string to filter results.steam://uninstall/<id>
Deletes the specified apps' cache files.steam://updatenews/<id>
Opens the news about the latest updates for an app.steam://url/<page>[/<params>]
Opens a specified Steam Community pageChatBanListAdmin/...
DownloadsSupportInfo
- Opens support.valvesoftware.com in your default browserGroupEventsPage/<id>
GroupSteamIDPage/<id>
GroupSteamIDAdmin/<id>
LeaveGroupPage
SteamIDControlPage
SteamIDEditPage
SteamIDLoginPage/...
- ???SteamIDPage/<id>
StoreFrontPage
- ???SupportFrontPage
- Opens support.valvesoftware.com in your default browser
steam://validate/<id>
Validates the GCFs of an app.
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>
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
steam://vdc/<page title>
- Open title page on the VDC. -- AiusEpsi and ts2do
- Why would this be useful? We already have
steam://openurl/<url>
. -- 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 --Alph Tech STUART 17:13, 9 Jun 2006 (PDT).
- Why would this be useful? We already have
- Open title page on the VDC. -- AiusEpsi and ts2do
steam://gameinfo/<IP or DNS name>[:port]
- 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. --Koraktor
- Appreciated -Rotzi
steam://runsingle/<AppID>
- it shuts down steam AFTER the game ran and closed! Leopard84
steam://forceupdate/<AppID>
- 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.