Steam browser protocol: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
Line 37: Line 37:
Its a pretty open and powerful system. A website link can start up steam and not only change any [[ConVar]] of a user, but it can also execute [[ConCommand]]s like making a player join a specific server running a specific mod. It can even get the player to start up a dedicated server with a single click.
Its a pretty open and powerful system. A website link can start up steam and not only change any [[ConVar]] of a user, but it can also execute [[ConCommand]]s like making a player join a specific server running a specific mod. It can even get the player to start up a dedicated server with a single click.


Here some examples: (the wiki doesnt support them as links so copy / paste them with quotationmarks into a new browser window)
Here some examples:


'''steam:"-applaunch 70 -game "your_mod" +map "yourmap""''' - This starts up Half-Life running your_mod and loading a map called yourmap.bsp.
'''steam:"-applaunch 70 -game "<mod>" +map "<map>""''' - This starts up [[Half-Life]] running the specified mod then loads a specified map.


'''steam:"-applaunch 320 -game "your_mod" +connect "76.184.78.81:27015""''' - This starts up Half-Life 2 DM running your_mod and joining the server with the IP 76.184.78.81 on port 27015. ''It is recommended that you use the <code>steam://connect/IP</code> command instead - see above.
'''steam://connect/<ip or dns name>[:port]"''' - If a mod was running at the specified server, Steam would attempt to start up that mod and connect there. This applies to any kind of [[Goldsource]]/[[Source]] server.


To view this browser based command system in action look at this [http://www.bgmod.com/index.php?module=servers server browser website] and click on one of the servers.
To view this browser based command system in action look at this [http://www.bgmod.com/index.php?module=servers server browser website] and click on one of the servers.


{{note|If you forget the closing quote on a steam:"%c" command, you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.}}
{{note|If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.}}
 
--[[User:Black Panther|Black Panther]] 07:31, 28 Jun 2005 (PDT)
originally posted by --X2cube 05:23, 15 Nov 2004 on the [http://www.hl2world.com/wiki/index.php hl2world wiki]


[[Category:Steam]] [[Category:technical]] [[Category:Feedback]]
[[Category:Steam]] [[Category:technical]] [[Category:Feedback]]

Revision as of 15:11, 15 April 2006

Commands

There are several 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.

Suggested

Ability

What can be done with these commands from a websites point of view? Its a pretty open and powerful system. A website link can start up steam and not only change any ConVar of a user, but it can also execute ConCommands like making a player join a specific server running a specific mod. It can even get the player to start up a dedicated server with a single click.

Here some examples:

steam:"-applaunch 70 -game "<mod>" +map "<map>"" - This starts up Half-Life running the specified mod then loads a specified map.

steam://connect/<ip or dns name>[:port]" - If a mod was running at the specified server, Steam would attempt to start up that mod and connect there. This applies to any kind of Goldsource/Source server.

To view this browser based command system in action look at this server browser website and click on one of the servers.

Note.pngNote:If you forget the closing quote on a steam:"<command>", you will get an assertion failed error from Steam.exe/BootStrapperApp.cpp.