<api>
	<description>Welcome to the Conquer Club API.</description>
	<input_parameters>
		<parameter>mode - type of data to fetch, can be map, maplist, player, tournamentlist, clanlist, clanwarlist or gamelist (default)</parameter>
	</input_parameters>
	<modes>
		<mode name="maplist">
			<description>A listing of maps matching given criteria.</description>
			<input_parameters>
				<parameter>mp - map name, comma separated</parameter>
			</input_parameters>
			<output_tags>
				<tag>maps total="#" - container for maps</tag>
				<tag>map - a map</tag>
        <tag>index - the map id</tag>
        <tag>title - the map title</tag>
				<tag>xml - the xml filename</tag>
				<tag>small - the small graphic filename</tag>
				<tag>large - the large graphic filename</tag>
				<tag>thumbnail - the thumbnail graphic filename</tag>
				<tag>topic - the id of discussion topic url i.e. forum/viewtopic.php?t=#</tag>
				<tag>status - "N" = Normal, "B" = Beta, "C" = Closed, "R" = Random</tag>
				<tag>small_width - the small graphic width</tag>
				<tag>small_height - the small graphic height</tag>
				<tag>large_width - the large graphic width</tag>
				<tag>large_height - the large graphic height</tag>
				<tag>territories - the number of territories</tag>
			</output_tags>
		</mode>
		<mode name="player">
			<description>A listing of a single player.</description>
			<input_parameters>
				<parameter>u - user id #, comma separated</parameter>
				<parameter>un - username, comma separated</parameter>
			</input_parameters>
			<output_tags>
				<tag>userid - the user id #</tag>
				<tag>username - the username</tag>
				<tag>membership - "F" = Free, "P" = Premium</tag>
				<tag>score - the score</tag>
				<tag>games_completed - the number of games completed</tag>
				<tag>games_won - the number of games won</tag>
				<tag>rank - the rank</tag>
				<tag>rating - the rating</tag>
				<tag>country - the country</tag>
				<tag>attendance - the % attendance</tag>
				<tag>medals - the number of medals</tag>
			</output_tags>
		</mode>
		<mode name="group">
			<description>A listing of a single usergroup.</description>
			<input_parameters>
				<parameter>g - usergoup id #</parameter>
				<parameter>gn - usergroup name</parameter>
				<parameter>names - show player usernames, can be (Y)es or (N)o (default)</parameter>
			</input_parameters>
			<output_tags>
				<tag>group - a usergroup</tag>
				<tag>group_id - the usergroup id #</tag>
				<tag>name - the usergroup name</tag>
				<tag>type - determines which users can join or view this usergroup</tag>
				<tag>description - the usergroup description</tag>
				<tag>members - container for members</tag>
				<tag>member leader="Yes or No" - a member</tag>
			</output_tags>
		</mode>
		<mode name="tournamentlist">
			<description>A listing of tournaments matching given criteria.</description>
			<input_parameters>
				<parameter>status - tournament status, can be (W)Open, (A)Ongoing, (F)Completed or (X)Abandoned</parameter>
				<parameter>title - tournament title</parameter>
				<parameter>page - page #</parameter>
				<parameter>names - show player usernames, can be (Y)es or (N)o (default)</parameter>
			</input_parameters>
			<output_tags>
				<tag>page - the page e.g. "3 of 10"</tag>
				<tag>tournaments total="#" - container for tournaments</tag>
				<tag>tournament - a tournament</tag>
				<tag>tournament_number - the tournament number</tag>
				<tag>title - the tournament title</tag>
				<tag>status - "W" = Open, "A" = Ongoing, "F" = Completed, "X" = Abandoned</tag>
				<tag>topic - the id of tournament topic url i.e. forum/viewtopic.php?t=#</tag>
				<tag>type - the tournament type</tag>
				<tag>organizers - container for organizers</tag>
				<tag>organizer removed="Yes or No" - a tournament organizer</tag>
				<tag>winners - container for winners</tag>
				<tag>winner - a tournament winner</tag>
			</output_tags>
		</mode>
    <mode name="clanlist">
      <description>A listing of clans matching given criteria.</description>
      <input_parameters>
        <parameter>status - clan status</parameter>
        <parameter>name - clan name</parameter>
        <parameter>page - page #</parameter>
      </input_parameters>
      <output_tags>
      </output_tags>
    </mode>
    <mode name="clanwarlist">
      <description>A listing of clan wars matching given criteria.</description>
      <input_parameters>
        <parameter>status - clan war status</parameter>
        <parameter>clans - comma separated list of clan ids</parameter>
        <parameter>page - page #</parameter>
      </input_parameters>
      <output_tags>
      </output_tags>
    </mode>
		<mode name="gamelist">
			<description>A listing of games matching given criteria.</description>
			<input_parameters>
				<parameter>gn - game number, comma separated</parameter>
				<parameter>gs - game state, comma separated, can be (W)aiting, (A)ctive or (F)inished</parameter>
				<parameter>np - numer of players, comma separated</parameter>
				<parameter>ty - game type, comma separated, can be (S)tandard, (C)Terminator, (A)ssassin, (D)oubles, (T)riples or (Q)uadruples</parameter>
				<parameter>mp - map name, comma separated</parameter>
				<parameter>it - initial troops, comma separated, can be (E)Automatic or (M)anual</parameter>
				<parameter>po - play order, comma separated, can be (S)equential or (F)reestyle</parameter>
				<parameter>bc - spoils, comma separated, can be (1)No Spoils, (2)Escalating, (3)Flat Rate or (4)Nuclear</parameter>
				<parameter>ft - reinforcements, comma separated, can be (C)hained, (O)Adjacent or (M)Unlimited</parameter>
				<parameter>wf - fog of war, comma separated, can be (Y)es or (N)o</parameter>
				<parameter>tw - trench warfare, comma separated, can be (Y)es or (N)o</parameter>
				<parameter>rl - round limit, comma separated, can be 0, 20, 50 or 100</parameter>
				<parameter>sg - speed game, comma separated, can be (N)o, 5, 4, 3, 2 or 1</parameter>
        <parameter>pt - private, comma separated, can be (N)o, (Y)es or (T)ournament</parameter>
        <parameter>ps - number of slots in a poly game</parameter>
				<parameter>to - tournament name</parameter>
				<parameter>lb - tournament label</parameter>
				<parameter>p1 - player 1 user id #</parameter>
				<parameter>p1un - player 1 username</parameter>
				<parameter>p2 - player 2 user id #</parameter>
				<parameter>p2un - player 2 username</parameter>
				<parameter>p3 - player 3 user id #</parameter>
				<parameter>p3un - player 3 username</parameter>
				<parameter>p4 - player 4 user id #</parameter>
				<parameter>p4un - player 4 username</parameter>
				<parameter>page - page #</parameter>
				<parameter>names - show player usernames, can be (Y)es or (N)o (default)</parameter>
				<parameter>chat - show id of last chat entry, can be (Y)es or (N)o (default)</parameter>
				<parameter>events - show log events, can be (Y)es or (N)o (default)</parameter>
			</input_parameters>
			<output_tags>
				<tag>page - the page e.g. "3 of 10"</tag>
				<tag>games total="#" - container for games</tag>
				<tag>game - a game</tag>
        <tag>game_number - the game number</tag>
				<tag>game_state - "W" = Waiting, "A" = Active, "F" = Finished</tag>
				<tag>tournament - the tournament name, with any label, if it is a tournament game e.g. "Super Tourney - Final Round"</tag>
				<tag>private - "Y" or "N"</tag>
				<tag>speed_game - "N" = Casual, 5, 4, 3, 2 or 1</tag>
				<tag>map - the name of the map</tag>
				<tag>game_type - "S" = Standard, "C" = Terminator, "A" = Assassin, "D" = Doubles, "T" = Triples, "Q" = Quadruples</tag>
				<tag>initial_troops - "E" = Automatic, "M" = Manual</tag>
				<tag>play_order - "F" = Freestyle, "S" = Sequential</tag>
				<tag>bonus_cards - "1" = No Cards, "2" = Escalating, "3" = Flat Rate, "4" = Nuclear</tag>
				<tag>fortifications - "C" = Chained, "O" = Adjacent, "M" = Unlimited</tag>
				<tag>war_fog - "Y" or "N"</tag>
				<tag>trench_warfare - "Y" or "N"</tag>
				<tag>round_limit - 0, 20, 50, or 100</tag>
        <tag>round - the round number</tag>
        <tag>random_map - "Y" or "N"</tag>
        <tag>poly_slots - the number of slots in a poly game</tag>
				<tag>time_remaining - the hrs:min:sec until round or turn expires, or 0 if game is not active</tag>
				<tag>chat - id of last chat entry</tag>
				<tag>players - container for players</tag>
				<tag>player state="Won, Lost, Ready, Waiting or Playing" - the user id # or username of a player</tag>
				<tag>events - container for game log events</tag>
				<tag>event timestamp="#" - a game log event (see event examples)</tag>
				<event_examples>
					<example># eliminated # from the game</example>
					<example># was kicked out</example>
					<example># loses # points</example>
					<example># gains # points</example>
					<example>#, #, #, # won the game</example>
					<example>#, #, # won the game</example>
					<example>#, # won the game</example>
					<example># won the game</example>
					<example># surrendered</example>
					<example># was a deadbeat</example>
					<example># held the objective</example>
				</event_examples>
			</output_tags>
		</mode>
	</modes>
</api>