Howto:Make an aircraft: Difference between revisions

Jump to navigation Jump to search
m
no edit summary
mNo edit summary
mNo edit summary
Line 3: Line 3:


There are many things required to develop an [[aircraft]] for [[FlightGear]]. We encourage new developers to start their 'career' by enhancing existing aircrafts. It is much easier to do and gives you a giant advantage by the time you create an aircraft completely by yourself.  
There are many things required to develop an [[aircraft]] for [[FlightGear]]. We encourage new developers to start their 'career' by enhancing existing aircrafts. It is much easier to do and gives you a giant advantage by the time you create an aircraft completely by yourself.  
The in this article treated codes can be found in most planes. So for examples of the usage, you might take a look at some random planes.


==Before you start==
==Before you start==
Line 17: Line 19:


==Directories and files==
==Directories and files==
The data created during development results in many files, which are stored in several directories per aircraft. Each aircraft has its own directory in the <tt>$FG_ROOT/Aircraft/</tt> directory. The first thing to do when you start working on a new aircraft is to make a directory for it. A short version of the aircraft name (eg. harrier), or its serial number (eg. 747-400) is prefered. In this directory we create one directory, namely:
The data created during development results in many files, which are stored in several directories per aircraft. Each aircraft has its own directory in the <tt>$FG_ROOT/Aircraft/</tt> directory. The first thing to do when you start working on a new aircraft is to make a directory for it. A short version of the aircraft name (eg. harrier), or its serial number (eg. 747-400) is prefered. More directories might be needed further on, but we will create them when we need them. For now we create one directory, namely:


* <tt>Models/</tt> all files related to the appearence of the model are saved in this directory.
* <tt>Models/</tt> all files related to the appearence of the model are saved in this directory.


More directories might be needed further on, but we will create them when we need them.
All paths are relative to [[$FG_ROOT]], with the exception of some that are explicit noted.
 
===The .xml file (FDM)===
This file contains the entire (or partial) [[Flight Dynamics Model]] of the aircraft. We have three different systems; they all have their up- and downsides.
* [[YASim]], needed for: helicopters, towing over a [[Howto: Multiplayer|multiplay network]]
* [[JSBSim]], needed for: [[Howto: Implent pushback|pushback]]
* [[UIUC]] (rarely used)
When you have acces to real windtunnel data, JSBSim might be a better choice.


===The -set.xml file===
===The -set.xml file===
Line 40: Line 49:
====<description></description>====
====<description></description>====
The text that have to be showed in the Aircraft selection dialog of FlightGear.
The text that have to be showed in the Aircraft selection dialog of FlightGear.
<description>Boeing 747-400</description>
 
====<aircraft-version>====
Commonly shows the latest update date.


====<status></status>====
====<status></status>====
The status of the development of your plane.  
The status of the development of your plane.  
<status> beta </status>


====<author></author>====
====<author></author>====
Place your name(s) here. If multiple people worked on the same aircraft, you can place the specific development area for each person between ( ).
Place your name(s) here. If multiple people worked on the same aircraft, you can place the specific development area for each person between ( ).
<author> ET </author>


====<flight-model></flight-model>====
====<flight-model></flight-model>====
What FDM system is the aircraft using. Set to yasim for [[YASim]] and to jsb for [[JSBSim]].
What FDM system is the aircraft using. Set to 'yasim' for [[YASim]] and to 'jsb' for [[JSBSim]].


====<aero></aero>====
====<aero></aero>====
The filename of the FDM file, without .xml. This file should be placed in the aircrafts root directory (eg. <tt>$FG_ROOT/Aircraft/747-400/</tt>).
The filename of the FDM file, without .xml. You have created this file earlier on at: [[#The .xml file (FDM)]]


====<splash-texture></splash-texture>====
====<splash-texture></splash-texture>====
Place the location of an image you would like to show during loading of the aircraft.
Place the location of an image you would like to show during loading of the aircraft.
<splash-texture> Aircraft/747-400/splash.png </splash-texture>


====<model><path></path></model>====
====<model><path></path></model>====
Where to find the model. Could be an .ac file or .xml if you want to have extras like animations etc.
Where to find the model. Could be an .ac file or .xml if you want to have extras like animations etc.
<model>
  <path>Aircraft/747-400/Models/747-400.xml</path>
</model>


====<sound><path></path></sound>====
====<sound><path></path></sound>====
The path to your aircrafts sound file, do not include if you don't have one.
The path to your aircrafts sound file, do not include if you don't have one.
<sound>
  <path>Aircraft/747-400/747-400-sound.xml</path>
</sound>


====<panel><path></path></panel>====
====<panel><path></path></panel>====
Where to find the (2D) panel. We prefer 3D cockpits, which are linked in the model .xml file.
Where to find the (2D) panel. We prefer 3D cockpits, which are linked in the model .xml file.
<panel>
  <path>Aircraft/B-52F/Panels/B-52F-vfr-panel.xml</path>
</panel>


====<autopilot><path></path></autopilot>====
====<autopilot><path></path></autopilot>====
Where to find the [[autopilot]] system.
Where to find the [[autopilot]] system.
<autopilot>
  <path>Aircraft/B-52F/Systems/B-52F-autopilot.xml</path>
</autopilot>


==Extra codes==
==Extra codes==

Navigation menu