xml
13,452 chars
· 327 lines
Contents:
1) Introducion
2) Installation
3) Inflight
4) Features
4.1) Disable features
5) References
6) Changelog
7) Licence/Copying
1) Introducion
==============
Basically this HUD was designed for flying choppers in Helicopter View. By now some
instruments for planes have been added as well. So it's also very usefull for un-
finished craft, e.g. if not all of the cockpit features are working.
Some of the instruments and labels blank out if not used.
Some examples: elevator pitch gauge if 0
label 'Mixture' if set to 100
Most of the instruments are just monitoring a value of the property tree and are
not specific to any plane. For example, the 'Flaps' label displays its value in
percent and does not honor the aircraft's actual scale, which most likely is stated
in degrees.
Aircraft specific instruments:
* The Osprey (v22) has one specific instrument to monitor its rotor tilt setting
and actual position.
2) Installation
===============
There might be some problems with aircraft which bring their own HUD, because at
the moment it is not possible to have two HUDs at the same time at runtime.
1) Copy the enclosed "Huds"-directory into $FG_ROOT{1}.
2) There are several ways to to tell FlightGear to use the HUDs:
2a) Using command line options:
--prop:/sim/hud/path[1]=Huds/heli.xml
--prop:/sim/hud/path[2]=Huds/heli-lil.xml
--prop:/sim/hud/path[3]=Huds/default.xml
--prop:/sim/hud/path[4]=Huds/NTPS.xml
--prop:/sim/hud/path[5]=Huds/minimal.xml
2b) Users of "fgrun" add the above lines, without the "--prop:" part, to the "Prop-
erties" section in "Advanced Options"{2}.
2c) Add said lines to .fgfsrc{3}.
3) Inflight
===========
While running fgfs use [h] to access the HUD.
[h] is also used to shift colours and turn the HUD off.
[shift]-[h] to change brightness.
Use [shift]-[i] to circle through the available HUDs and [i] to jump to first one.
4) Features
===========
The nomenclature on the attached screenshots is the same as in
http://wiki.flightgear.org/HUD
The vertical speed indicator (VSI) is erroneous in FG 1.0.0. Have a look at:
http://flightgear.org/forums/viewtopic.php?f=4&t=1943
List of all available gauges, instuments and labels even the ones that are disabled
by default (X):
Best viewed with monospaced font!
-----------------------------------------------------------------------------------
File/Function property tree (X) blanked if
-----------------------------------------------------------------------------------
Huds/heli.xml
├─Huds/Instruments/attitude-ladder.xml (X)
│ ├─Pitch input /orientation/pitch-deg
│ └─Roll input /orientation/roll-deg
│
├─Huds/Instruments/compass.xml (X)
│ └─True heading /orientation/heading-deg
│
├─Huds/Instruments/compass-dual.xml
│ ├─Magnetic Variation /environment/magnetic-variation-deg
│ └─True heading /orientation/heading-deg
│
├─Huds/Instruments/gload.xml
│ └─g-forces on pilot /accelerations/pilot/z-accel-fps_sec
│
├─Huds/Instruments/runway.xml{4} (X)
│
├─Huds/Instruments/turn-bank-indicator.xml
│ ├─Bank angle /orientation/roll-deg
│ └─Slip-Skit-Ball /orientation/side-slip-deg
├─Huds/Instruments/tbi-test.xml
│ (/instrumentation/slip-skid-ball/indicated-slip-skid * 5.7)
│
├─Huds/Sets/autopilotv1.0.0.xml (X)
│ │ (either use this *OR* autopilot.xml and gps.xml)
│ ├─/autopilot/settings/heading-bug-deg
│ ├─/autopilot/settings/true-heading-deg
│ ├─/autopilot/route-manager/wp[0..2]/id
│ ├─/autopilot/route-manager/wp[0..2]/dist
│ ├─autopilot/route-manager/wp[0..2]/eta
│ ├─/autopilot/settings/target-altitude-ft
│ └─/autopilot/settings/target-agl-ft
│
├─Huds/Sets/autopilot.xml
│ ├─/autopilot/settings/heading-bug-deg
│ ├─/autopilot/settings/true-heading-deg
│ ├─/autopilot/settings/target-altitude-ft
│ ├─/autopilot/settings/vertical-speed-fpm
│ ├─/autopilot/settings/target-agl-ft
│ ├─/autopilot/settings/target-speed-kt
│ └─/autopilot/settings/target-speed-mach
│
├─Huds/Sets/coordinates.xml
│ ├─Latitude /position/latitude-string
│ └─Longitude /position/longitude-string
│
├─Huds/Sets/gps.xml
│ ├─/instrumentation/gps/wp/wp[1]/ID
│ ├─/instrumentation/gps/wp/wp[0]/ID
│ ├─/instrumentation/gps/wp/wp[1]/distance-nm
│ ├─/instrumentation/gps/wp/wp[1]/TTW
│ ├─/instrumentation/gps/wp/wp[1]/bearing-mag-deg
│ ├─XTK:/instrumentation/gps/wp/wp[1]/course-error-nm
│ └─/instrumentation/gps/indicated-ground-speed-kt
│
├─Huds/Instruments/AMSL-label-1.xml
│ └─Altitude AMSL /position/altitude-ft
│
├─Huds/Instruments/clock-label.xml
│ ├─Time Sim local /instrumentation/clock/local-short-string
│ └─Time Sim UTC /sim/time/utc/[hour/minute] (X)
│
├─Huds/Instruments/wind-label.xml
│ ├─Wind direction /environment/wind-from-heading-deg
│ └─Wind speed /environment/wind-speed-kt
│
├─Huds/Sets/heli-controls.xml
│ ├─Aileron /controls/flight/aileron
│ ├─Elevator /controls/flight/elevator
│ ├─Engine 1 mixture /controls/engines/engine/mixture -eq 100 & -eq 0
│ ├─Engine 2 mixture /controls/engines/engine/mixture[1] -eq 100 & -eq 0
│ ├─Main rotor/Thrust /controls/engines/engine/throttle
│ ├─Propeller 1 pitch /controls/engines/engine/propeller-pitch -eq 100 & -eq 0
│ ├─Propeller 2 pitch /controls/engines/engine/propeller-pitch -eq 100 & -eq 0
│ ├─Tail rotor/Rudder /controls/flight/rudder
│ └─Elevator Trim /controls/flight/elevator-trim -eq 0
│
├─Huds/Sets/heli-labels.xml
│ ├─Flaps /controls/flight/flaps -eq 0
│ ├─Gear down /controls/gear/gear-down false
│ ├─Parking break /controls/gear/brake-parking false
│ ├─Reverser /controls/engines/engine/reverser false
│ ├─Rotorbrake /controls/rotor/brake false
│ ├─Speedbrake /controls/flight/speedbrake false
│ ├─Spoilers /controls/flight/spoilers -eq 0
│ ├─Tailhook /controls/gear/tailhook false
│ └─Tailwheel lock /controls/gear/tailwheel-lock false
│
├─Huds/Sets/heli-parameters.xml
│ ├─Airspeed kn /velocities/airspeed-kt
│ ├─Airspeed km/h /velocities/airspeed-kt * 1.852
│ ├─Engine 1 condition /controls/engines/engine/condition -eq 100 & -eq 0
│ ├─Engine 2 condition /controls/engines/engine/condition[1] -eq 100 & -eq 0
│ ├─Engine 1 rpm /engines/engine/rpm -eq 0
│ ├─Engine 2 rpm /engines/engine[1]/rpm -eq 0
│ ├─Engine 3 rpm /engines/engine[2]/rpm -eq 0
│ ├─Engine 4 rpm /engines/engine[3]/rpm -eq 0
│ ├─Radio altimeter /position/altitude-agl-ft
│ ├─Rotor rpm /rotors/main/rpm undef.
│ ├─Velocity forwards /instrumentation/gsdi/drift-u-kt (X) undef.
│ ├─Velocity sidewards /instrumentation/gsdi/drift-v-kt (X) undef.
│ └─Vertical speed /velocities/vertical-speed-fps
│
└─Huds/Sets/heli-particular.xml
├─Rotor tilt /sim/model/v22/tilt -gt -11
├─Rotor tilt preset /sim/model/v22/inputtilt -gt -11
└─Steering wheel /controls/electric/steering-toggle (X) gear-down=false
-----------------------------------------------------------------------------------
To enable the HUD's GSDI remove lines 260 (-->) and 136 (<!--) from Huds/Sets/heli-
parameters.xml.
Please, also have a look at the FlightGear-Wiki: http://wiki.flightgear.org/HUD
4.1) Disable features
=====================
To disable an instrument you dislike or don't need, find out in which file it lives
using above list of features.
Open that file with your preferred editor and search for the instruments name. The
name will be between the <name></name> tags. Those tags are surrounded by the next
higher, the instruments top level tags (e.g. <import>, <tape>, <gauge>,...).
Now comment out the whole instrument by placing a "<!--" before and a "-->" behind
those top level tags.
For an example have a look at heli.xml how the commentet out by default
"runway.xml" does look like. (Where there are no <name> tags because it includes a
complete file not just an instrument.)
5) References
=============
{1} http://wiki.flightgear.org/$FG_ROOT
{2} http://wiki.flightgear.org/File:Fgrun-wiki-a11.jpg
{3} http://wiki.flightgear.org/Fgfsrc
{4} Runway: Displays an arrow pointing to 'selected runway'.
http://wiki.flightgear.org/HUD#Big_fat_arrow
6) Changelog
============
---------------------------------------------------------------------
Changes in 0.4:
not yet released
* Renamed 'heli-lil.xml' to 'navihud.xml'
* Renamed 'README.helihud.txt' to 'README.helihud'
* Created directory 'Docs' and moved 'README.helihud' there
* Merged 'changelog.helihud.txt' with 'README.helihud'
Todo:
* make GSDI work for helis other than bo105 and ec135
* other aircraft using seperate steering wheel control? jetstar
---------------------------------------------------------------------
Changes in 0.3:
November 6th, 2013
* Moved g-load indicator
* Added km/h display
* Disabled Aerostar700 steering wheel instrument
* Engine condition position bug fixed
* Mixture and prop pitch <condition>s; hide if 100 OR 0
* A/P settings display position
* Revised README.helihud.txt, mainly instructions in "Installation"
---------------------------------------------------------------------
Changes to 0.2:
... 2012
* Fixed position of Turn-Bank-Indicator.
* Aerostar steering wheel property tree path fix.
---------------------------------------------------------------------
Changes to 0.1.5:
June 10th, 2011
* Introduced heli-lil.xml
* Reworked files and their contents. Moved instruments to other files
or created new ones:
Instruments/AMSL-label-1.xml
Instruments/wind-label.xml
Instruments/clock-label.xml
* New instrument: compass-dual.xml
* New instrument: AMSL-label-2.xml variant of AMSL-label-1.xml
* Added a second version of displaying time to clock-label.xml
Clock displaying aircrafts position local time.
* New instrument: attitude-ladder.xml
* Removed all "<property>/null</property>" (from heli-labels.xml,
heli-parameters.xml and heli-controls.xml).
* New screenshots and reworked existing ones.
---------------------------------------------------------------------
Changes to 0.1.4:
June 10th, 2011
* Added Licence GPLv2.0 (for known reasons :-/)
* Reviewed README.helihud:
** Menu
** File/Function-tree revised
** Installation procedure revised
** Added topic Disable features
* Sets/heli-particular.xml:
added steering wheel indicator to Aerostar700
* New Screenshots
* restored old autopilot.xml for optional use --> autopilotv1.0.0.xml
* added Huds/Sets/gps.xml to heli.xml
---------------------------------------------------------------------
Changes to 0.1.3:
January 12th, 2010
* Renamed readme.txt to README.helihud
* README.helihud:
new section for installation because of changes in FG's internal
HUD system.
* Sets/heli-labels.xml
Gear down indicator enabled by default
---------------------------------------------------------------------
Changes from 0.1.1 to 0.1.2:
* Sets/heli-labels.xml:
new layout of the "'left side' section"
added rpm for engines 1 - 4
changed layout on the right side, moved 'Altitude' to new position
* Sets/heli-paramters.xml:
added gsdi
---------------------------------------------------------------------
7) Licence/Copying
==================
HeliHUD, an additional HUD system for FlightGear Flight Simualtor v1.0.0 and above.
Copyright (C) 2009-2018 Alex D-HUND (D-HUND@beggabaur.rocks)
This program is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License Version 2.0 (*not* v2.2, v3.0 or whatever)
as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this
program (file COPYING.helihud.txt); if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.