Changes between Version 3 and Version 4 of Development/FileFormatsExplained

Timestamp:

09/24/09 21:00:10 (10 years ago)

Author:

ibboard

Comment:

--

Development/FileFormatsExplained

@@ -22 +22 @@
 == Races ==
 
-TODO
+Race files define the units and equipment that can be taken in an army of a given race. Each race must be part of a game system and each army must be of a race.
+
+=== <race> ===
+
+A race defines an {{{id}}} and a {{{subid}}}. These are used to differentiate between races definitions. The subid can be used to define sub-races, either official sub-'races' like Black Templar Space Marines (who are still Space Marines, but have their own units) or unofficial sub-races such as campaign-specific versions with additional restrictions.
+
+Each race also defines its name, which is shown to the user, and the ID of the game system that it is part of.
+
+=== <units> and <unit> ===
+
+The {{{<units>}}} tag is a container for {{{<unit>}}} tags. Unit tags define everything about a unit, including equipment, statistics, limits on the number of troops in the unit (min/maxSize), limits on the number of times the unit can be taken (min/maxNum), and other additional data.
+
+==== <stats> and <stat> ====
+
+==== <unitEquipment> and <unitEquipmentItem> ====
+
+The {{{<unitEquipment>}}} tag is a container for {{{<unitEquipmentItem>}}} tags. unitEquipmentItem tags define the equipment that a unit can take by referencing an equipment item in the main list.
+
+ * {{{id}}} - the ID of the equipment item in the main list
+ * {{{required}}} - whether the item must be taken by the unit (e.g. swords for swordsmen)
+ * {{{exclusivityGroup}}} - currently a single string, but will be multi-valued. Defines a "group" where only one item from the group can be taken at once
+ * {{{minNum}}}/{{{maxNum}} - the minimum and maximum number of times an item can be taken by each instance of the unit
+ * {{{minPercentage}}}/{{{maxPercentage}} - the minimum and maximum percentage of the unit who can be equiped with the item
+ * More detail soon...
+
+=== Rest... ===
+
+More detail to come...
 
 == Armies ==