Designed using Windows Notepad and a Microsoft Sans Serif, regular style, #10 font with Word Wrap enabled.
========================================
This tutorial will describe how to tweak and/or create a new effects control gauge using an existing dust effects gauge as a template. It is important to understand that when you tweak one of the original dust control gauges you are not just tweaking it for one aircraft. You are changing the throttle and/or elevation thresholds that the effects will appear and disappear at for ALL the aircraft which reference that gauge in their panel configuration files.
If you wish to make a tweak for a specific aircraft I highly suggest you create a NEW gauge using one of the original gauges as a template and reference it to the specific aircraft. Instructions on how to edit the panel.cfg file with the gauge code section/name are located in the README_FIRST.txt file.
The steps for tweaking a gauge are the same as creating a new one. The exception is you will not be making a copy of an existing gauge file and renaming it. In order to simply tweak an existing gauge, follow the same instructions below but skip down to the section, EDITING A DUST EFFECTS GAUGE FILE.
NEW GAUGE CREATION:
1. The first step to creating a custom gauge is to review the README_FIRST.txt instructions under PART 2: 3RD PARTY AIRCRAFT, GAUGE FILE SELECTION AND INSTALLATION. You must decide which of the 5 gauge files will work properly and be the closest match to the specifications of your aircraft. In some cases you may have already installed a gauge that works but requires tweaking for one aircraft and you do not wish to change the specs for all the aircraft that reference the same gauge file. In either case, once you have determined which gauge file will work the next step is to make a copy of that gauge file and rename it.
You will find the 5 gauge files installed on your system:
For FS9 (FS2004) Users:
C:\Program Files\Microsoft Games\Flight Simulator 9\Gauges\nn-gauges
For FS2002 users:
C:\Program Files\Microsoft Games\FS2002\Gauges\nn-gauges
2. Open the nn-gauges folder and locate the gauge file you wish to use as a template. Right click the file and select copy, then paste it in the same directory with the other gauge files. In example, if you copied and pasted the LargePropDustFXcontrol.xml file, you will end up with a file named:
Copy of LargePropDustFXcontrol.xml
3. Rename the file. I suggest renaming the file by adding short initials that represent the aircraft you want to associate the gauge with to the beginning of the original file name and leave the last part,
PropDustFXcontrol.xml
unedited.
In example, assuming I was making a new gauge file for a Douglas DC-X series and I am using the copied file:
By renaming it as described I have a good reference as to what aircraft the gauge is designed for and an easy reference to locate it in the folder with the other gauges. The new gauge MUST remain in the nn-gauges folder with the other gauges or the new panel.cfg gauge code line, which you must create for the aircraft based on the new file name, will not be able to access it when the aircraft is booted in the simulator.
EDITING A DUST EFFECTS GAUGE FILE
WARNING:
WHEN MAKING EDITS TO XML CODE LINES, DO NOT ADD ANY SPACES OR CARRIAGE RETURNS TO THE TEXT. TO DO SO WILL RENDER THE GAUGE USELESS. UNLESS YOU KNOW EXACTLY WHAT YOU ARE DOING, ADDING ANY OTHER CODE OR EDITS TO THE LINES MAY ALSO RENDER THE GAUGE USELESS OR CAUSE IT TO MALFUNCTION IN THE SIMULATOR.
The only edits necessary will be to the single or two digit numbers which specify the following:
a. Percent of throttle increase or reverse pitch before dust effects appear.
b. Elevation threshold of aircraft in feet from the ground where the dust effects appear and disappear.
1. Open the gauge file in notepad.
2. All dust gauges have 4 sections to them. Each section controls 1 of the 3 switched light channels (light type 8, 9 and 6, see the readme_first.txt for light type descriptions) and the [smokesystem] of the aircraft.cfg file. Each gauge is designed for a specific type and scale of aircraft and as such there may be more entries of XML code in one, than another. All gauges will have throttle and elevation threshold values with the exception of the gauge R22HeloPropDustFXcontrol.xml which reads manifold pressure instead of percent of throttle. These values can be edited or tweaked for a specific scale and type of aircraft.
The following example is taken from the MultiPropDustFXcontrol.xml gauge (without the comment):
As you can see there are 4 separate main sections. Each section has common code lines which defines that the dust effect will only show on the screen if at least one of the engines of the aircraft is running, the current throttle value is greater than a certain percent or reverse pitch is less than a specified negative value (not available in all gauges) and the aircraft is under a specified height to the ground.
The code, (A:GENERAL ENG RPM:X,rpm) 100> defines an engine is indeed running at 100 RPM or greater and this value should never need to be changed. The SURFACE CONDITION and SURFACE TYPE code references are preset values which should also NEVER be changed.
It is fairly easy to see the code lines which define the engine(s), the throttle and height of the aircraft in each section. They are:
These lines represent the positive throttle threshold:
(A:GENERAL ENG1 THROTTLE LEVER POSITION,percent) 20 > = 20% throttle and greater
(A:GENERAL ENG2 THROTTLE LEVER POSITION,percent) 20 > = 20% throttle and greater
These lines represent the negative throttle threshold or reverse pitch values:
(A:GENERAL ENG1 THROTTLE LEVER POSITION,percent) -10 < = -10% throttle and less
(A:GENERAL ENG2 THROTTLE LEVER POSITION,percent) -10 < = -10% throttle and less
This line represents the aircraft height to the ground in feet:
(A:RADIO HEIGHT,feet) 9 < = 9 feet and less to the ground
XML TERMS:
> = AND GREATER THAN
< = AND LESS THAN
3. If you wish to lower the throttle value to make the effect appear sooner, or with less throttle, find the two (ENG1 and ENG2) positive THROTTLE LEVER POSITION,percent lines in EACH of the 4 sections and edit them EQUALLY to a lower value. ONLY edit the two digit number. Do not add any spaces or remove/change any syntax!
The same editing rules apply to the negative throttle or reverse pitch values. Find the two (ENG1 and ENG2) negative THROTTLE LEVER POSITION,percent lines in EACH of the 4 sections and edit them EQUALLY to a lower value however do not remove the (-) minus sign from the value or the gauge will no longer function properly. Simply edit it to a higher or lower negative number.
The last edit is the elevation at which the effects appear and disappear. Simply raise or lower RADIO HEIGHT,feet value based on the specifications of the scale or type of aircraft... and its visual performance with the dust effects in the simulator.
With the exception of the SinglePropDustFXcontrol.xml gauge which has only 1 engine reference (ENG1), remember to edit the throttle values for each engine (ENG1 and ENG2) in ALL 4 sections and not just one.
The R22HeloPropDustcontrol.xml uses manifold pressure instead of throttle. This setting is extremely sensitive however should you wish to use the gauge for another aircraft the code line to edit for manifold pressure is:
(A:Eng1 manifold pressure,inHg) 14 > = 14hg and greater
(A:Eng2 manifold pressure,inHg) 14 > = 14hg and greater
4. Save the edited gauge. MAKE SURE it has an .XML extension on the filename and it remains in the nn-gauges folder with the other gauges.
If you have not already done so, associate the new gauge filename to your aircraft through the panel.cfg file gauge code line as defined in the Readme_first.txt file under PART 2: 3RD PARTY AIRCRAFT, GAUGE FILE SELECTION AND INSTALLATION.
