====== Resources.xml ======

^   Information  ^^
^   Download:| [[http://windower.net/resources/resources.xml | Latest resources.xml]]|
^   Bug Tracker:| [[http://forums.windower.net/index.php?autocom=tracker&showproject=6| Report issues here]]|
^   Current Fixes:| [[http://windower.net/resources/fixes.xml| fixes.xml]]|
^   Last Updated:| June 16th, 2008|

===== What is resources.xml? =====
Resources.xml is a compilation of FFXI information used by various Windower [[:plugins:index|plugins]] to do their job. Resources.xml contains information about spells, equipment, buffs and abilities. The information contained in resources.xml is obtained initially through FFXI dat mining, and later through manual fixes.

==== Plugins that use resources.xml ====
  * [[:plugins:SpellCast]]
  * [[:plugins:Recast]]
  * [[:plugins:AutoExec]]
  * [[:plugins:StatusTimer]]
  * [[:plugins:SpellCastLite]]
  * [[:plugins:SSOrganizer]]



===== Obtaining resources.xml =====
Resources.xml comes embedded within the plugins that use it. These plugins will automatically extract resources.xml if it is not found or is found to be out of date.


===== Updating resources.xml =====
Resources.xml will automatically be updated whenever a plugin is loaded with a more up to date version embedded. In the event updates are made to resources.xml between plugin releases, the most up to date version can be downloaded __[[http://windower.net/resources/resources.xml|here]]__.



===== Fixes =====
One of the peculiarities of data mining from the FFXI dat files, is that SE does not necessarily provide the correct information. Because of this, information within resources.xml can in some cases be incorrect. As a way of fixing these irregularities, an override file named __[[http://windower.net/resources/fixes.xml|fixes.xml]]__ is processed before creating the final resources.xml.

If you are aware of any inaccuracies in resources.xml, you should help the community by submitting a bug fix. Submitting the fix not only helps the community, but also helps you because your changes will already be present the next time a plugin is released with an updated resources.xml embedded.

The override file is an xml file itself with one valid tag type, **<fix>**.

==== <fix> ====
The fix tag is used to specify what needs to be overridden. The basic format of the fix tag is to specify in which section the fix should be made, what entry needs fixing, what attribute to actually fix, and then finally what the new fixed value is.

=== fixing an ability ===
Lets say that the resources.xml listed the thief job ability Accomplice as being self target only. Lets go even further as to assume it also was incorrectly listed as having a /weaponskill prefix. We would need to submit **two individual** fixes for this as follows:
<code xml><fix type="abil" abil="Accomplice" key="targets" value="Party" />
<fix type="abil" abil="Accomplice" key="prefix" value="/jobability" /></code>
=== fixing a spell ===
Lets say that blizzard was actually fire based(because I feel like being absurd), yet resources.xml says it is ice based. The fix would be as follows:
<code xml><fix type="spell" spell="Blizzard" key="element" value="Fire" /></code>



===== Submitting your Fixes =====
Resources.xml fixes should be submitted as lines from the above mentioned fix file format. You can post your fixes for resources.xml directly to the bug tracker __[[http://forums.windower.net/index.php?autocom=tracker&showproject=6|here]]__.

===== Credits =====
   * Aikar: resources.xml PHP compilation script. [[http://windower.net/resources/resources.xml?source=1|resources.php Source code]]
   * Pebbles: POLUtils Author for getting XML dumps from the .dat's [[http://users.telenet.be/pebbles/|Pebbles POLUtils Homepage]]
   * Enderlin Ivan: Xml PHP Class for handling attributes cause I'm too lazy to convert it to PHP5 XML for now. [[http://windower.net/resources/xml.php?source=1|xml.php Source code]]