Help:URLs

From XfireWiki

Jump to: navigation, search

URL = Uniform Resource Locator


This help page belongs to Help category Advanced

Contents

Xfire URLs

What are Xfire URLs?

Xfire installs itself as a handler for the xfire: URL protocol in Windows. This means that all links that start with xfire: will be handled by the Xfire program. This allows you to create links on web sites for people to add you as a friend, to join a game server, or to set your own Xfire text status.

Xfire URLs for public

These are the Xfire URLs that are for all people to use:

xfire:add_friend?user=<username>
Opens the Add friend dialog in Xfire with the specified <username> filled in.
xfire:add_friend?user=ownage
xfire:join?game=<shortname>&server=<ip address>:<port>
Directs Xfire to start the game and join the specified server. This only works if the user has the game in question properly installed and detected by Xfire and the game supports one-click joining.
xfire:join?game=ut2k4&server=192.168.0.1:7777
xfire:add_server?game=<shortname>&server=<ip address>:<port>
Similar to join command, this will add the specified server to your list of favorite servers so you can access it later from your servers tab. The favorite server will also be displayed on your profile page if your privacy options allow it.
xfire:add_server?game=ut2k4&server=192.168.0.1:7777
xfire:status?text=<text>
Set you a custom status message in Xfire. If you leave the <text> empty, the status will be reset to online. The text must be URL encoded in UTF-8 format. If you use it as a link in a web page, the browser will do the conversion for you automatically when you click the link. If you are creating a program that will pass this command to change your status message, you will need to convert the ANSI formatted string first. See URLEncode for instructions.
xfire:status?text=My%20custom%20status
xfire:game_stats?game=<shortname>&<key>=<value>
Sets extra info to your infoview that is shown to your friends. The <shortname> must match the ShortName property of the game you are currently playing. <key> is the information name you want to be shown and <value> is the value that is shown for the key.
xfire:game_stats?game=winsol&Scoring=Vegas
xfire:skin?name=<skinname>
Changes the active skin of Xfire. The <skinname> is the name of the skin as it appears in the skins menu (Tools -> skin). If there is no skin installed that matches the <skinname>, Xfire will remain using its current active skin.
xfire:skin?name=standard

Xfire URLs for Xfire itself

These are the Xfire URLs Xfire team uses to provide more functionality from the website.

xfire:download?id=<fileid>
Adds file to active downloads in your Xfire program.
xfire:download?id=2016
xfire:add_channel?id=<chanid>
Adds a file channel to your files tab in Xfire. This will make all new files in that channel automatically downloaded unless you remove the channel.
xfire:add_channel?id=10001
xfire:remove_channel?id=<chanid>
Remvoes a file channel from your files tab in Xfire. This will prevent the files added to the channel automatically downloaded unless you add the channel again or manually select files to be downloaded.
xfire:remove_channel?id=10001
xfire:get_game_rig
Instructs Xfire program to start DirectX Diagnostics tool to gather information about the computer and send the log file to Xfire site. This is used with the Gaming Rig upload link.
xfire:get_game_rig
xfire:chat?room=<roomid>
Makes Xfire program to join specified group chat room. The roomid is the 42 characters long hex string associated with the chat room. This is used to allow joining video-specific chat rooms in Video broadcast page.

See also

Personal tools