Developer's Guide - Revision history

SiboVG: Updated with zipped XML information

2021-09-13T13:35:54Z

Updated with zipped XML information

← Older revision		Revision as of 13:35, 13 September 2021
Line 168:		Line 168:

	The OpenRocket native format uses the file extension .ork. It is an XML format, which can optionally be compressed using GZIP. (The extension .ork.gz is also accepted by the dialogs, though plain .ork is recommended.)		The OpenRocket native format uses the file extension .ork. It is an XML format, which can optionally be compressed using GZIP. (The extension .ork.gz is also accepted by the dialogs, though plain .ork is recommended.)

			The core data format of an OpenRocket file is XML. However, the .ork-file that OpenRocket generates is a zipped XML file. This is because besides purely OpenRocket data, stored in XML, other data may also have to be stored, like for example custom decal images. To view the actual contents of the OpenRocket file, you can change the file extension of e.g. 'test.ork' to 'test.zip' and then unzip that zip-file. Depending on whether you do or don't have other data besides the XML-data, unzipping the file will simply return a 'rocket.ork'-file, which is pure XML (you can open this in any text editor), or a directory containing the 'rocket.ork'-file and other files/directories with e.g. decal images.

	Currently the file format is not documented other than as the reference implementation, and no XML schema exists. This will hopefully change in the future. See [[#Units used in OpenRocket]] for details on units.		Currently the file format is not documented other than as the reference implementation, and no XML schema exists. This will hopefully change in the future. See [[#Units used in OpenRocket]] for details on units.

	Every time the XML format changes, the file version number is increased. This version number is not linked to the version of OpenRocket that created the file, but instead describes the file format. Later versions of OpenRocket should attempt to store files in the oldest format that supports all the necessary features. The changes in the format are described in the [http://openrocket.svn.sourceforge.net/viewvc/openrocket/trunk/fileformat.txt fileformat.txt file in SVN].		Every time the XML format changes, the file version number is increased. This version number is not linked to the version of OpenRocket that created the file, but instead describes the file format. Later versions of OpenRocket should attempt to store files in the oldest format that supports all the necessary features. The changes in the format are described in the [http://openrocket.svn.sourceforge.net/viewvc/openrocket/trunk/fileformat.txt fileformat.txt file in SVN].

SiboVG at 13:01, 13 September 2021

2021-09-13T13:01:09Z

← Older revision		Revision as of 13:01, 13 September 2021
Line 69:		Line 69:
	-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml		-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml

	If nothing shows up, that is because the logging level is set to Error, as mentioned previously. You can change the logging level to e.g. show debug information (see [https://wiki.openrocket.info/Developer%27s_Guide#Probably_Obsolete_Debugging_Info this section]):		If nothing shows up, that is because the logging level is set to Error, as mentioned previously. You can change the logging level to e.g. show debug information (see [https://wiki.openrocket.info/Developer%27s_Guide#Probably_Obsolete_Debugging_Info this section]) by passing the following options to the JVM:
	-Dopenrocket.log.stdout=debug		-Dopenrocket.log.stdout=debug
	-Dopenrocket.debug		-Dopenrocket.debug

SiboVG: Add debug level link

2021-09-13T13:00:09Z

Add debug level link

← Older revision		Revision as of 13:00, 13 September 2021
Line 69:		Line 69:
	-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml		-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml

	If nothing shows up, that is because the logging level is set to Error, as mentioned previously. You can change the logging level to e.g. show debug information:		If nothing shows up, that is because the logging level is set to Error, as mentioned previously. You can change the logging level to e.g. show debug information (see [https://wiki.openrocket.info/Developer%27s_Guide#Probably_Obsolete_Debugging_Info this section]):
	-Dopenrocket.log.stdout=debug		-Dopenrocket.log.stdout=debug
	-Dopenrocket.debug		-Dopenrocket.debug

SiboVG at 12:58, 13 September 2021

2021-09-13T12:58:14Z

← Older revision		Revision as of 12:58, 13 September 2021
Line 67:		Line 67:
	To enable use of a LogBack configuration file, pass the JVM the following option during startup:		To enable use of a LogBack configuration file, pass the JVM the following option during startup:

	-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml		-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml

			If nothing shows up, that is because the logging level is set to Error, as mentioned previously. You can change the logging level to e.g. show debug information:
	-Dopenrocket.log.stdout=debug		-Dopenrocket.log.stdout=debug
	-Dopenrocket.debug		-Dopenrocket.debug

SiboVG: More clear path to configuration file

2021-09-13T12:49:34Z

More clear path to configuration file

← Older revision		Revision as of 12:49, 13 September 2021
Line 67:		Line 67:
	To enable use of a LogBack configuration file, pass the JVM the following option during startup:		To enable use of a LogBack configuration file, pass the JVM the following option during startup:

	-Dlogback.configurationFile=config/logback-stdout-level-error.xml		-Dlogback.configurationFile=<directory of openrocket source code>/openrocket/core/config/logback-stdout-level-error.xml
	-Dopenrocket.log.stdout=debug		-Dopenrocket.log.stdout=debug
	-Dopenrocket.debug		-Dopenrocket.debug

SiboVG: Hyperlink to specific part of website

2021-09-13T12:46:38Z

Hyperlink to specific part of website

← Older revision		Revision as of 12:46, 13 September 2021
Line 71:		Line 71:
	-Dopenrocket.debug		-Dopenrocket.debug

	See the [http://logback.qos.ch/manual/configuration.html LogBack configuration page] for more details.		See the [http://logback.qos.ch/manual/configuration.html#configFileProperty LogBack configuration page] for more details.

	=== Probably Obsolete Debugging Info ===		=== Probably Obsolete Debugging Info ===

SiboVG: Added changes from issue #344 from GitHub

2021-09-13T12:43:19Z

Added changes from issue #344 from GitHub

← Older revision		Revision as of 12:43, 13 September 2021
Line 68:		Line 68:

	-Dlogback.configurationFile=config/logback-stdout-level-error.xml		-Dlogback.configurationFile=config/logback-stdout-level-error.xml
			-Dopenrocket.log.stdout=debug
			-Dopenrocket.debug

	See the [http://logback.qos.ch/manual/configuration.html LogBack configuration page] for more details.		See the [http://logback.qos.ch/manual/configuration.html LogBack configuration page] for more details.

	=== Probably Obsolete Debugging Info ===		=== Probably Obsolete Debugging Info ===

Roguex: /* Units used in OpenRocket */

2020-07-01T02:27:21Z

Units used in OpenRocket

← Older revision		Revision as of 02:27, 1 July 2020
Line 101:		Line 101:
	== Units used in OpenRocket ==		== Units used in OpenRocket ==

	OpenRocket always uses internally pure SI units. For example all rocket dimensions and flight distances are in meters, all masses are in kilograms, density is in kg/m³, temperature is in Kelvin etc. This ~~convension~~ is also used when storing the design in the OpenRocket format.		OpenRocket always uses internally pure SI units. For example all rocket dimensions and flight distances are in meters, all masses are in kilograms, density is in kg/m³, temperature is in Kelvin etc. This convention is also used when storing the design in the OpenRocket format.

	The only exception to this rule is angles:		The only exception to this rule is angles:
Line 108:		Line 108:

	When displaying measures to the user, the values are converted into the preferred units of the user. This is performed using classes in the package <tt>net.sf.openrocket.unit</tt>. The <tt>Unit</tt> class represents a single unit and it includes methods for converting between that unit and SI units in addition to creating a string representation with a suitable amount of decimals. A <tt>UnitGroup</tt> describes a measurable quantity such as temperature and contains the units available for that quantity, such as Celcius, Fahrenheit and Kelvin.		When displaying measures to the user, the values are converted into the preferred units of the user. This is performed using classes in the package <tt>net.sf.openrocket.unit</tt>. The <tt>Unit</tt> class represents a single unit and it includes methods for converting between that unit and SI units in addition to creating a string representation with a suitable amount of decimals. A <tt>UnitGroup</tt> describes a measurable quantity such as temperature and contains the units available for that quantity, such as Celcius, Fahrenheit and Kelvin.


	== Rocket design loading and saving ==		== Rocket design loading and saving ==

2601:19B:A80:1CE0:31AC:954B:2BC0:FA6C: Adding a link to project dashboard which describes overall repository structure. The goal is to help new developers explore project and understand architecture/dependencies.

2020-04-30T15:26:40Z

Adding a link to project dashboard which describes overall repository structure. The goal is to help new developers explore project and understand architecture/dependencies.

← Older revision		Revision as of 15:26, 30 April 2020
Line 17:		Line 17:
	</pre>		</pre>

			This [https://sourcespy.com/github/openrocketopenrocket/ sourcespy dashboard] provides a high level overview of architecture, build process and dependencies of the project. It describes Ant [https://sourcespy.com/github/openrocketopenrocket/xx-otasks-.html tasks and dependencies], structure of [https://sourcespy.com/github/openrocketopenrocket/xx-ouiswing-.html UI classes], and other components of the system.

	'''Note:''' The source packages available on the OpenRocket web site (*.zip) are meant for building the application from source code, '''NOT''' for development purposes. They do not contain all the project files etc		'''Note:''' The source packages available on the OpenRocket web site (*.zip) are meant for building the application from source code, '''NOT''' for development purposes. They do not contain all the project files etc

38.102.240.66: Undo revision 34026 by 202.93.230.29 (talk) Removing spam links again

2017-02-21T21:13:26Z

Undo revision 34026 by 202.93.230.29 (talk) Removing spam links again

← Older revision		Revision as of 21:13, 21 February 2017
Line 168:		Line 168:

	Every time the XML format changes, the file version number is increased. This version number is not linked to the version of OpenRocket that created the file, but instead describes the file format. Later versions of OpenRocket should attempt to store files in the oldest format that supports all the necessary features. The changes in the format are described in the [http://openrocket.svn.sourceforge.net/viewvc/openrocket/trunk/fileformat.txt fileformat.txt file in SVN].		Every time the XML format changes, the file version number is increased. This version number is not linked to the version of OpenRocket that created the file, but instead describes the file format. Later versions of OpenRocket should attempt to store files in the oldest format that supports all the necessary features. The changes in the format are described in the [http://openrocket.svn.sourceforge.net/viewvc/openrocket/trunk/fileformat.txt fileformat.txt file in SVN].
	~~''Italic text''~~

	* [http://www.papdan.com/iphone-and-mobile-development.php Mobile Development]
	* [http://www.papdan.com/ Melbourne Web Developer]