Chapter 18

Target platform files

>>Chapter 17<< >>Chapter 19<<

This is the core of the editor. It is the most important file. You will be unable to make a new target platform without reading this. The file is divided into sections. Each ends with a tag </A>, </B> and so on. I will explain every part separately.

Section A - header


	Napoleon In Russia|
	0|2|2|0|0|1|
	66|74|47|52|910|50|288|52|276|42|
	1|0|0|0.4|2|9|2|
	French|Russian|
</A>

This is the section A - header of the file. It contains very important informations. First line is the title. The second line informs how many icons shall be skipped (from the beginning of the file and at the end of the file). This is needed as some icons show for example routed units and can not be assigned to a unit normally. So, from left to right:

The third line contains the size of the pictures and icons (width & height). It is used by the program to display them properly when you browse the picture. So, from left to right:

The fourth line contains various parameters. You may put in only the acceptable values. They are listed below:

Section B - base entry types

Section B contains data that allow to recognize various entries in the Oob file as specified types. Implemented there are seven basic types:

0 - unit
4 - leader
5 - supply wagon
6 - structure (like brigade, division, corps, wing)
7 - base structure (like army)
8 - general supply (for whole army)
9 - gunboat

You may ask why the numbers 1,2 and 3 are ommited? They are reserved for unit subtypes - infantry, cavalry and artillery. They can not be used in section B, only those listed are valid. The base types are declared like in the example below:


	0|0|U |Unit|
	4|1|L |Leader|
	5|2|S |Supply|
	6|3|B |Brigade|
	6|4|D |Division|
	6|5|C |Corps|
	6|6|W |Wing|
	7|7|French A |French Army|
	7|8|Russian A |Russian Army|
	8|9|French S |French Supply|
	8|10|Russian S |Russian Supply|
</B>

So, the first number is the type ID, second is base type own ID number (usually this can be a position number). After those two values there is the string that can be found in the oob file. If you have ever looked into the Oob file then you will surely know what it mean. Please note that is is important to add a space character after the full string. This will allow the program to distinct between base types and unit & weapon types that are described by single character. And of course the last string is the name that is shown in the program. This example is based on NIR, so you will not find a gunboat there but it may be definded as follows:


	9|11|Union G |Union Gunboat|

This section ends with tag </B>.

Section C - base cost

Section C gives some information about the base cost of all entry types. Here is the example of this section from the NIR information file:


	1|5|0.15|1|25|80|Infantry|
	2|5|0.2|2|25|40|Cavalry|
	3|5|0.2|100|1|16|Artillery|
	4|4|0|200|1|1|Leader|
	5|0|0|20|1|8|Supply|
	6|0|0|0|1|1|Structure|
	7|0|0|0|1|1|Base Structure|
	8|0|0|20|1|8|General Supply|
</C>

The entries have following values (please note that you may put two types of infantry for example, but the editor will use only the first one, so section C should only contain one line for each type - in this case type 0 is ommited and types 1,2 and 3 are placed instead):

In case of leaders only values: a, b, d and g are important; in case of supply wagons and general supply: a, d, e, f and g; in case of structures and base structures a, d, e and g; Please note that in this example structures and base structures are free (base cost 0).

Sections D & W - unit subtypes and weapons

The sections W in section D are given for each entry. Below is the full example (it is a bit long):


	1|S|0.05|Skirmisher Unit|
		M|0|Musket|
		R|0.05|Rifle|
		</W>
	1|G|0.1|3-Rank Guard Infantry|
		M|0|Musket|
		R|0.05|Rifle|
		</W>
	1|I|0|3-Rank Line Infantry [one skirmisher]|
		M|0|Musket|
		</W>
	1|M|-0.2|Militia|
		P|-0.1|Pike|
		M|0|Musket|
		</W>
	1|R|-0.05|3-Rank Line Infantry [no skirmishers]|
		M|0|Musket|
		</W>
	1|V|0.1|3-Rank Light Infantry|
		M|0|Musket|
		R|0.05|Rifle|
		</W>
	2|L|0|Light Cavalry|
		S|0|Sabre|
		L|0.1|Lance|
		</W>
	2|H|0.25|Heavy Cavalry|
		S|0|Swords|
		</W>
	2|K|-0.05|Cossack Cavalry|
		L|0.1|Lance|
		</W>
	3|A|0|Foot Artillery|
		A|0.25|12pd Cannons|
		B|0|9pd Cannons|
		C|-0.1|Howitzers|
		D|0.1|6pd Cannons|
		</W>
	3|B|-0.05|Light Artillery|
		D|0.1|6pd Cannons|
		</W>
	3|C|0.15|Horse Artillery|
		D|0.1|6pd Cannons|
		</W>
	4|2|0|Brigade Leader|
		</W>
	4|3|1|Division Leader|
		</W>
	4|4|2|Corps Leader|
		</W>
	4|5|3|Wing Leader|
		</W>
	4|6|4|Army Leader|
		</W>
	5|S |0|Supply|
		</W>
	6|B |0|Brigade|
		</W>
	6|D |0.1|Division|
		</W>
	6|C |0.2|Corps|
		</W>
	6|W |0.3|Wing|
		</W>
	7|French A |0|French Army|
		</W>
	7|Russian A |0|Russian Army|
		</W>
	8|French S |0|French Supply|
		</W>
	8|Russian S |0|Russian Supply|
		</W>
</D>

Each section D entry has a similar looking description. Note that types with ID equal or greater than 5 have additional space after the "to find" string. Here is explanation of fields:

Section W are "weapon" types. Of course leaders and structures have no weapons but the ending tag </W> must be included. Weapon description is also simple: letter that identifies this weapon, cost modifier and name. A short note: if you have made a target information file then you don't have to include unit types and weapons. The program will ask you how to identify them during reading. Anyway, later you will have to save target file and edit it with text editor to change names and cost modfiers for weapons.

Section E - attached oob files

Section E contains data about attached oobs. This was described earlier, so here is the example (this NIR file contains only one attached oob, but there may be more):


	main.oob|Original NIR OOB [BD]|
</E>

It may be clear enough but... the first value is name of the file (it must be located in the DATA directory) and second name that is shown in the program. Nothing more to say here, let's proceed to next point.

Section F - template information

Section F stores the data about templates that are saved in the template file. They give us information to which country this template belongs and what type it is:


	C:\OOBEditor\DATA\Napoleon In Russia_template.txt|
	4|1|0|800|Emperor Napoleon|
	0|0|1|100|Opolchenie Bn.|
	6|3|0|1000|French Divisional Artillery|
</F>

First line contain path to the template file. All other inform the program about data contained by the template file. The values are:

By Dominik Derwinski