' All accumulated documentation for the OCL editor for MOO2
' Pasted into one file by Flenser flenser@ntlworld.com for
' upload to Apolyton forums www.apolyton.com      May 2004
' All copyrights remain with original authors.
'
' File boundaries are marked with a ## followed by the file
' name as I have it.  This string only appears where I've
' added it, to facilitate searching (a little).

## ocl21-readme.txt [14-02-2000]

	OCL 'Master of Orion II' editor, v0.21.

	by Dmitry Yulmukhametov, Yulmukhametov@bsu.bashedu.ru, Feb. 2000.

-------------------------------------------------------------------------------

			INTRODUCTION

This distribution contains the OCL (Operated from Command Line) editor for an
outstanding space strategy game by Microprose, 'Master of Orion II'.
Accompanying it are this file, the data format description file, and the source
code files in a separate directory.

The OCL editor is designed to alter the data embedded in MOO2 executable and
'techname.lbx' file. It works as a compiler, processing the input text file and
editing the target files correspondingly. It is operated from MS-DOS command
line.

This program allows to edit such things as:
	- Tech tree (which technologies are assigned to which tech. fields);
	- Technologies' RP costs;
	- Buildings' Production and Maintenance costs;
	- Tech prerequisits, sizes and costs for Weapons, Special Systems,
	  Buildings, Drives, Shields and Computers;
	- Weapons' ammo count, min. and max. damage, possible modifications,
	  cost and size;
	- Main map speed (parsecs per turn) for Drives;
	- Main map movement radius (in parsecs) for Fuel Cells;
	- Shields' strength, Special Systems' effect and Computers' beam
	  offense bonus;
	- and more...
	
-------------------------------------------------------------------------------

			OPERATIONAL BASICS

The OCL editor has two modes of operation: Translation and Extraction.

Translation (default): reads the specified input file and writes binary output
to the game files. This mode allows to edit the game.

Extraction ('-e' command line switch): reads the game files and writes
formatted text to the specified output file, which can later be used in
translation mode. The exctraction mode allows to access the data contained in
the game and convert it into more readable format.

REQUIREMENTS: A working copy of MOO2 v1.31 in a MS-DOS compatible OS. Intel
80386-compatible processor.

INSTALLATION: Copy the executable (ocl_v021.exe) into your MOO2 directory.
Run it from the MOO2 directory with an output filename (any you like) and an
'-e' parameter (add a '-d' parameter if you only have DOS version of MOO2)
in the command line:

   copy ocl_v021.exe C:\ORION2
   cd C:\ORION2
   ocl_v021.exe -e my_rules.txt

This will produce a text file which you can now edit and translate back into
the game.

CALL FORMAT: ocl_v021.exe [-e] [-d] <filename>

Here <filename> is the name of input (or output, depending on the mode) text
file. An optional '-e' switch sets the extraction mode. Translation mode is the
default. An optional '-d' switch tells the editor to work with the DOS version
of MOO2 ('orion2.exe'). The program accesses the 'orion95.exe' file by default.

NOTE: It is highly advisable that you backup the critical MOO2 files (namely,
'orion2.exe', 'orion95.exe' and 'techname.lbx') before using this editor!

-------------------------------------------------------------------------------

			HOW TO EDIT

In order to edit the game using OCL, you need to:
	- extract the game data into a text file, using OCL with an '-e'
	  switch (see CALL FORMAT).
	- edit the text file created in the previous step.
	- translate the altered text file back into the game (see CALL FORMAT).
	  All the changes you made in the text file will affect the game.

If you already have a valid input text file, you can obviously skip the first
step.

TEXT FILE FORMAT: The text file contains fourteen blocks of MOO2-relevant data.
Each block is started with a statement of its nature, for example: 

[TECHNOLOGIES] ,

and finished with an '[END]' statement. The place between these two statements
is filled with a number of records. The general record format is:

[<Label> :] "item name" [, <field>] [, <field>] ... ;

Here <label> is an optional short string used for referencing this record
from other blocks, and [<Label> :] is a label definition. For example, the
"Standard Fuel Cells" fuel cell record has a reference to the "Standard Fuel
Cells" technology, which is its prerequisite. Labels cannot start with a
number. More on labels and references later.

"Item name" is, obviously, the name of the item to which this record
corresponds. It must be quoted. If you need to include a qoute in an item name,
double it, e.g. "I am ""quoted""" will produce an item name:  I am "quoted" .

<field> is one of three things:
	- decimal number,
	- binary flags,
	- label reference.

Decimal numbers may be 1, 2 or 4 bytes long. You can guess the length by amount
of space the editor leaves for it in the text file (3 for bytes, 5 for words,
10 for double words). Some fields _in the game_ are signed, some are unsigned.
In the text file they are all unsigned. More on it later.

Binary flags is an sequence of zeroes and ones. It represents what I thought
was flags in the game.

A label reference is a string literal matching a label already defined before.
A label definition assigns a number (the number of record in the block) to it.
When the editor encounters a label reference in the fields sequence, it
replaces it with the number assigned to this label. Labels must be unique
within a block (the editor knows records from which block reference records
from which block).

An example on labels:

[TECHFIELDS]
.
.
.
TF41: "Ion Fission", ...
.
.
.
[END]

[TECHNOLOGIES]
.
.
.
Tech97: "Ion Pulse Cannon", ... ,TF41, ...
.
.
.
[END]

[WEAPONS]
.
.
.
"Ion Pulse Cannon", ... ,Tech97, ...
.
.
.
[END]

The 'TF41' reference in the IPC tech record represents the techfield to which
this technology belongs. The 'Tech97' reference in the IPC weapon record
represents the prerequisite tech for that weapon.

You can change the labels to something more descriptive, like 'IonFiss' for Ion
Fission, or 'IPC' for Ion Pulse Cannon technology. Remember though, that labels
cannot be longer than eight symbols!


All fields in the game are actually signed or unsigned 1, 2 or 4-byte values.
I don't know for sure which fields are signed, and which are unsigned. Thus I
left all numbers in the text file unsigned. This means that values like 65535
or 65486 are likely to actually be -1 or -50. Suit yourself for a while, this
will be fixed as soon as I know more about data format.

All records must be finished with a semicolon.

Tokens may be separated by a arbitrary number of spaces, tabs and new-lines.

Any symbols between '/' symbol and new-line are ignored (comments).

The order of sequence of blocks is strict and must not be changed.

See the accompanying 'format.txt' file for exact record formats of different
blocks.

------------------------------------------------------------------------------

			OTHER IMPORTANT INFO


COMPATIBILITY: OCL v0.21 can properly handle text files produced by OCL v0.2,
as long as it is in the DOS mode ('-d' command-line switch). OCL v0.21 *can*
process obsolete text files in Windows mode, but I don't guarantee that
'orion95.exe' will run as expected afterwards. Nevertheless, I encourage you
to try that out. Using OCL v0.2 on a text file produced by OCL v0.21 will ruin
your 'orion2.exe' file.

The creator of the text file is indicated by a '%version=0.21' line at the top
of the file.

MAINTENANCE: I believe this release to be stable. Send your user questions, bug
reports and feature suggestions to:

	Yulmukhametov@bsu.bashedu.ru

or to the 'sff.discuss.games.moo2' group on the 'news.sff.net' server.

Also data format and meaning information is very welcome. 

Notes on this text are welcome too.

HISTORY:

v0.2  (Nov. 1999) - The first version in existence. Only works on DOS version
                    of MOO2.

v0.21 (Feb. 2000) - Made the editor compatible with the Win95 version of MOO2.
                    Provided an ability to include quotes ( " ) in item names.
		    Has limited compatibility with v0.2.

TODOs:
	- get more information on the data format,
	- auto-documentation in the text file,
	- descriptive labels generator,
	- implement negative numbers!
	- remove useless data from the text file,
	- reorganise the source code, make good comments,
	- whatever...

Dmitry Yulmukhametov, Feb. 11, 2000.

## ocl21-format.txt [14-02-2000]

	OCL 'MOO2' Editor, Input Text File Data Format.

[TECHFIELDS]:
Name, 	(obvious)
Number, (probably useless)
?,
?,
?,
?,
RP cost,
Tech Level;

[TECHNOLOGIES]:
Name,
Number (useless too),
Tech Field,
?,
?, (AI value?)
?;

[BUILDINGS]:
Name,
Number (got to remove this field),
Prereq. technology,
Production cost,
Maintenance cost,
?, (Hit points during space bombardments?)
?;

[SPECIALS]:
Name,
Number,
Prereq. tech,
Sizes (for each of the six ship classes),
Costs (for all six ships as well),
? (The effect assigned to the special system?),
?,
?,
?,
?,
?,
?;

[ARMOUR]:
Name,
Number,
Prereq. tech,
?, (Fighter hit points?)
?, (I'm at a loss)
Bonuses given to ship's hull, armour and systems, in percents (?),
?, (Missile h.p. bonuses?);

[SHIELDS]:
Name,
Number,
Prereq. tech,
Costs, (for six ship classes)
Sizes, (for six ships)
Class rating, (how much h.p. are absorbed completely)
?, ...

[WEAPONS]:
Name,
Number,
Prereq. tech,
Weapon class, (0 = beam, 1 = missile, 2 = torp., 3 = bomb or bioweapon, 4 = 
	       autonomous vessel (i.e. fighters, shuttles, ...), 5 = smth.
	       special (AMR, Stellar Converter, Caustic Slime,...))
Ammo count, (255 = unlimited, like beams)
Weapon characteristics flags:
(
This is flags:

	0000100100110100
	|              |
	flag #15       flag #0

If a flag is set (=1), that means the corresponding statement is true.
Otherwise, it's false.

#0: None (not used);
#1: Double range damage penalties (Fusion Beam, Plasma Cannon);
#2: Damage not reduced by range (Mass Driver, Gauss Cannon);
#3: Damages internal systems directly (Ion Pulse Cannon);
#4: Kills people onboard (Neutron Blaster, Death Ray);
#5: Extra structural damage (Graviton Beam);
#6: ? (Some Death Ray property);
#7: Is a biological weapon;
#8: Ignores shields (Particle Beam);
#9: Enveloping (Plasma Cannon);
#10: Always hits (Mauler Device);
#11: Damage reduced by range (Plasma Torpedo);
#12: Damages everything in two-square radius (Spatial Compressor);
#13: not used;
#14: not used;
#15: not used;

 
)
Min. damage, (?)
Max. damage, (?)
?, (Obsolete min. damage?)
?, (Obsolete max. damage?)
Acceptable mods flags (see [MODS] section in the input file and the "Weapon
characteristic flags" field here for an understanding of how these work);

[COMPUTERS]:
Name,
Number,
Prereq. technology,
Costs (for all six ship classes),
Beam offense bonus;

[DRIVES]:
Dunno here; The field before the last one is parsecs per turn.

[UNITS]:
Don't think this one works at all.

[FUELCELLS]:
Name,
Number,
Prereq. tech,
Allowed radius (parsecs);

[MODS]:
Name,
Number,
?, (Some flags)
Size increase (in percents),
Cost increase (in percents),
?;

[MODSABBREV]:
Just an abbreviated form of a mod's full name, like "Heavy Mounted" -> "Hv".

[WEAPONSPLURAL]:
Weapon names in plural, like "Laser Cannons" for Laser Cannon.

[SHIPS]:
(This block includes star bases as well!!)
Name, 
Number,
Basic cost,
Hull size,
Basic hull integrity,
Basic armour rating, (the last two maybe actually vica versa)
?, ...


[SHIPSPLURAL]:
Obvious.

-------------------------------------------------------------------------------

Please send new information on the data format, notes and suggestions on this
text to the following address:

		Yulmukhametov@bsu.bashedu.ru

or to the 'sff.discuss.games.moo2' newsgroup on the 'news.sff.net' server.

## gt-format.txt [21-02-2000]

	OCL 'MOO2' Editor, Input Text File Data Format.

Updated by Geoffrey Tobin, Monday 21 Feb 2000.

[TECHFIELDS]:
Tech Field Label:
Tech Field Name,
Tech Field Number,
Prerequisite (Last) Tech Field,
Next Tech Field,
?,  (always 0)
?,  (always 0)
RP cost,
Tech Level;

[TECHNOLOGIES]:
Technology Label:
Name,
Number, (useless)
Tech Field's Label,
?,  (0, 1, 2 or 3) (2 = Col base, Col Ship, Outpost, Fusion Drive; 3 = Xenon tech)
Technology Class,
?;  (0 or 1)

Note 1:  Phase Shifter has Tech Field 65535.  Presumably this should be
the signed 16 bit number -1 to indicate that it has no tech field at all,
and is absent from the game.

Note 2:  Xenon = Orion or Antaran.

Note 3:  The Technology Classes mainly but not solely contain technologies
with a similar function.  The numbers mean:

0 = Food, 1 = Industry, 2 = Science, 3 = Money, 4 = Pollution,
5 = miscellaneous buildings, 6 = Population growth, 7 = Planetary Room improvements,
8 = Barracks, 9 = Planetary Defence Systems and Colony Base and Outpost Ship (!),
10 = Planetary Shields,
11 = Planet Construction, Evolutionary Mutation, and Xeno Psychology (!),
12 = Spying, 13 = Advanced Governments, 14 = Communications, 15 = Troop Defence,
16 = Rifles, 17 = misc. ship techs, 18 = Drives, 19 = Bombs, 20 = Bio-weapons,
21 = Seekers (Missiles and Torpedoes), 22 = Population Movement and Titan Construction (!),
23 = Tactical Mobility, 24 = Scanners, 25 = Computers, 26 = Beams, 27 = Targetting,
28 = Missile Defence, 29 = Missile Enhancements, 30 = Fighters, 31 = Ship Integrity,
32 = Armor, 33 = Shields and Damper Field, 34 = Shield Enhancers and Reflection Field,
35 = Boarding, 36 = misc. ship special systems, 37 = Cloaking and Displacement Device (!),
38 = misc. ship weapons and special systems, 39 = Fuel Cells, 40 = Morale,
41 = Hyper-Advanced Technologies.

Some technologies look misclassified: it might be worthwhile to (carefully) experiment
with changing their tech class to something that appears more relevant.

[BUILDINGS]:
Name,
Number (got to remove this field),
Prereq. technology label,
Production cost,
Maintenance cost,
?, (Hit points during space bombardments?)
?; (always 0)

[SPECIALS]:
Name,
Number,
Prereq. tech's label,
Sizes (for each of the six ship classes),
Costs (for all six ships as well),
Exclusions (six Specials you cannot add to this one)  (Note: include itself (!) unless it's (the "hidden special") Regeneration)
Class of Special,  (0-7) (1 = beam attack; 2 = beam multiplier; 3 = beam defence; 4 = missile defence; 5 = missile multiplier; 6 = DD; 7 = TWF)
?; (something about specials of classes 1-7) (ATU = 100, BS = 25, DD = 30, ECMJ = 50, FMR = 25, HEF = 25, HXC = 50, IN = 50, IS = 25, LF = 90, MWECMJ = 70, RM = 50, SA = 75, TWF = 100, WAJ = 100)

[ARMOUR]:
Name,
Number,
Prereq. tech's label,
?, (Fighter hit point bonus?)
Troop combat strength bonus,
Bonuses given to ship's hull, armour and systems, in percents (?), (signed number: No armor = -100)
?, (Missile h.p. bonuses?);

[SHIELDS]:
Name,
Number,
Prereq. tech's label,
Costs, (for six ship classes)
Sizes, (for six ships)
Class rating, (how much h.p. are absorbed completely)
?, (six zeros)
?; (50 x shield number?) (or 5 x shield strength factor?)

[WEAPONS]:
Name,
Number,
Prereq. tech's label,
Weapon class, (0 = beam, 1 = missile, 2 = torp., 3 = bomb or bioweapon, 4 = 
	       autonomous vessel (i.e. fighters, shuttles, ...), 5 = smth.
	       special (AMR, Stellar Converter, Caustic Slime,...))
Ammo count, (255 = unlimited, like beams)
Space,
Cost,
Weapon characteristics flags:
(
This is the order of the flags:

	0000100100110100
	|              |
	flag #15       flag #0

If a flag is set (=1), that means the corresponding statement is true.
Otherwise, it's false.

Reading from the right:

#0: None (not used); (always 0)
#1: Double range damage penalties (Fusion Beam, Plasma Cannon, Mauler, Plasma Breath);
#2: Damage not reduced by range (Mass Driver, Gauss Cannon, Disruptor);
#3: Damages internal systems directly (Ion Pulse Cannon);
#4: Kills people onboard (Neutron Blaster, Death Ray);
#5: Extra structural damage (Graviton Beam);
#6: ? (Some Death Ray property);
#7: Is a biological weapon;
#8: Ignores shields (Particle Beam);
#9: Enveloping (naturally so: Plasma Cannon);
#10: Always hits (Mauler Device, Dragon Breath, Plasma Breath);
#11: Damage reduced by range (Plasma Torpedo);
#12: Damages everything in two-square radius (Spatial Compressor);
#13: not used; (always 0)
#14: not used; (always 0)
#15: not used; (always 0)

 
)
Min. damage, (?)
Max. damage, (?)
?, (Obsolete min. damage?)
?, (Obsolete max. damage?)
Acceptable mods flags;  (see [MODS] section in the input file and the "Weapon
characteristic flags" field here for an understanding of how these work.)
(For example: Laser Cannon has mods 1,2,3,4,5 and 7, which means:
Hv, PD, AP, Co, NRD, and AF.)

[COMPUTERS]:
Name,
Number,
Prereq. technology's label,
Costs (for all six ship classes),
Beam offense bonus;

[DRIVES]:
Name,
Number,
Prereq. technology's label,
(six zeros),
(six numbers decreasing),
(six more numbers decreasing: the previous six numbers plus 10),
Parsecs per turn,
?; (always zero)

[UNITS]:  (Don't think this one works at all.)
Name,  (No Unit, Marines, Armor, or Spy)
Number,
?,  (0, 40, 100, 100)  (build cost?) (doesn't affect spies: their build cost stays at 100)
?,  (0, 1, 2, 2)  (?hit points? offence? defence?)
?;  (0, 1, 2, 2)


[FUELCELLS]:
Name,
Number,
Prereq. tech's label,
Allowed radius (parsecs);  (255 = unlimited)

[MODS]:
Name,
?,  (Some flags) (encoding Mod's number, 0-14, in RH octet's 4 least significant bits)
Size increase (in percents),  (signed number: PD is -50 %)
Cost increase (in percents),  (signed number: PD is -50 %)
?;  (0 or 1) (1 for Hv, PD)

Mod numbers are:
0 = No Mods
1 = Hv
2 = PD
3 = AP
4 = Co
5 = NRD
6 = SP
7 = AF
8 = Env
9 = Mirv
10 = ECCM
11 = Arm
12 = Fast
13 = EMG
14 = Ovr

Most significant byte for Mod's flags equates to either 0, 1 or 2:
0 for No Mods, Hv, PD, EMG.
1 for AP, Co, NRD, SP, and ECCM, Arm, Fast, Ovr.
2 for AF, Env, Mirv.

[MODSABBREV]:
Just an abbreviated form of a mod's full name, like "Heavy Mount" -> "Hv".

[WEAPONSPLURAL]:
Weapon names in plural, like "Laser Cannons" for Laser Cannon.

[SHIPS]:  (Hulls:  This block includes star bases as well!!)
Name,
Basic cost,  (20, 70, 250, 600, 1500, 4000 and 400, 1000, 2500)
Hull size,  (25, 60, 120, 250, 500, 1200 and 300, 600, 1200)
Basic hull integrity,  (5,8,12,20,30,50 and 20,40,80)
Basic armour rating,  (4,10,30,50,80,150 and 60,90,120)  (the last two descriptions maybe actually vice versa)
?,  (same number again)
?,  (a number: 1,2,5,7,10,20 and 10,15,20)
?,  (about twice the previous number (2,5,10,15,20,40), but 0 for orbital bases)
?,  (1,2,6,7,10,20, and 15,20,30)
?,  (1,2,2,4,6,10 and 3,6,10)
?,  (0,0,1,2,4,10 and 3,6,10)
?,  (0,0,0,1,3,5 and 0,0,0)
?,  (0,0,2,5,10,25 and 0,0,0)
?,  (signed number: 50,40,30,25,20,15 and -10, -10, -10)  (missile evasion and/or beam defence?)
?,  (4,15,25,40,80,300 and 100, 200, 500)

[SHIPSPLURAL]:
Obvious.

-------------------------------------------------------------------------------

Please send new information on the data format, notes and suggestions on this
text to the following address:

		Yulmukhametov@bsu.bashedu.ru

or to the 'sff.discuss.games.moo2' newsgroup on the 'news.sff.net' server.

## ocl-fmt4.txt [04-03-2000]

	OCL 'MOO2' Editor, Input Text File Data Format.
        Ocl-fmt4.txt = this file.
        Geoffrey Tobin's version 4.
        Date:  Wed 1 March 2000.
        Based on Dmitry Yulmukhametov's FORMAT.TXT

[TECHFIELDS]:
Tech Field Label:
Tech Field Name,
Tech Field Number,  (visual aid only; the _true_ field number is its order in the list)
Prerequisite (Last) Tech Field,  (first field is the actual starting tech, field 0)
Next Tech Field,  (eg 15 means the field 15 positions after first field in list)
?,  (always 0)
?,  (always 0)
RP cost,
Tech Level;

Note 1:  The Tech Field Numbers are visual aids only.  What matters is
the tech field's ordinal position in the list, as that's what MOO2 uses.
For example, the first tech field in the list is always tech field 0
as far as MOO2 is concerned, and if a tech field's Next Tech Field is 15,
then it points to the tech field that's 15 positions below the first.
So to avoid confusing yourself, keep the TFNs in the same order 0..82
as the tech fields are listed!

Note 2:  The field in position 0 is always assumed Known.
(This field contains the actual starting tech.  If you wish to change
the starting technologies, then either change what's in this position,
or what techs have tech field 0 as their prerequisite.)

Note 3:  No matter what you do, colonies can always build Spies,
and always start with several Marines.

Note 4:  The eight categories of technology each has a starting field.
These starting fields are keyed to fixed positions in the techfield list
(positions 29, 55, 22, 10, 28, 18, 57, 7 in the displayed category order:
Construction, Power, Chemistry, Sociology, Computers, Biology, Physics,
and Force Fields.)

Note 5:  Subsequent tech fields to be researched in each category are
determined by the "Next Tech Field" (NTF) number given in the most
advanced tech field that's already Known in that category.

Note 6:  In seven of the categories (all except Construction) the
starting field is the category's first Researchable field, ie it's
the field that you see in that category when you open the research
screen.

Note 7:  Construction is an anomalous category:  MOO2 always assumes that
the field in position 29 (normally Engineering) is Known.  Thus, MOO2
starts with two already Known fields, the (Starting) field in position 0
and the (Construction) field in position 29.

[TECHNOLOGIES]:
Technology Label:
Name,
Number,
Tech Field's Label,
?,  (0, 1, 2 or 3) (2 = Col base, Col Ship, Outpost, Fusion Drive; 3 = Xenon tech)
Technology Class,
?;  (0 or 1)

Note 1:  Phase Shifter has Tech Field 65535.  Presumably this should be
the signed 16 bit number -1 to indicate that it has no tech field at all,
and is absent from the game.

Note 2:  Xenon = Orion or Antaran.

Note 3:  The Technology Classes mainly but not solely contain technologies
with a similar function.  The numbers mean:

0 = Food, 1 = Industry, 2 = Science, 3 = Money, 4 = Pollution,
5 = miscellaneous buildings, 6 = Population growth, 7 = Planetary Room improvements,
8 = Barracks, 9 = Planetary Defence Systems and Colony Base and Outpost Ship (!),
10 = Planetary Shields,
11 = Planet Construction, Evolutionary Mutation, and Xeno Psychology (!),
12 = Spying, 13 = Advanced Governments, 14 = Communications, 15 = Troop Defence,
16 = Rifles, 17 = misc. ship techs, 18 = Drives, 19 = Bombs, 20 = Bio-weapons,
21 = Seekers (Missiles and Torpedoes), 22 = Population Movement and Titan Construction (!),
23 = Tactical Mobility, 24 = Scanners, 25 = Computers, 26 = Beams, 27 = Targetting,
28 = Missile Defence, 29 = Missile Enhancements, 30 = Fighters, 31 = Ship Integrity,
32 = Armor, 33 = Shields and Damper Field, 34 = Shield Enhancers and Reflection Field,
35 = Boarding, 36 = misc. ship special systems, 37 = Cloaking and Displacement Device (!),
38 = misc. ship weapons and special systems, 39 = Fuel Cells, 40 = Morale,
41 = Hyper-Advanced Technologies.

Some technologies look misclassified: it might be worthwhile to (carefully) experiment
with changing their tech class to something that appears more relevant.

[BUILDINGS]:
Name,
Number,
Prereq. technology label,
Production cost,
Maintenance cost,
?, (0-7: Hits during space bombardments?)
?; (always 0)

[SPECIALS]:
Name,
Number,
Prereq. tech's label,
Sizes (for the six ship hulls),  (frigate to doomstar)
Costs (for the six ship hulls),
Exclusions (six Specials you cannot add to this one)  (Note: include itself (!) unless it's (the "hidden special") Regeneration)
Class of Special,  (0-7) (1 = beam attack; 2 = beam multiplier; 3 = beam defence; 4 = missile defence; 5 = missile multiplier; 6 = DD; 7 = TWF)
?; (something about specials of classes 1-7) (ATU = 100, BS = 25, DD = 30, ECMJ = 50, FMR = 25, HEF = 25, HXC = 50, IN = 50, IS = 25, LF = 90, MWECMJ = 70, RM = 50, SA = 75, TWF = 100, WAJ = 100)

[ARMOUR]:
Name,
Number,
Prereq. tech's label,
?, (Fighter hit point bonus?)
Troop combat strength bonus,
Bonuses added to ship's hull, armour and systems, in percent, (signed number: No armor = -100)
?, (?Missile h.p. bonuses?);

[SHIELDS]:
Name,
Number,  (0, 1, 2, 3, 4, 5)
Prereq. tech's label,
Space,  (for each of the six ship hulls)
Cost,  (for each of the six ship hulls)
Class rating,  (how many h.p. are absorbed completely)  (0, 1, 3, 5, 7, 10)
?,  (six zeros)
?;  ((0, 50, 100, 150, 200, 250) = 50 x shield number - why?)

Note:  Shield Strength = 5 x Hull Factor x Shield Class.
Hull Factor = 1, 2, 3, 4, 5, 7 (frigate to doomstar).

[WEAPONS]:
Name,
Number,
Prereq. tech's label,
Weapon class, (0 = beam, 1 = missile, 2 = torp., 3 = bomb or bioweapon, 4 = 
	       autonomous vessel (i.e. fighters, shuttles, ...), 5 = smth.
	       special (AMR, Stellar Converter, Caustic Slime,...))
Ammo count, (255 = unlimited, like beams)
Space,
Cost,
Weapon characteristics flags:
(
This is the order of the flags:

	0000100100110100
	|              |
	flag #15       flag #0

If a flag is set (=1), that means the corresponding statement is true.
Otherwise, it's false.

Reading from the right:

#0: None (not used); (always 0)
#1: Double range damage penalties (Fusion Beam, Plasma Cannon, Mauler, Plasma Breath);
#2: Damage not reduced by range (Mass Driver, Gauss Cannon, Disruptor);
#3: Damages internal systems directly (Ion Pulse Cannon);
#4: Kills people onboard (Neutron Blaster, Death Ray);
#5: Extra structural damage (Graviton Beam);
#6: ? (Some Death Ray property);
#7: Is a biological weapon;
#8: Ignores shields (Particle Beam);
#9: Enveloping (naturally so: Plasma Cannon);
#10: Always hits (Mauler Device, Dragon Breath, Plasma Breath);
#11: Damage reduced by range (Plasma Torpedo);
#12: Damages everything in two-square radius (Spatial Compressor);
#13: not used; (always 0)
#14: not used; (always 0)
#15: not used; (always 0)

 
)
Min. damage, (?)
Max. damage, (?)
?, (Obsolete min. damage?)
?, (Obsolete max. damage?)
Acceptable mods flags;  (see [MODS] section in the input file and the "Weapon
characteristic flags" field here for an understanding of how these work.)
(For example: Laser Cannon has mods 1,2,3,4,5 and 7, which means:
Hv, PD, AP, Co, NRD, and AF.)

[COMPUTERS]:
Name,
Number,
Prereq. technology's label,
Costs (for all six ship hulls),
Beam offense bonus;

[DRIVES]:
Name,
Number,
Prereq. technology's label,
(six zeros),
Combat Speeds for the six ship hulls when full,
Combat Speeds for the six ship hulls when empty,  (10 more than full hull combat speed)
Parsecs per turn,
?;  (always 0)

[UNITS]:  (Don't think this one works at all.)
Name,  (No Unit, Marines, Armor, or Spy)
Number,
?,  (0, 40, 100, 100)  (build cost?) (doesn't affect spies: their build cost stays at 100)
?,  (0, 1, 2, 2)  (?hits? offence? defence?)
?;  (0, 1, 2, 2)


[FUELCELLS]:
Name,
Number,
Prereq. tech's label,
Allowed radius (parsecs);  (255 = unlimited)

[MODS]:
Name,
?,  (Some flags) (encoding Mod's number, 0-14, in RH octet's 4 least significant bits)
Size increase (in percents),  (signed number: PD is -50 %)
Cost increase (in percents),  (signed number: PD is -50 %)
?;  (0 or 1) (1 for Hv, PD)

Mod numbers are:
0 = No Mods
1 = Hv
2 = PD
3 = AP
4 = Co
5 = NRD
6 = SP
7 = AF
8 = Env
9 = Mirv
10 = ECCM
11 = Arm
12 = Fast
13 = EMG
14 = Ovr

Most significant byte for Mod's flags equates to either 0, 1 or 2:
0 for No Mods, Hv, PD, EMG.
1 for AP, Co, NRD, SP, and ECCM, Arm, Fast, Ovr.
2 for AF, Env, Mirv.

[MODSABBREV]:
Just an abbreviated form of a mod's full name, like "Heavy Mount" -> "Hv".

[WEAPONSPLURAL]:
Weapon names in plural, like "Laser Cannons" for Laser Cannon.

[SHIPS]:  (Hulls:  This block includes star bases as well!!)
Name,
Hull cost,  (20, 70, 250, 600, 1500, 4000 and 400, 1000, 2500)
Hull space,  (25, 60, 120, 250, 500, 1200 and 300, 600, 1200)
?,  (5,8,12,20,30,50 and 20,40,80)
Basic (Titanium) Armor points,  (4,10,30,50,80,150 and 60,90,120)
Basic (Titanium) Structure points,  (same number again)
Computer hit points,  (1,2,5,7,10,20 and 10,15,20)
Drive hit points,  ((2,5,10,15,20,40) for ships, but naturally 0 for orbital bases)
Shield Generator hit points,  (1,2,6,7,10,20 and 15,20,30)
?,  (1,2,2,4,6,10 and 3,6,10)
?,  (0,0,1,2,4,10 and 3,6,10)
?,  (0,0,0,1,3,5 and 0,0,0)
?,  (0,0,2,5,10,25 and 0,0,0)
?,  (signed number: 50,40,30,25,20,15 and -10, -10, -10) (?related to beam defence?)
?,  (4,15,25,40,80,300 and 100, 200, 500)

[SHIPSPLURAL]:
Obvious.

-------------------------------------------------------------------------------

Please send new information on the data format, notes and suggestions on this
text to the following address:

		Yulmukhametov@bsu.bashedu.ru

or to the 'sff.discuss.games.moo2' newsgroup on the 'news.sff.net' server.