FlightGear manual: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(not finished. Please help with importing parts of the manual at http://flightgear.org/Docs/getstart/getstart.html to here and add wikilinking and screenshots. Thank you!)
 
(Update PDF links to be the same as on the FG website, remove link to outdated HTML manual to avoid confusion, fix typo)
(20 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{stub}}
[[FlightGear]] comes with a set of illustrated documentation, known as '''The Manual'''.


''This article is imported from http://flightgear.org/Docs/getstart/getstart.html''
== Current Version ==
* [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/Docs/getstart.pdf?format=raw PDF] (English)
* [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/Docs/getstart-fr.pdf?format=raw PDF] (French)
* [https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/Docs/getstart-it.pdf?format=raw PDF] (Italian)


==Installation ==
== "The Manual" ==
===Want to have a free flight? Take FlightGear! ===
This piece of documentation aims at being printed onto paper and being read as a reference while you're exploring FlightGear - or simply taken with you on a long trip.
====Yet Another Flight Simulator? ====
Did you ever want to fly a [[aircraft|plane]] yourself, but lacked the money or ability to do so? Are you a real pilot looking to improve your skills without having to take off? Do you want to try some dangerous maneuvers without risking your life? Or do you just want to have fun with a more serious game without any violence? If any of these questions apply to you, PC flight simulators are just for you.  


You may already have some experience using Microsoft’s © Flight Simulator or any other of the commercially available PC flight simulators. As the price tag of those is usually within the $50 range, buying one of them should not be a serious problem given that running any serious PC flight simulator requires PC hardware within the $1500 range, despite dropping prices.  
== Contributing ==
If you are a skilled writer and are familiar with LaTeX, please take the time to dig into the PDF or HTML version. Instructions on how to get the source code are below.


With so many commercially available flight simulators, why would we spend thousands of hours of programming and design work to build a free flight simulator? Well, there are many reasons, but here are the major ones:
It lies in the nature of FlightGear development that The Manual is always a bit behind current development. We invite you to pick information from
* your personal experience with FlightGear
* the available README's in the FlightGear source tree or the Base Package or
* the Wiki
and merge these into an appealing shape for The Manual. Turn your head to the FlightGear developers' mailing list and you'll find someone to talk about how to improve The Manual.


All of the commercial simulators have a serious drawback: they are made by a small group of developers defining their properties according to what is important to them and providing limited interfaces to end users. Anyone who has ever tried to contact a commercial developer would agree that getting your voice heard in that environment is a major challenge. In contrast, [[FlightGear]] is designed by the people and for the people with everything out in the open.
You'll find contacts of current maintainers in the Manual itself.
Commercial simulators are usually a compromise of features and usability. Most commercial developers want to be able to serve a broad segment of the population, including serious pilots, beginners, and even casual gamers. In reality the result is always a compromise due to deadlines and funding. As FlightGear is free and open, there is no need for such a compromise. We have no publisher breathing down our necks, and we’re all volunteers that make our own deadlines. We are also at liberty to support markets that no commercial developer would consider viable, like the scientific research community.
Due to their closed-source nature, commercial simulators keep developers with excellent ideas and skills from contributing to the products. With FlightGear, developers of all skill levels and ideas have the potential to make a huge impact on the project. Contributing to a project as large and complex as FlightGear is very rewarding and provides the developers with a great deal of pride in knowing that we are shaping the future of a great simulator.  
Beyond everything else, it’s just plain fun! I suppose you could compare us to real pilots that build kit-planes or scratch-builts. Sure, we can go out a buy a pre-built aircraft, but there’s just something special about building one yourself.
The points mentioned above form the basis of why we created FlightGear. With those motivations in mind, we have set out to create a high-quality flight simulator that aims to be a civilian, multi-platform, open, user-supported, and user-extensible platform. Let us take a closer look at each of these characteristics:


*'''Civilian:''' The project is primarily aimed at civilian flight simulation. It should be appropriate for simulating general aviation as well as civilian aircraft. Our long-term goal is to have FlightGear FAA-approved as a flight training device. To the disappointment of some users, it is currently not a combat simulator; however, these features are not explicitly excluded. We just have not had a developer that was seriously interested in systems necessary for combat simulation.
== Source code ==
*'''Multi-platform:''' The developers are attempting to keep the code as platform-independent as possible. This is based on their observation that people interested in flight simulations run quite a variety of computer hardware and operating systems. The present code supports the following Operating Systems:
You'll find the source code [https://sourceforge.net/p/flightgear/getstart/ci/master/tree/ here], at the [[FlightGear Git]] repository.
**Linux (any distribution and platform),
**Windows NT/2000/XP (Intel/AMD platform),
**Windows 95/98/ME,  
**BSD UNIX,
**SGI IRIX,
**Sun-OS,
**Macintosh.
At present, there is no known flight simulator – commercial or free – supporting such a broad range of platforms.
* '''Open:''' The project is not restricted to a static or elite cadre of developers. Anyone who feels they are able to contribute is most welcome. The code (including documentation) is copyrighted under the terms of the [[GNU General Public License]] (GPL). The GPL is often misunderstood. In simple terms it states that you can copy and freely distribute the program(s) so licensed. You can modify them if you like and even charge as much money as want to for the distribution of the modified or original program. However, you must freely provide the entire source code to anyone who wants it, and it must retain the original copyrights. In short:


<center>''”You can do anything with the software except make it non-free”.''</center>
[[Category:Documentation|Manual]]
The full text of the GPL can be obtained from the FlightGear source code or from: http://www.gnu.org/copyleft/gpl.html.
* '''User-supported and user-extensible:''' Unlike most commercial simulators, FlightGear’s scenery and aircraft formats, internal variables, APIs, and everything else are user accessible and documented from the beginning. Even without any explicit development documentation (which naturally has to be written at some point), one can always go to the source code to see how something works. It is the goal of the developers to build a basic engine to which scenery designers, panel engineers, maybe adventure or ATC routine writers, sound artists, and others can build upon. It is our hope that the project, including the developers and end users, will benefit from the creativity and ideas of the hundreds of talented “simmers” around the world.
Without doubt, the success of the Linux project, initiated by Linus Torvalds, inspired several of the developers. Not only has Linux shown that distributed development of highly sophisticated software projects over the Internet is possible, it has also proven that such an effort can surpass the level of quality of competing commercial products.


====System Requirements ====
[[es:FlightGear Manual]]
In comparison to other recent flight simulators, the system requirements for FlightGear are not extravagant. A medium speed AMD Athlon64 or Intel P4, even a decent AMD Athlon/K7 or an Intel PIII should be sufficient to handle FlightGear pretty well, given you have a proper 3D graphics card.
[[fr:FlightGear Manual]]
 
One important prerequisite for running FlightGear is a graphics card whose driver supports OpenGL. If you don’t know what OpenGL is, the overview given at the [http://www.opengl.org OpenGL website] says it best: “Since its introduction in 1992, OpenGL has become the industry’s most widely used and supported 2-D and 3D graphics application programming interface (API)...”.
 
FlightGear does not run (and will never run) on a graphics board which only supports Direct3D. Contrary to OpenGL, Direct3D is a proprietary interface, being restricted to the Windows operating system.
 
You may be able to run FlightGear on a computer that features a 3D video card not supporting hardware accelerated OpenGL – and even on systems without 3D graphics hardware at all. However, the absence of hardware accelerated OpenGL support can bring even the fastest machine to its knees. The typical signal for missing hardware acceleration are frame rates below 1 frame per second.
 
Any modern 3D graphics featuring OpenGL support will do. For Windows video card drivers that support OpenGL, visit the home page of your video card manufacturer. You should note that sometimes OpenGL drivers are provided by the manufacturers of the graphics chip instead of by the makers of the board. If you are going to buy a graphics card for running FlightGear, one based on a AMD/ATI Radeon or NVIDIA GeForce with an absolute minimum of 64 MByte, better 128 Mbyte might be a good choice.
 
To install the executable and basic scenery, you will need around 50 MB of free disk space. In case you want/have to compile the program yourself you will need about an additional 500 MB for the source code and for temporary files created during compilation. This does not include the development environment, which will vary in size depending on the operating system and environment being used. Windows users can expect to need approximately 300 MB of additional disk space for the development environment. Linux and other UNIX machines should have most of the development tools already installed, so there is likely to be little additional space needed on those platforms.
 
For the sound effects, any capable sound card should suffice. Due to its flexible design, FlightGear supports a wide range of [[joystick]]s and yokes as well as rudder pedals under Linux and Windows. FlightGear can also provide interfaces to full-motion flight chairs.
 
FlightGear is being developed primarily under Linux, a free UNIX clone (together with lots of GNU utilities) developed cooperatively over the Internet in much the same spirit as FlightGear itself. FlightGear also runs and is partly developed under several flavors of Windows. Building FlightGear is also possible on a Macintosh OSX and several different UNIX/X11 workstations. Given you have a proper compiler installed, FlightGear can be built under all of these platforms. The primary compiler for all platforms is the free GNU C++ compiler (the Cygnus Cygwin compiler under Win32).
 
If you want to run FlightGear under Mac OSX we suggest a Power PC G3 300 MHz or better. As a graphics card we would suggest an ATI Rage 128 based card as a minimum. Joysticks are supported under Mac OS 9.x only; there is no joystick support under Max OSX at this time.
 
====Choosing A Version ====
Previously the FlightGear source code existed in two branches, a stable branch and a developmental branch. Even version numbers like 0.6, 0.8, and (someday hopefully) 1.0 refer to stable releases, while odd numbers like 0.7, 0.9, and so on refer to developmental releases. This policy has been obsoleted by practical reasons - mostly because stable releases got out-ouf-date and behind in features very fast and the so called development releases had been proven to be of comparable stability.
 
You are invited to fetch the “latest official release” which the pre-compiled binaries are based on. It is available from http://www.flightgear.org/Downloads/.
 
If you really want to get the very latest and greatest (and, at times, buggiest) code, you can use a tool called anonymous cvs to get the recent code. A detailed description of how to set this up for FlightGear can be found at http://www.flightgear.org/cvs.html.
 
Given that the recent developmental versions on the other hands may contain bugs (…undocumented features), we recommend using the “latest official (unstable) release” for the average user. This is the latest version named at http://www.flightgear.org/News/.
 
====Flight Dynamics Models ====
Historically, FlightGear has been based on a flight model it inherited (together with the Navion airplane) from LaRCsim. As this had several limitations (most important, many characteristics were hard wired in contrast to using configuration files), there were several attempts to develop or include alternative flightmodels. As a result, FlightGear supports several different flight models, to be chosen from at runtime.
 
The most important one is the JSB flight model developed by Jon Berndt. Actually, the JSB flight model is part of a stand-alone project called [[JSBSim]], having its home at http://jsbsim.sourceforge.net/.
 
Concerning airplanes, the JSB flight model at present provides support for a [[Cessna 172]], a [[Cessna 182]], a [[Cessna 310]], and for an experimental plane called [[X15]]. Jon and his group are gearing towards a very accurate flight model, and the JSB model has become FlightGear’s default flight model.
 
As an interesting alternative, Christian Mayer developed a flight model of a hot air balloon. Moreover, Curt Olson integrated a special “UFO” slew mode, which helps you to quickly fly from point A to point B.
 
Recently, Andrew Ross contributed another flight model called [[YASim]] for Yet Another Simulator. At present, it sports another Cessna 172, a Turbo 310, a fairly good DC-3 model, along with a [[Boeing 747]], [[Harrier]], and [[A4]]. YASim takes a fundamentally different approach since it’s based on geometry information rather than aerodynamic coefficients. Where JSBSim will be exact for every situation that is known and flight tested, but may have odd and/or unrealistic behavior outside normal flight, YASim will be sensible and consistent in almost every flight situation, but is likely to differ in performance numbers.
 
As a further alternative, there is the UIUC flight model, developed by a team at the University of Illinois at Urbana-Champaign. This work was initially geared toward modeling aircraft in icing conditions together with a smart icing system to better enable pilots to fly safely in an icing encounter. While this research continues, the project has expanded to include modeling “nonlinear” aerodynamics, which result in more realism in extreme attitudes, such as stall and high angle of attack flight. Two good examples that illustrate this capability are the [[Airwave Xtreme 150]] hang glider and the 1903 Wright Flyer. For the hang glider, throttle can be use to fly to gliding altitude or Ctrl-U can be used to jump up in 1000-ft increments. Try your hand at the unstable Wright Flyer and don’t stall the canard! Considerable up elevator trim will be required for level flight. In general, the aerodynamics are probably very close to the original Wright Flyer as they are partly based on experimental data taken on a replica tested recently at the NASA Ames Research Center. Also included are two more models, a Beech 99 and Marchetti S-211 jet trainer, which are older generation UIUC/FGFS models and based on simpler “linear” aerodynamics. More details of the UIUC flight model and a list of aircraft soon to be upgraded can be found on their website at http://www.uiuc.edu/ph/www/m-selig/apasim.html.
 
It is even possible to drive FlightGear’s scene display using an external [[FDM]] running on a different computer or via named pipe on the local machine – although this might not be a setup recommended to people just getting in touch with FlightGear.
 
====About This Guide ====
There is little, if any, material in this Guide that is presented here exclusively. You could even say with Montaigne that we “merely gathered here a big bunch of other men’s flowers, having furnished nothing of my own but the strip to hold them together”. Most (but fortunately not all) of the information herein can also be obtained from the FlightGear web site located at  http://www.flightgear.org/ and from the wiki at http://wiki.flightgear.org/.
 
Please, keep in mind that there are several mirrors of the FlightGear web sites, all of which are linked to from the FlightGear homepage listed above. You may prefer to download FlightGear from a mirror closer to you than from the main site.
 
The '''FlightGear Manual''' is intended to be a first step towards a complete FlightGear documentation. The target audience is the end-user who is not interested in the internal workings of OpenGL or in building his or her own scenery. It is our hope, that someday there will be an accompanying FlightGear Programmer’s Guide (which could be based on some of the documentation found at http://www.flightgear.org/Docs; a FlightGear Scenery Design Guide, describing the Scenery tools now packaged as TerraGear; and a FlightGear Flight School package.
 
As a supplement, we recommend reading the FlightGear FAQ to be found at http://www.flightgear.org/Docs/FlightGear-FAQ.html which has a lot of supplementary information that may not be included in this manual.
 
'''We kindly ask you to help us refine this document by submitting corrections, improvements, and suggestions. All users are invited to contribute descriptions of alternative setups (graphics cards, operating systems etc.). We will be more than happy to include those into future versions of The Official FlightGear Manual.'''
 
While we intend to continuously update this document, we may not be able to produce a new version for every single release of FlightGear. To do so would require more manpower that we have now, so please feel free to jump in and help out. We hope to produce documentation that measures up to the quality of FlightGear itself
 
===Preflight: Installing FlightGear ===
To run FlightGear you need to install the binaries. Once you’ve done this you may install additional [[scenery]] and [[aircraft]] if you wish.
 
Pre-compiled binaries for the latest release are available for:
* Windows - any flavor
* Macintosh OSX
* Linux
* SGI Irix
 
To download them go to http://www.flightgear.org/Downloads/binary.shtml and follow the instructions provided on the page.
 
====Installing scenery ====
The FlightGear base package contains scenery for a small area around San Fransisco, but the entire world is available at a high level of detail, so you will almost certainly wish to install extra scenery at some point.
 
The scenery is based on SRTM elevation data (accurate to 30m in the USA, and 90m elsewhere and) VMap0 land use data. Additionally, various people have created buildings, bridges and other features to enrich the environment.
 
You can download scenery in 10 degree by 10 degree chunks from a clickable map at http://www.flightgear.org/Downloads/scenery.html.
 
Curt Olson also provides the USA or the entire world along with the latest FlightGear release on DVD from here: http://www.flightgear.org/cdrom/.
 
If you are interested in generating your own scenerey, have a look at TerraGear - the tools that generate the scenery for FlightGear: http://www.terragear.org/.
 
The most actively maintained source tree of the TerraGear toolchain is co-located at the FlightGear landuse data Mapserver: http://mapserver.flightgear.org/git/gitweb.pl.
 
Whatever scenery you shoose to download, it should be kept in a separate directory from the scenery delivered with the binaries.
 
To do this, create a WorldScenery directory in the FlightGear data directory, usually <tt>c:\Program Files\FlightGear\data</tt> on Windows or <tt>/usr/local/share/FlightGear/data</tt> on *nix.
 
Underneath this directory create Terrain and Objects subdirectories. These are used for terrain information and buildings/bridges/structures respectively.
 
Unpack the downloaded scenery into the WorldScenery/Terrain. Do not de-compress the numbered scenery files like 958402.gz! This will be done by FlightGear on the fly.
 
As an example, consider installation of the scenery package w120n30 containing the Grand Canyon Scenery into an installation located at '''/usr/local/share/FlightGear'''.
 
Once your installation is complete, you’ll have the following directories
* /usr/local/FlightGear/data/WorldScenery/Objects/ 
* /usr/local/FlightGear/data/WorldScenery/Terrain/w120n30/w112n30 
* /usr/local/FlightGear/data/WorldScenery/Terrain/w120n30/w112n31 
* ... 
* /usr/local/FlightGear/data/WorldScenery/Terrain/w120n30/w120n39 
 
As well as the scenery itself, objects such as bridges, skyscrapers, radio masts can be downloaded from http://scenemodels.flightgear.org/. See the website for more information. You can exploit FG_SCENERY environmental variable or the --fg-scenery=path command line option if you want to install different scenery sets in parallel or want to have scenery sitting in another place. These are more fully described in Chapter 3.
 
====Installing aircraft ====
====Installing documentation ====
==Flying with FlightGear ==

Revision as of 23:26, 26 August 2020

FlightGear comes with a set of illustrated documentation, known as The Manual.

Current Version

"The Manual"

This piece of documentation aims at being printed onto paper and being read as a reference while you're exploring FlightGear - or simply taken with you on a long trip.

Contributing

If you are a skilled writer and are familiar with LaTeX, please take the time to dig into the PDF or HTML version. Instructions on how to get the source code are below.

It lies in the nature of FlightGear development that The Manual is always a bit behind current development. We invite you to pick information from

  • your personal experience with FlightGear
  • the available README's in the FlightGear source tree or the Base Package or
  • the Wiki

and merge these into an appealing shape for The Manual. Turn your head to the FlightGear developers' mailing list and you'll find someone to talk about how to improve The Manual.

You'll find contacts of current maintainers in the Manual itself.

Source code

You'll find the source code here, at the FlightGear Git repository.

Retrieved from "https://wiki.flightgear.org/w/index.php?title=FlightGear_manual&oldid=127039"