API2ItemWizard

Table of Contents Install Wizard Input Process Output

Install Wizard

This is used to get all items to checked if they are installed or not.

Input

URL

 * http://api.desura.com/2/itemwizard
 * http://api.desura.com/2/itemwizard/refresh (force a fresh version of the itemwizard)

Post

 * none

Process

 1. When wanting to check the users computer for installed mods and games this api is called
 1. Output data will be in a compressed form using bzip2 compression

Output

100: Example xml output

<?xml version="1.0" encoding="utf-8"?> 
<itemwizard xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="desura" version="2">
	<status code="0"/>
	<games>
		<game siteareaid="1">
			<name>Half&#45;Life</name>
			<nameid>half-life</nameid>
			<url>http://www.gamedev.com/games/half-life</url>
			<urledit>http://www.gamedev.com/games/edit/half-life</urledit>
			<urlpublish>http://www.gamedev.com/games/publish/half-life</urlpublish>
			<dlc>0</dlc>
			<downloadable>0</downloadable>
			<uploadable>0</uploadable>
			<mods>
				<mod siteareaid="3">
					<name>Sample Mod</name>
					<nameid>sample-mod</nameid>
					<url>http://www.gamedev.com/mods/sample-mod</url>
					<urledit>http://www.gamedev.com/mods/edit/sample-mod</urledit>
					<urlpublish>http://www.gamedev.com/mods/publish/sample-mod</urlpublish>
					<dlc>0</dlc>
					<downloadable>1</downloadable>
					<uploadable>1</uploadable>
				</mod> 				 
			</mods>			 
		</game>		 
	</games>
	<platforms>
		<platform id="100" name="windows">
			<games>
				<game siteareaid="1">
					<settings>
						<executes>
							<execute>
								<name>Play</name>
								<exe>%HALFLIFE_EXE%</exe>
								<args>args</args>
							</execute>
							<execute>
								<name>3</name>
								<exe>%STEAMEXE%</exe>
								<args>2</args>
							</execute>
						</executes>
						<installlocations>
							<installlocation>
								<check>%INSTALL_PATH%</check>
								<path>%INSTALL_PATH%</path>
							</installlocation>
						</installlocations>
					</settings>
					<wcards>
						<wcard name="SOURCE_SDK" type="exe">%STEAMAPPS%\source sdk base\hl2.exe</wcard>
						<wcard name="SOURCEMODS" type="path">%STEAMAPPS%\sourcemods</wcard>
						<wcard name="TEST" type="exe">%PARENT_INSTALL_PATH%\System\UT2004.exe</wcard>
					</wcards>
					<mods>
						<mod siteareaid="3">
							<settings>
								<executes>
									<execute>
										<name>Play</name>
										<exe>%HALFLIFE_EXE%</exe>
										<args>args</args>
									</execute>
									<execute>
										<name>3</name>
										<exe>%STEAMEXE%</exe>
										<args>2</args>
									</execute>
								</executes>
								<installlocations>
									<installlocation>
										<check>%INSTALL_PATH%</check>
										<path>%INSTALL_PATH%</path>
									</installlocation>
								</installlocations>
								<installcomplex>1</installcomplex>
								<installprimary>%INSTALL_PATH%\sven</installprimary>
							</settings>
							<wcards>
								<wcard name="MOD_INSTALL_PATH" type="path">%SOURCEMODS%\samplemod</wcard>
								<wcard name="CYCLICAL1" type="path">test</wcard>
								<wcard name="CYCLICAL" type="path">%CYCLICAL1%</wcard>
							</wcards>
						</mod> 				 
					</mods>			 
				</game>		 
			</games>	 
			<wcards>		 
				<wcard name="PROGRAM_FILES" type="special">PROGRAM_FILES</wcard>		 
				<wcard name="DOCUMENTS" type="special">DOCUMENTS</wcard>		 
				<wcard name="APPLICATION" type="special">APPLICATION</wcard>		 
				<wcard name="PARENT_INSTALL_PATH" type="special">PARENT_INSTALL_PATH</wcard>		 
				<wcard name="INSTALL_PATH" type="special">INSTALL_PATH</wcard>		 
				<wcard name="STEAM" type="regkey">HKEY_CURRENT_USER\Software\Valve\Steam\SteamPath</wcard>		 
				<wcard name="STEAMEXE" type="exe">%STEAM%\steam.exe</wcard>		 
				<wcard name="STEAMAPPS" type="path">%STEAM%\steamapps</wcard>		 
			</wcards>
		</platform>
	</platforms>
</itemwizard>

100: Generic Error

As above, only with different status code and text.