EQ2 Companion Beta tester Feedback

**Landiin** · #11 09-15-2007, 03:56 PM

To have total control over where your files get installed and what gets installed you need to include a file name eq2c.xml in the root of the zip file.

Here is some information on the format of the eq2c.xml file. You can see a working example in my test UI here

<option> nodes can only have <file> nodes as children.
<file> nodes can only have <include> nodes as children.
<include> nodes can only have <include> nodes as children.
<core> node can only have <file> nodes as children.

Option node perimeters:

Code:

<option filename="eq2UI_skininfo.xml" mandatory="true" description="Extrems skins">

Property description.

filename: Is the filename used in the UI.
mandatory: tells the app that a file has to be include in the option set. It also disallows the user from unchecking this option.
description: is a description of the file

File node perimeters:

Code:

<file filename="eq2ui_inventory_market.xml" uipath="ui\%customui%\" default="true" description="The Market Window">

Property description.

filename: the path\filename of the file in the zip. The filename will be the finename used by the UI if not a child of a option node.
uipath: Tells the app where you want the file to be installed in relation to the EverQuest2 directory.
default: Only used when it is a child of a option node. It tells the app that this is the option you want to use a default if the user does not select one.
description: is a description of the file

Include node perimeters:

Code:

<include filename="eq2ui_ButtonStyles.xml" uipath="ui\%customui%\"/>

Property description.

filename: the path\filename of the file in the zip. The filename will be the finename used by the UI.
uipath: Tells the app where you want the file to be installed in relation to the EverQuest2 directory.

Core node parameters:

Code:

<core>
...
</core>

Core is just a container node nothing more. The user will never have access to these files and they will always be installed.

Sample

Code:

<root>
  <option filename="eq2UI_skininfo.xml" uipath="ui\%customui%\" description="Extrems skins">
    <file filename="eq2ui_skininfo.xml" uipath="ui\%customui%\" default="true" description="Extrems default skin">
      <include filename="eq2ui_ButtonStyles.xml" uipath="ui\%customui%\"/>
    <file filename="eq2ui_skininfo.xml" uipath="ui\%customui%\" default="true" description="Extrems default skin">
      <include filename="eq2ui_ButtonStyles.xml" uipath="ui\%customui%\">
        <include filename="include_buttonstyle.xml" uipath="ui\%customui%\"/>
      </include>
  </option>
  <file filename="eq2ui_inventory_market.xml" uipath="ui\%customui%\" description="The Market Window">
    <include filename="system\includes\include_inventory_market_levelclass.xml" uipath="ui\%customui%\system\includes\"/>
    <include filename="system\includes\include_inventory_market_preset.xml" uipath="ui\%customui%\system\includes\"/>
    <include filename="system\includes\include_market_favorites1.xml" uipath="ui\%customui%\system\includes\"/>
    <include filename="system\includes\include_market_favorites3.xml" uipath="ui\%customui%\system\includes\"/>
  </file>
  <core>
    <file filename="eq2ui.xml" uipath="ui\%customui%\"/>
    <file filename="eq2ui_mainhud.xml" uipath="ui\%customui%\"/>
    <file filename="core\eXtreme_core_styles.xml" uipath="ui\%customui%\core\"/>
    <file filename="core\styles\eXtreme_style_images.xml" uipath="ui\%customui%\core\styles\"/>
    <file filename="core\styles\eXtreme_style_specialelements.xml" uipath="ui\%customui%\core\styles\"/>
    <file filename="core\styles\eXtreme_style_textstyles.xml" uipath="ui\%customui%\core\styles\"/>
  </core>
</root>