Big update to custom expression feature.
[debian/openrocket] / core / fileformat.txt
1
2 The current OpenRocket file format is "documented" only as the
3 reference implementation.  This will hopefully change in the future.
4
5
6 The "version" attribute of the <openrocket> tag describes the file
7 format version used, while the "creator" attribute MAY describe the
8 software and version used to write the document.
9
10 The file format version is increased every time the format is
11 changed.  The minor number is increased when changes are made that are
12 mostly backward-compatible, meaning that older software versions
13 should be able to read the design sans the new features.  The major
14 number is increased when changes are made that render the design
15 problematic or impossible to read for older software.  For maximum
16 compatibility software should save a file in the oldest file format
17 version that supports all the necessary design features.
18
19
20 The following file format versions exist:
21
22
23 1.0:  File format version of the first public release (OpenRocket 0.9.0)
24
25 1.1:  Introduced with OpenRocket 0.9.4.  Adds support for saving fin
26       tabs (<tabheight>, <tablength> and <tabposition> elements) and
27       allows attaching subcomponents to a tube coupler (previously
28       forbidden).
29
30 1.2:  Introduced with OpenRocket 1.1.1.  Adds the <digest> tag to
31       motor definitions.  The digest uniquely identifies the
32       functional characteristics of a particular thrust curve motor.
33
34 1.3:  Introduced with OpenRocket 1.1.9.  Adds the <launchlongitude> and
35       <geodeticmethod> parameters to the simulation conditions element.
36
37 1.4:  Introduced with OpenRocket 12.03.  Adds the launchrodvelocity and
38       deploymentvelocity attributes to <flightdata> element.  The motor
39       digesting algorithm was changed.  Adds <separationevent> and
40       <separationdelay> elements to stage components (except sustainer).
41
42 1.5:  Introduced with OpenRocket 12.xx.  Added ComponentPresets.
43       Added lowerstageseparation as recovery device deployment event.
44
45 1.6 (pre):
46       Added <datatypes> section for supporting datatypes other than
47       internal ones. Currently only supports datatypes from custom expressions.