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.
Solokiller (talk | contribs) m (spam page) |
m (Robot: fixing template case.) |
||
| Line 18: | Line 18: | ||
**<code>joinchat/<id></code> - Joins a chat with a specified id number | **<code>joinchat/<id></code> - Joins a chat with a specified id number | ||
**<code>message/<id></code> - | **<code>message/<id></code> - | ||
* '''<code>{{ | * '''<code>{{SteamLink|steam://guestpasses/}}</code>''' Opens up the Guest Passes window | ||
* '''<code>steam://hardwarepromo/</code>''' Executes hardware promo method. | * '''<code>steam://hardwarepromo/</code>''' Executes hardware promo method. | ||
**Example: {{ | **Example: {{SteamLink|steam://hardwarepromo/305}} gets the products for [http://www.steampowered.com/ati_offer1a/ this offer]. | ||
**Example: {{ | **Example: {{SteamLink|steam://hardwarepromo/609}} gets the products for [http://www.steampowered.com/nvidia1/ this offer]. | ||
* '''<code>steam://install/<id></code>''' Installs an application. | * '''<code>steam://install/<id></code>''' Installs an application. | ||
**Example: {{ | **Example: {{SteamLink|steam://install/8230}} installs [http://steampowered.com/v/index.php?area=game&AppId=8230 Sam & Max: Episode 4]. | ||
* '''<code>steam://installaddon/<addon></code>''' Installs the specified add-on. | * '''<code>steam://installaddon/<addon></code>''' Installs the specified add-on. | ||
**Example: {{ | **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>{{steamlinktitled|steam://open/friends|friends}}</code> | **<code>{{steamlinktitled|steam://open/friends|friends}}</code> | ||
| Line 42: | Line 42: | ||
* '''<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 the specified add-on. | ||
**Example: {{ | **Example: {{SteamLink|steam://removeaddon/halflifehd}} uninstalls HL High-Def Pack | ||
* '''<code>steam://run/<id></code>''' Runs an application. | * '''<code>steam://run/<id></code>''' Runs an application. | ||
* '''<code>steam://runsafe/<id></code>''' Resets CVARs of an app. | * '''<code>steam://runsafe/<id></code>''' Resets CVARs of an app. | ||
* '''<code>{{ | * '''<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/account|account}}</code> | ||
**<code>{{steamlinktitled|steam://settings/friends|friends}}</code> | **<code>{{steamlinktitled|steam://settings/friends|friends}}</code> | ||
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.
Note:If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.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:Template:SteamlinktitledTemplate:SteamlinktitledTemplate:SteamlinktitledTemplate:SteamlinktitledTemplate:SteamlinktitledTemplate:Steamlinktitled- Allows registering of keys from different games (e.g Prey)Template:SteamlinktitledTemplate:Steamlinktitled
steam://openurl/<url>Opens URL in default web browser.steam://paypal/cancelCancels 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/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/...Template:Steamlinktitled- Opens support.valvesoftware.com in your default browserGroupEventsPage/<id>GroupSteamIDPage/<id>GroupSteamIDAdmin/<id>Template:SteamlinktitledTemplate:SteamlinktitledTemplate:SteamlinktitledSteamIDLoginPage/...- ???SteamIDPage/<id>StoreFrontPage- ???Template:Steamlinktitled- 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.