IMPORTANT!!!
This README was designed using Windows Notepad and a Microsoft Sans Serif, regular style, #10 fonts with Word Wrap enabled. If the text reader being used to view this file is not Windows Notepad and/or it is not set to display the correct font type, style and size, the alignment of the characters and lines in the examples included in this documentation will NOT display as designed. It is recommended to use Windows Notepad with the Microsoft Sans Serif, regular style, #10 fonts and enable Word Wrap to view this file or at the very least change the font in the text reader you are using to the same.
The creation of this effects package was inspired by Mal Lloyd. Mal released his Land Dust effects package a while back and shortly after asked if I might look into applying a dust effect to a controlled prop wash display and have it function automatically with the throttle, similar to my jet smoke effects. During the process of investigating the possibility of making such an effect work I began to develop a system to display dust effects which are not only throttle controlled, but environmentally controlled as well. The type of surface the aircraft is over or in contact with and the weather conditions of that surface, including cross winds, will automatically change the properties of the visual dust/misting effect in real time. The development of this project not only produced the gauges necessary to accomplish the mentioned features but also produced 25 custom visual effects files which are accessed and displayed automatically based on the type of terrain and surface conditions the aircraft is being flown over or comes in contact with in the simulation.
Mr. Lloyd's suggestions and assistance in testing throughout the development stages of this project is sincerely appreciated.
Although the gauges and effects files included in this package are my developments, the idea to use some of the aircraft light channels to create switched and controlled effects and the code which eliminates multi-keystroke command errors while monitoring and switching those channels goes to Rob Barendregt and his "Flame and Afterburner Gauge" for which I based my jet smoke effects package several months ago and who has also been of great assistance to me in education of XML gauge coding.
PERSONAL AND NON-COMMERCIAL USE LIMITATION:
Unless otherwise specified in writing, the software provided herein is for your personal and non-commercial use. You may not modify, copy, distribute, transmit, display, perform, reproduce, publish, license, to create derivative works from in order to transfer and sell any information, software, products or services obtained from the use or review of this software package.
NO UNAUTHORIZED DUPLICATION, MODIFICATION OR REPACKAGING IS PERMITTED WITHOUT WRITTEN CONSENT AND/OR THE WRITTEN CONSENT OF THE AUTHOR(S) WHOS WORK IS INCLUDED AND DEFINED HEREIN AND HERETO. AS FREEWARE THIS GAUGE/EFFECT OR ANY OF THE INDIVIDUAL CONTENTS OF THE FILE(S) CANNOT BE REPRODUCED, IN PART OR WHOLE, FOR ANOTHER FREEWARE PACKAGE OR USED IN ANY PACKAGE THAT REQUIRES, SUGGESTS OR PERPETUATES A PURCHASE OR SALE OR ANY FORM OF COMPENSATION OR TRADE.
DISTRIBUTION
Only the websites and/or companies I have given expressed written consent to distribute this effects package are authorized to distribute it as FREEWARE. An authorized distributor falls under the same distribution guidelines as defined above. The end user is authorized to use this package strictly for personal use in conjunction with MS Flight Simulators. Proper acquisition of expressed written consent is required before reusing this effect, in part, in whole or in any other fashion in order to avoid legal issues from unauthorized reproduction and distribution.
DISCLAIMER:
All Microsoft products and the effects code used in the custom designed effects files contained herein are the property of Microsoft Corporation through the terms of the Flight Simulator End User License Agreement and are protected by registered trademarks or trademarks of Microsoft Corporation in the U.S. and/or other countries. No intent to defraud or illegally use the Microsoft trademark, its software, code, name or secure any income or compensation from the production of this effects package is expressed or implied with the creation of this effects package and supporting files. Any other company names, names of authors or their work displayed in this package are for reference only. Unless otherwise specified, no connection to them or their products is expressed or implied. The author of this software or the site it was downloaded from is not responsible for any damage that may result from its installation or use.
Any feedback, comments, suggestions or support issues should be directed to:
Nick Needham
klondikekit@yahoo.com
I sincerely hope the flight simulator community enjoys this awesome effect. Sincere thanks from me go out to everyone who has donated their valuable time to create flight simulator software for the community.
*************************** KNOWN ISSUES *******************************
Nothing serious but please read the KNOWN_ISSUES.txt file.
The level of quality your *Effects Detail Slider* is set to in the display settings of the simulator will have a direct bearing on how much ground detail the effects display for water splashing, dirt, gravel and sand produced from the langing gear/or aircraft skids. Although the ground/water contact effects will work when the slider set to minimum, a display setting of medium or greater is required to see the full range and detail of the ground level effects. With the effects slider set to maximum, viewing and zooming too visually close to the aircraft model during hard and heavy impacts with water can result in splashes which are rendered as momentary screen *wash-outs*. This is because you are viewing too close to the aircraft and getting splashed -or- water misted in the face!
Most users will have absolutely no problems at all using these effects however I have put together the known issues list so you are aware of everything that I know of and how, if possible, to fix it should a problem arise.
Please read that file before emailing me for assistance. ;0)
It covers just about any issue you may come across.
There is a bit more involved with installing this package than just installing the effects files and gauges to your Flight Simulator installation. Without actually reading and just browsing through this file, the following instructions may appear long and complicated because of the amount of information I included below. They are not complicated. I simply went into simplistic 1 - 2 - 3 step detail with the instructions for the benefit of individuals who may not be versed in editing configuration files and for those out there who may need detailed specifications as to the line edits, gauges and effects files provided with this package for the purpose of adding the effect to 3rd party aircraft. Anyone experienced in editing panel.cfg and aircraft.cfg files knows the editing process is easy to accomplish and can be done in a matter of minutes.
This is a complicated effect and as such the instructions are a bit long in explanation but necessary to be sure everyone has all the information they need to successfully install, tweak, and the most important part... to enjoy them.
IMPORTANT NOTE:
For ease and speed of installation I have included a file named MS_AIRCRAFT.txt which contains all the edits needed for the configuration files of the Microsoft prop aircraft installed by default with Microsoft Flight Simulator. I will explain the use of that file shortly. In learning how to manually apply the effects to 3rd party aircraft, once it is understood how to select the right gauge for the aircraft, understood how to visually locate the effect to the aircraft in the simulator and the process has been repeated a few times, what appears to be a long list of instructions will only take a few minutes accomplish.
This effects package is the result of over 150 hours of research, development and testing.
Unzipping this downloaded NicksPropDust.zip -or- NPD.zip to a location of your choice will produce the following files inside a NicksPropDust folder:
a. NicksPropDust_FS2004.exe = For automatic FS9 (2004) Installs
b. NicksPropDust_FS2002.exe = For automatic FS FS2002 Installs
c. Images directory = includes pictures of the effect in action
d. TWEAK_IT.txt = A tutorial on how to tweak and/or create custom dust control gauges from the ones provided in this package.
e. screenshot.jpg or screenshot.gif = Introduction Image
f. FILE_ID.DIZ = A synopsis of the effect
g. README_FIRST.txt = This instruction file and tutorial
h. KNOWN_ISSUES.txt = If you have not already done so, you may wish to review it.
i. MS_AIRCRAFT.txt = A complete set of aircraft and panel configuration edits ready to use for all the Microsoft prop aircraft included with Flight Simulator. This tutorial includes instructions on how to properly copy/past the provided code lines in the MS_AIRCRAFT.txt file to the aircraft.cfg and panel.cfg files of the identical Microsoft prop aircraft installed with Flight Simulator on your system.
AUTOMATIC .xml GAUGE AND DUST EFFECT FILE INSTALLATION:
(If you prefer manual installation, not recommended for inexperienced users, it is described below this step)
The following files will install the needed effects files and gauges to their proper location.
For ease of installation I the provided two automatic installation files in this package:
a. Simply double click the .exe file for your version of Flight Simulator and a WinZip box will appear which is preset to install the needed files to the proper Flight Simulator directories as shown below:
For FS9 (FS2004) Users:
C:\Program Files\Microsoft Games\Flight Simulator 9
For FS2002 users:
C:\Program Files\Microsoft Games\FS2002
b. When the Winzip window appears click "unzip" and allow the contents to extract directly into the directories. If your version of Flight Simulator is located other than where I have indicated above you MUST browse the Winzip extractor manually to the correct location.
c. Skip down to STEP 2 located below the MANUAL GAUGE AND EFFECT FILE INSTALLATION heading.
MANUAL GAUGE AND EFFECT FILE INSTALLATION ONLY:
(Not recommended for inexperienced users)
a. Choose the proper .exe file for your version of flight simulator and double click it. MANUALLY browse and extract it to a location other than your main FS directory. There will be 2 main directories extracted and 1 sub directory:
Gauges\nn-gauges -and- Effects
b. Open the \Gauges directory and inside you will find a folder named: nn-gauges. Copy the ENTIRE nn-gauges folder into the \Gauge folder of your main Flight Simulator directory. This should be:
For FS9 (FS2004) Users:
C:\Program Files\Microsoft Games\Flight Simulator 9\Gauges
For FS2002 users:
C:\Program Files\Microsoft Games\FS2002\Gauges
If your version of Flight Simulator is located other than where I have indicated above you MUST browse manually to the correct location.
WARNING: DO NOT COPY/PASTE THE ACTUAL GAUGE FILES LOCATED INSIDE THE nn-gauges FOLDER INTO THE FLIGHT SIMULATOR GAUGE FOLDER. COPY THE ENTIRE FOLDER nn -gauges AND PASTE IT INSIDE THE FLIGHT SIMULATOR GAUGE FOLDER JUST THE WAY IT IS.
c. Open the Effects directory from the manually decompressed zip file. Copy all the files into the following directories:
For FS9 (FS2004) Users:
C:\Program Files\Microsoft Games\Flight Simulator 9\Effects
For FS2002 users:
C:\Program Files\Microsoft Games\FS2002\Effects
Because many users may have added repaints and other additions to their Microsoft aircraft I did not provide edited copies of the aircraft.cfg and panel.cfg files in this package for quick overwriting of the originals. Although easier to install, to do so would overwrite any upgrades or repaints to those aircraft. Instead I created the MS_AIRCRAFT.txt file so the individual sections of the configuration files could be edited without loosing any other information in your existing configuration files and retain any upgrades added to your current livery of prop aircraft.
This section about editing the configuration files is designed in 2 parts. The first section is a tutorial for enabling the effects for the prop aircraft installed automatically with the Microsoft Flight Simulator software. The second is for manually adding and enabling the effects for 3rd party aircraft and in so doing, understanding the detailed technical aspects of how this entire system works. If you are applying these effects to a 3rd party aircraft for the first time I suggest you may wish to review the first section which includes pre-edited and ready to copy/paste configuration code for editing the aircraft.cfg and panel.cfg files. It is also suggested to apply the effect to a few of the Microsoft aircraft as described in section 1. This will allow you to see functioning examples of the code lines for different types of aircraft which should make the instruction process of adding the effects manually to any 3rd party aircraft a bit easier to understand.
When installing the effects to 3rd party aircraft, although you may refer to the MS_AIRCRAFT.txt file for examples and use them as a basic templates, you can NOT directly copy/past the configuration code from the MS_AIRCRAFT.txt file to a 3rd party aircraft configuration file without properly editing the lines because each aircraft has specific code for engine location, gauge file, effects scale and aircraft type which varies from aircraft to aircraft.
Friendly Reminder:
REMEMBER TO ALWAYS BACKUP ANY CONFIGURATION FILES THAT YOU EDIT AS YOU GO ALONG PRIOR TO MAKING CHANGES. The easiest way to do this is simply right click the aircraft or panel.cfg file before editing and select copy, then paste it in the same directory. This will create copies of your original configuration files named:
Copy of aircraft.cfg -or- Copy of panel.cfg
...ready to be restored if needed.
***** PART 1 *****
MICROSOFT PROP AIRCRAFT INSTALLED WITH FS2002 and FS2004:
At this point there must be line edits made to the panel and aircraft.cfg files for the aircraft you wish the effects to appear with. As mentioned above, for ease and speed of installation, with this package I have included an MS_AIRCRAFT.txt file which includes all the proper edits needed for the Microsoft prop type aircraft which come installed with Flight Simulator. I also included 3 selected 3rd party aircraft and links as to where to get them on the internet in that file as well. I will describe in detail below how to make those simple and complete copy/paste edits to your matching Microsoft configuration files.
1. Open the MS_AIRCRAFT.txt file provided with this package. Each aircraft section of that file will provide a complete copy/paste area of all the needed edits of both the aircraft.cfg and the panel.cfg files for the named aircraft. You will notice each aircraft section is separated into 2 parts:
a. AIRCRAFT CONFIGURATION FILE EDITS:
There are three [HEADINGS] with supporting code under them in each aircraft configuration file edit section:
[LIGHTS]
[SMOKESYSTEM]
[EFFECTS]
b. PANEL CONFIGURATION EDIT:
There is one [HEADING] with the supporting code for the gauge file under it in each panel configuration edit section:
[VCockpitXX]
This is the gauge code section that must be added to the panel.cfg file. There can be more than one entry necessary if the aircraft has several different panel variations. This section will note the multiple entries and let you know if there are any.
I will start with the AIRCRAFT CONFIGURATION FILE EDIT section. For the purpose of example in this tutorial, I will use the Beech Baron 58 and apply the effect to that aircraft. For other Microsoft aircraft, simply replace the references to the Beech Baron 58 in this tutorial to the aircraft you wish to install the effects for. The first entry in the MS_AIRCRAFT.txt file is the Beech Baron 58. Locate the AIRCRAFT CONFIGURATION FILE EDIT section for the Beech Baron 58.
2. In the \Aircraft directory of your main Flight Simulator installation, open the folder: beech_baron_58, then open the aircraft.cfg file located inside that directory in notepad. You should now have both the MS_AIRCRAFT.txt open to the Beech Baron aircraft configuration edit section and the aircraft.cfg file for the Beech Baron 58 installed on your system.
3. Scroll down and locate the [LIGHTS] section of your aircraft.cfg file for the Beech Baron 58. The MS_AIRCRAFT.txt file will have a matching [LIGHTS] section which includes the edits for the effects files. Copy the [LIGHTS] heading and the entire list of light codes below that heading from the MS_AIRCRAFT.txt file and overwrite the entire [LIGHTS] section of the aircraft.cfg file for the Beech Baron 58.
4. Since the Beech Baron 58 has no [SMOKESYSTEM] simply add it to the aircraft.cfg file below the [LIGHTS] section. Copy the [SMOKESYSTEM] heading and supporting code lines under it from the MS_AIRCRAFT.txt file and past it below the [LIGHTS] section of the aircraft.cfg file, leaving a few spaces between the heading and the bottom of the [LIGHTS] list.
IMPORTANT NOTE
Most of the Microsoft prop aircraft do not have a [SMOKESYSTEM] however the ones that do such as the Extra 300 (Patty Wagstaff's Airplane) will require the existing [SMOKESYSTEM] entry be overwritten. As mentioned in #4 of the KNOWN_ISSUES.txt file, the [SMOKESYSTEM] is used for deep ice, snow and water blowing effects and if you do not overwrite the existing entry both the dust effects and the pre-existing smoke effect could appear during snow, ice and water landings which would not look right. It could also have the opposite effect and the snow ice and water effects could be rendered useless.
Make sure to overwrite the existing [SMOKESYSTEM] of any aircraft you add these effects to.
In order to be sure the aircraft you are working with has no [SMOKESYSTEM] and/or you do not miss the entry, with the aircraft.cfg file open in notepad, from the edit menu select "FIND" then have it search for: [SMOKESYSTEM] The same search method can be used to quickly locate any heading in the file.
5. Scroll down and locate the [EFFECTS] section of your aircraft.cfg file for the Beech Baron 58. The MS_AIRCRAFT.txt file will have a matching [EFFECTS] section which includes the edits for the effects files. Copy the [EFFECTS] heading and the entire list of code lines below that heading from the MS_AIRCRAFT.txt file and overwrite the entire [EFFECTS] section of the aircraft.cfg file for the Beech Baron 58.
6. Save the aircraft.cfg file
b. PANEL CONFIGURATION EDIT:
Next, find the PANEL CONFIGURATION EDIT section for the Beech Baron 58 in the MS_AIRCRAFT.txt file.
1. In the beech_baron_58 folder of your main FS installation there is a folder named: Panel. Open the Panel folder, then open the panel.cfg file located inside that directory in notepad. You should now have both the MS_AIRCRAFT.txt open to the Beech Baron panel configuration edit section and the panel.cfg file for the Beech Baron 58 installed on your system.
2. Under the PANEL CONFIGURATION EDIT section for the Beech Baron 58 in the MS_AIRCRAFT.txt file you will see the following:
This entire code section must be properly placed in the panel.cfg file for the Beech Baron 58. It must be typed or copy/pasted from the MS_AIRCRAFT.txt file exactly as it is displayed. Improper location, typo errors of the code lines or gauge file name, or any numbering or syntax errors in that section will render the gauge totally useless and cause the effects to display constantly on the screen with no throttle control. (#6 KNOWN_ISSUES.txt)
For the benefit of those who have never edited a panel.cfg file before, below there is a shortened example of my Beech Baron58 panel.cfg file which will demonstrate the following instructions:
3. In the panel.cfg file, Scroll down to almost the end of the file and look for the last:
[VCockpitXX]
... heading entry. The XX in the name above is the heading number. There will be a list of supporting code with a gauge list below the heading. At the very end of the last [VCockpitXX] section, start the new heading. Copy/paste the entire code section provided in the PANEL CONFIGURATION EDIT section for the Beech Baron 58 in the MS_AIRCRAFT.txt file to the Beech Baron panel.cfg file. Review the example below to clarify the instructions above:
NOTE:
In cases where there are NO virtual cockpit entries in the panel.cfg file such, as some 3rd party aircraft, simply add the entire section at the very end of the last [WindowXX] section.
Follow the notes: <-------------*** instructions*** as shown below in this sample panel.cfg file:
The Beech Baron 58 panel.cfg file:
===================================
// Panel Configuration file
// Beech Baron 58
// Copyright (c) 2001-2003 Microsoft Corporation. All rights reserved.
[Window Titles] *** Scroll down toward the end of the file ***
Window00=Main Panel
Window01=Radio Stack
Window02=GPS
|----------------------------------------> *** I edited out most of this panel.cfg file to shorten this example ***
[VCockpit03] <-------------------------------*** Locate the LAST original VCockpit entry ****
size_mm=256,256
pixel_size=256,256
texture=$Beech_Baron_3
background_color=0,0,0
[VCockpit04]<----*** Edit in the entire new code section and make sure it is properly numbered in the list based the one above*
size_mm=512, 512
pixel_size=512,512
texture=$h_cluster
background_color=0,0,0
visible=0
gauge00=nn-gauges!MultiPropDustFXcontrol.xml, 0,0
+++++++++++++++++++++++++++++++++END OF panel.cfg FILE EXAMPLE
Note the LAST original numbered VCockpit entry. Below that last section is where you want to edit in the new dust gauge VCockpit code section. Dont forget to verify the new VCockpit section number is in the proper numerical sequence with the one above it. The Beech Baron 58 should be [VCockpit04] however if for some reason your panel.cfg is numbered differently make sure the new code line is in the correct numerical order with the list. Change the number if necessary. The numbering system is as follows:
[VCockpit01] <----NOTE: If there are no orignal VCockpit entries, your new VCockpit section will be numbered 01
[VCockpit02]
[VCockpit03]
[VCockpit04]
[VCockpit05]
..and so on
4. Save the edited panel.cfg file.
The Beech Baron 58 is now ready to go!!
Repeat the above steps if you wish to install the effects for any other Microsoft prop aircraft or one of the 3rd party aircraft noted in the MS_AIRCRAFT.txt file
REMEMBER!!!! dust will not appear on dry concrete, asphalt and other dry manufactured runway surfaces. Those surfaces will however display snow and water effects when the surface conditions change with the weather. Slip off the runway and onto the short grass or hard turf at most airports and you should see the dust from that surface come to life!
Should you wish more technical details as to the gauges, code lines and effect files, See PART 2 below which is the section for manually installing the files to 3rd party aircraft.
++++++++++++
BONUS: Aussie Red Dust!
++++++++++++
For those who prefer a much deeper red or rusty dust for clay dry mud and other such environments I created a complete set of darker red dust files for all types/scale of aircraft. They were installed with this package and can replace the default DIRT dust files. In order to switch to the deep red dust you will need to make a few simple file name edits to the [LIGHTS] and [EFFECTS] sections of aircraft.cfg file which you created from the instructions in this tutorial.
NOTE:
Different scale or types of aircraft have different file extensions. The file names represent different properties in the effects files. It is not necessary to do so at this point however if at some time you would like to see a complete description of all the effects file names and how to identify each one, refer to the: DUST EFFECTS (.fx) FILE IDENTIFICATION section located at the very end of this README_FIRST.txt file.
So you understand the basics, please review the following:
Effects File Name Extensions
File extension _h = Helicopter ONLY
File extension _m = Massive (scaled for C-130 Military and massive commercial transport planes ONLY)
File extension _s or no extension listed = Standard (Used for all other planes)
1. Open the previously edited aircraft.cfg file for the aircraft you wish to make the color change.
2. Scroll down to the [LIGHTS] section
3. Locate the light lines that have the following effects file name at the end of the lines. The number of duplicated entries (number of engines) and the file name extension will be different based on the type/scale of aircraft you are editing the effect into. ONE of the three file names below will be listed at the end of the line(s). Simply match the names you see below and edit them with the replacement Aussie Red dust file. Make sure you do not edit out any comas or other syntax. You may copy the replacement filenames directly from the following:
If the file name in the [LIGHT] line(s) is:
fx_nickspropdust_dirt_s
For Aussie Red dust replace this file name with: fx_nickspropdust_redirt_s
fx_nickspropdust_dirt_m
For Aussie Red dust replace this file name with: fx_nickspropdust_redirt_m
fx_nickspropdust_dirt_h
For Aussie Red dust replace this file name with: fx_nickspropdust_redirt_h
4. Scroll to the [EFFECTS] section of the aircraft.cfg file.
5. Locate the line under the [EFFECTS] heading: dirt=
The file name extension will be different based on the aircraft you are editing. One of the two file names below will be listed at the end of the DIRT= line. Simply match the name you see below and edit them with the replacement Aussie Red dust file.
If the file name in the DIRT= line is:
fx_nicks_tchdirt
For Aussie Red dust replace this file name with: fx_nicks_tchdirt_red
fx_nicks_tchdirt_m
For Aussie Red dust replace this file name with: fx_nicks_tchdirt_red_m
6. Save the edited aircraft.cfg file
Youre now ready to go... the dirt, dry mud and earth dust effects will now be a darker red rusty color!
============================================
***** PART 2 *****
3RD PARTY AIRCRAFT:
3rd party aircraft installations will be a bit more difficult. I have provided complete descriptions of the gauges, individual effects files, and all the code line edits needed for custom installation for 3rd party aircraft in the next sections. In order to set up a 3rd party aircraft it must be understood how to:
A. GAUGE FILE SELECTION AND INSTALLATION:
Select the proper gauge for the type/scale of aircraft and properly edit the code it into the panel.cfg file for the aircraft.
B. AIRCRAFT.CFG [LIGHTS] AND [SMOKESYSTEM] EDITS:
Associate the correct number of [LIGHT] section entries and [SMOKESYSTEM] entries for the number of engines the aircraft has, and edit in the correct type/scale effects file for each new code line created under the mentioned headings. Properly locate the effect in relative position to the prop/engine of the aircraft/ground and edit the code line(s) X-Y-Z location so it looks visually correct on the screen.
C. AIRCRAFT.CFG [EFFECTS] EDITS:
Select the proper [EFFECTS] section entries and associate the proper scale/type of effect file for the aircraft you are working with in the aircraft.cfg file.
It may sound complicated but it is not that difficult to accomplish. I will describe in detail how to accomplish all 3 steps in the order they were presented above...
A. GAUGE FILE SELECTION AND INSTALLATION:
The following 5 gauge files were installed when you ran the Winzip installation .exe for this effects package. The first consideration you MUST make in order for the dust effects to properly appear and function with a 3rd party aircraft is decide which gauge file will work properly for your specific aircraft. Each gauge file is designed for a specific type and scale of aircraft. If the aircraft and the gauge file are not compatible the effects will either not function at all or will not function properly with the aircraft (see #3 KNOWN_ISSUE.txt).
Below is a complete description of each installed gauge so you may match the specifications of your 3rd party aircraft to a gauge:
Gauge file name:
HeloPropDustFXcontrol.xml
This gauge is used for helicopters ONLY. It will work with single or twin engine (main rotor) choppers. It is designed to activate with 20% throttle or greater. Reverse pitch is not supported. The rotor wind effect will appear or cease when the helo is at a 30 foot elevation to the ground/water or less. (30ft and below = wind on 30ft and above = wind off) The dust/mist effect will appear or cease when the helo is at a 24 foot elevation to the ground/water or less. (24ft and below = dust/mist on 24ft and above = dust/mist off)
R22HeloPropDustFXcontrol.xml
This gauge is used for the Robinson R22 helicopter. This gauge is used for helicopters ONLY. It will work with a single or twin engine (main rotor) choppers but reads the manifold pressure instead of throttle lever percent. I had some problems getting the Robinson R22 to respond to throttle code so I programmed this gauge to respond (effects enabled) when the manifold pressure is above 14hg. The rotor wind effect will appear or cease when the helo is at a 30 foot elevation to the ground/water or less. (30ft and below = wind on 30ft and above = wind off) The dust/mist effect will appear or cease when the helo is at a 24 foot elevation to the ground/water or less. (24ft and below = dust/mist on 24ft and above = dust/mist off)
LargePropDustFXcontrol.xml
This gauge is used for ALL planes that have 2, 3, or 4 engines AND that have a prop or engine center that measures 10 feet or HIGHER from the ground in the simulator. Large military (C-130 scale) or commercial transports, Douglas DC-3, The Ford Tri-Motor, etc fall under this specification. It is designed to activate with 13% throttle or greater or 10% reverse pitch or more. The dust will appear or cease when aircraft is at a 16 foot elevation to the ground/water or less. (16ft and below = dust/mist on 16ft and above = dust/mist off)
MultiPropDustFXcontrol.xml
This gauge is used for ALL planes that have 2, 3 or 4 engines AND that have a prop or engine center that measures 8 feet or LESS to the ground in the simulator. Most small twin or tri prop aircraft fall under this specification. It is designed to activate with 20% throttle or greater or 10% reverse pitch or more. The dust will appear or cease when the aircraft is at a 9 foot elevation to the ground/water or less. (9ft and below = dust/mist on 9ft and above = dust/mist off)
SinglePropDustFXcontrol.xml
This gauge is the same as the MultiPropDustFXcontrol.xml except it is designed for small planes that have only ONE engine AND that have a prop or engine center that measures 8 feet or LESS to the ground in the simulator. Most small single prop aircraft fall under this specification. It is designed to activate with 20% throttle or greater. Reverse pitch is not supported. The dust will appear or cease when the aircraft is at a 9 foot elevation to the ground/water or less. (9ft and below = dust/mist on 9ft and above = dust/mist off)
I have found the above selection of gauges have worked for all the aircraft I properly applied them to. I designed the set to cover the specifications for the majority of aircraft out there however if your 3rd party aircraft does not meet one of the above specifications -or- the effects are not appearing/disappearing at a proper elevation -or- the throttle level for the aircraft and you need to create a custom gauge for your aircraft, please refer to the TWEAK_IT.txt file located in this package for custom gauge creation and editing.
Once the proper gauge is selected based on the mentioned aircraft specifications you must edit the gauge code line and then place the entire code section as shown below into the correct location of the panel.cfg file for the aircraft. The following was made for copy/paste into your 3rd party aircraft panel.cfg file. The panel.cfg code section with the gauge line is:
Lets assume you have a 3rd party plane that matches the MultiPropDustFXcontrol.xml file specifications from the gauge information provided above. Edit the gauge code line of the [VCockpitXX] section with the file name: MultiPropDustFXcontrol.xml
If the example were a single engine Piper Cub or other aircraft of that scale and class it would reflect the file name SinglePropDustFXcontrol.xml since the Piper falls under the specifications of the SinglePropDustFXcontrol.xml gauge.
Next, The XX in the [VCockpitXX] heading above represents the next number in the VCockpit list sequence of the panel.cfg file. The proper VCockpit number must be edited in place of the XX of the [VCockpitXX] heading. From the instructions provided in PART 1, section b under PANEL CONFIGURATION EDIT about inserting the code section to the panel.cfg file, lets assume this is the Beech Baron58. Opening the Beech Baron58 panel.cfg file and locate where the code section properly belongs as per the instructions. You should find the last VCockpit number in the Beech Baron58 panel.cfg list to be [VCockpit03] so the new heading number will be [VCockpit04] and the entire section will be edited in at the very end of the [VCockpit03] section below its list of supporting code/gauge lines.
In cases where there are NO [VCockpitXX] entries in your 3rd party aircraft panel.cfg file simply add the entire section at the very end of the last [WindowXX] section and number it: [VCockpit01]
Edit the gauge line with the gauge file name your aircraft requires, place it where it belongs in your 3rd party aircrafts panel.cfg file and properly number it based on the VCockpit sequence. If you need detailed assistance in making this entry refer to the instructions provided above in PART 1, section b under: PANEL CONFIGURATION EDIT
NOTE: Typo errors of the number, code lines, gauge file name itself, or any syntax errors will render the gauge totally useless and cause the effects to display constantly on the screen with no throttle control.
********************
B. AIRCRAFT.CFG [LIGHTS] AND [SMOKESYSTEM] EDITS:
Next the aircraft.cfg file must be properly edited so the prop dust effects will show up on the screen. This is accomplished through the [LIGHTS] and [SMOKESYSTEM] sections of the aircraft.cfg file.
This is where it is important to understand what it is you are adding to your aircraft in the way of visual effects and how to properly locate them behind and/or under the planes props on the screen. You should have already selected the proper gauge for the aircraft based on what type of aircraft it is (plane or helo) and in the case of an airplane, how many engines the aircraft has and approximately how high the center of the props are from the ground. In this next section I will demonstrate how to take that same information and determain which effects files are designed/scaled for your aircraft, then edit the aircraft configuration file so the effects will be displayed behind all of the engines/props the aircraft uses.
THE [LIGHTS] SECTION:
The [LIGHTS] section edits are the most difficult of all the edits to make especially if you do not understand the different light types and how they are noted/referenced in the [LIGHTS] list for locating the effect to the aircraft model. I will explain how the light code lines work.
Open the MS_AIRCRAFT.txt file provided in this package. Scroll down to the first aircraft entry which is the Beech Baron 58. Look at the [LIGHTS] heading. You will notice a header that looks like this:
The first row of information below the [LIGHTS] heading are the *Light Types* available to the aircraft. I also call these *Light Channels* because they can be switched on and off through a switch or XML gauge. What is missing from the above line are all the available light channels. Microsoft left out 4 more available light types in the line above and it should actually read like this:
In order to have the ability to change effects and colors based on conditions it required a *switched* output to work with so the light channels became the switches. This effects package uses light types 6, 8 and 9 from the line above. That is why the taxi, wing and logo lights are not available when the effects are applied to an aircraft that normally makes use of those light types (see #1 KNOWN_ISSUES.txt). Now that you understand what all the light types are, the following will be a bit easier to explain.
With the exception of the effects filenames themselves the dust effects are defined for ALL aircraft as shown below. The gauge switches the light and smokesystem channels on and off based on the real time surface type and surface conditions the aircraft is over/on. The following light channel reference a dedicated list and cannot be changed without editing the gauge file itself:
Channel effect for aircraft type Turns On
Light Type 8 = fx_nickspropdust_dirt_X - dirt, dry mud, clay surface types prop dust
Light Type 9 = fx_nickspropdust_gravsnd_X - gravel, sand and short grass surface types prop dust
Light Type 6 = fx_nickspropdust_watrsno_X - water, snow and ice surface conditions prop mist
[SMOKESYSTEM] = fx_nicks_watrsnoland_X - water, snow and ice surface types prop dust
The last switched channel is the [SMOKESYSTEM] which will be discussed in detail after this section.
Next, looking at the supporting code lines under the [LIGHTS] heading of the Beech Baron 58 in the MS_AIRCRAFT.txt file you will see notations, (in example: // Engine 1 dirt, dry mud, clay surface types prop dust ), that match the above list. You will also notice that there are duplicated entries for each light type. Each duplicated light type entry represents a separate engine. You must make a duplicate line for the number of engines your aircraft has in order to get a dust blowing effect behind each engine. The Beech Baron has 2 engines and therefore there will be 2 code lines for each light channel or a total of 6 entries in all under the [LIGHTS] heading for prop dust/mist. If the Beech Baron were a 4 engine or prop aircraft there would be 4 entries for each light channel or a total of 12 entries in all. For a reference to a 4 engine aircraft, scroll down to the end of the MS_AIRCRAFT.txt file and look at the Lockheed C-130 [LIGHTS] section.
To understand how the simulator references the light type to the other data of the line,... below is an example of a single code line which would be found under a typical [LIGHTS] heading in the aircraft.cfg file:
light.10=8, -10.4, -6.3, -6.0, fx_nickspropdust_dirt_s
A B C
This line is decoded as follows:
light.XX=Y, A, B, C, fx_filename_surface_aircraft-type
**** KEY: ***
light.XX - is the numerical order of the light in the list
=Y, - is the light type that is being switched on and off
A, B, C, - is the X,Y,Z location of the center of the effect in reference to the aircraft
fx_filename_surface_aircraft-type:
- is the effects file name to be played which is designed for surface type/conditions and the scale/type of aircraft
Assuming you wish to install the effects to a 3rd party, typical 2 engine aircraft, the first step is to continue the [LIGHTS] list of your 3rd party aircraft.cfg file and add the following code lines. This is a 2 engine example:
light.XX=8, A, B, C, fx_nickspropdust_dirt_X // Engine 1 dirt, dry mud, clay surface types prop dust
light.XX=8, A, B, C, fx_nickspropdust_dirt_X // Engine 2 dirt, dry mud, clay surface types prop dust
light.XX=9, A, B, C, fx_nickspropdust_gravsnd_X // Engine 1 gravel, sand and short grass surface types prop dust
light.XX=9, A, B, C, fx_nickspropdust_gravsnd_X // Engine 2 gravel, sand and short grass surface types prop dust
light.XX=6, A, B, C, fx_nickspropdust_watrsno_X // Engine 1 water, snow and ice surface conditions prop mist
light.XX=6, A, B, C, fx_nickspropdust_watrsno_X // Engine 2 water, snow and ice surface conditions prop mist
Where XX in the lights.XX entries above is the next light in numerical order based on the existing [LIGHTS] list you are attaching it to in your 3rd party aircraft.cfg [LIGHTS] section. If you have a 3 engine aircraft you would make 3 duplicate effects lines for each light type. Three light.XX=8, three light.XX=9 and three light.XX=6 entries. 4 engines, 4 duplicate effects lines. Single engine aircraft would only have one line for each light type and effect. For examples of these duplicated or single engine entries, see the MS_AIRCRAFT.txt file and browse the different aircraft [LIGHTS] sections.
Next...
The A, B, C I placed in the code lines above is the X-Y-Z location where the effect will appear in reference to the aircraft. Locating the effect to the aircraft is VERY IMPORTANT. If it is located too high it will look like exhaust instead of ground dust. If located too low it will get lost in the ground. Too far left or right and it will not appear lined up with the prop(s). I have developed a simple formula/method for quickly finding these location values:
Open the aircraft.cfg file for your 3rd party aircraft in notepad. Scroll down the list or use the *find* feature in notepad to locate the following heading: [GeneralEngineData] Under that heading you will find something that looks like the following entries.
note:
The A B C demonstrates the matching location reference to the light code lines from above:
[GeneralEngineData]
Engine.0 =12.00, -12.50, 6.00 <---This is engine 1
Engine.1 =12.00, -4.00, 6.00 <---This is engine 2
Engine.2= 12.00, 4.00, 6.00 <---This is engine 3
Engine.3= 12.00, 12.50, 6.00 <---This is engine 4
A B C
I made the above a 4 engine example so you have a reference to the code numbering method. Engine #1 is always Engine.0= in the sim, NOT Engine.1=. The numbers following all the Engine.X= entries are what we will use to properly locate the effects for each engine in the [LIGHTS] section lines noted as: A, B, C, BUT first there is a bit of subtraction that must take place because the dust needs to come from the ground and not the engine!
The formula for finding the proper effect location from the [GeneralEngineData] is as follows:
Rule #1:
For any aircraft that uses the following gauges:
... subtract 10 from the third number of each engine line: A , B , C-10,
So assuming you have a 2 engine 3rd party aircraft which you have matched the specification of the MultiPropDustFXcontrol.xml gauge to the aircraft, the following will be the correct entries for A, B, C for each engine (light type) in the code lines below using the information from the [GeneralEngineData] in your aircraft.cfg file and formula above:
The next step is to properly reference the effects filenames above, which at this point all have an X at the end of their names. They must be referenced to the scale and the type which match your 3rd party aircraft. I designed effects files for different scale and/or types of aircraft so the effect would visually match the propeller or rotor wind physics of the aircraft being flown. Each type has a different file extension which replaces the X in the filenames above.
So you understand the basics, please review the following effects file name extension key:
(replaces the _X in the effects filenames)
File extension _h = All Helicopters - Only
File extension _m = Massive (scaled for C-130 Military and massive commercial transport planes - ONLY)
File extension _s = Standard (Used for all other planes)
Given the above key to the filenames you can now identify the correct file extension for the type of effect your 3rd party aircraft will use.
If your aircraft is a helicopter, all those X's get changed to: h
If your aircraft is a massive scale C130 military or similar scale aircraft, all those X's get changed to: m
All other aircraft, all those X's get changed to: s
So assuming you have a 2 engine aircraft which matches the specification for the MultiPropDustFXcontrol.xml gauge, the following will be the correct entries:
For a complete and comprehensive description of all the effects files, their names and how to identify each one, refer to the: DUST EFFECTS (.fx) FILE IDENTIFICATION section located at the very end of this README_FIRST.txt file.
Next, if you have not already done so, edit each: light.XX to reflect the proper continued numerical order for the [LIGHTS] list of your 3rd party aircraft. Also.. If you have not already done so, it would be wise to review #5 of the KNOWN_ISSUES.txt file now.
You should now have a completed [LIGHTS] section edit for your 3rd party aircraft!
NOTE:
The formula I designed should place the effects exactly where they should go in reference to the aircraft however if you find after flying the aircraft the effect location is still not visually correct, you may tweak the location numbers A, B, C to get the effect exactly where you want it. The following is a key for the numbers:
Example:
A B C
light.XX=8, 4.00, -8.50, -2.50, fx_nickspropdust_dirt_s
A = If the dust effect needs to be moved back toward the rear of the engine or aircraft, tweak this number to a greater negative value. If your dust effect needs to move forward, tweak this number to a greater positive value.
B = If the dust effect needs to be moved to the left of the engine or aircraft, tweak this number to a greater negative value. If your dust effect needs to move to the right, tweak this number to a greater positive value.
C = If the dust effect needs to be moved down closer the ground, tweak this number to a greater negative value. If it needs to move up, tweak this number to a greater positive value.
The scale of the numbers is based on meters in the simulator. 1.00 = 1 meter to the scale of the aircraft model in the sim.
THE [SMOKESYSTEM] SECTION:
It gets easier from this point on. At this stage you should have already completed all the calculations and determined the file extensions in the [LIGHTS] section. All you are going to do here is edit the same information from the light section code lines into the proper number of [SMOKESYSTEM] code lines based on how many engines your aircraft uses... but there are a few things to watch out for!
The first step is to verify that your 3rd party aircraft.cfg file does not have a [SMOKESYSTEM] heading with supporting code. If it does have this entry, you must delete the entire [SMOKESYSTEM] and all the code lines associated with it. As mentioned in #4 of the KNOWN_ISSUES.txt file, the [SMOKESYSTEM] is used for deep ice, snow and water blowing effects and if you do not overwrite the existing entries, both the dust effects and the pre-existing smoke effect could appear during snow, ice and water landings which would not look right. It could also have the opposite effect and the snow ice and water effects could be rendered useless. Make sure to overwrite the existing [SMOKESYSTEM] of any aircraft you add these effects to.
In order to be sure the aircraft you are working with has no [SMOKESYSTEM] and/or you do not miss the entry,... with the aircraft.cfg file open in notepad, from the edit menu select "FIND" then have it search for: [SMOKESYSTEM] The same search method can be used to quickly locate any heading in the file.
Like the [LIGHTS] section, the [SMOKESYSTEM] must have an equal number of line entries for the number of engines your 3rd party aircraft uses. Assuming we would continue what was started in the [LIGHTS] tutorial above, the example was a 2 engine aircraft. This being the case the [SMOKESYSTEM] must have 2 code lines. 1 line for engine1 and 1 line for engine2 as shown:
Like the engine code from the [GeneralEngineData], which reference engine 1 by Engine.0=, the smoke system code will reference engine 1 by the entry smoke.0=. If there were 3 engines, add another duplicate line and properly number it to smoke.02=. 4 engines, add 2 duplicate lines to the above and properly number them to the list. A single engine aircraft would only require one code line and you would simply delete the last line in the example above.
Next, I would place the new [SMOKESYSTEM] heading and supporting code lines just below the [LIGHTS] section to keep the dust effect data in order and together in the aircraft.cfg file.
Since you have already determined the type of effects file to use when the [LIGHTS] section was created, simply apply the same effects filename extension to the X's in the lines of the example above. Using the same aircraft type from the lights tutorial, your new lines should now read:
In FS2004 the [SMOKESYSTEM] is NOT the same as the [LIGHTS] section in how the calculated A, B, C numbers reference the X-Y-Z location. The same engine location data from the [LIGHTS] section IS used however where that data goes in the line is a bit different in the smoke system! For a refresher, here is a copy of the engine locations directly from the [LIGHTS] code lines created earlier in this tutorial with the formula already applied:
4.00, -8.50, -2.50, // Engine 1
4.00, 8.50, -2.50, // Engine 2
A B C
Next, transfer the numbers to the smoke system lines
HOWEVER.. When transferring this data to the [SMOKESYSTEM]... the A, B, C data MUST be entered as shown:
[SMOKESYSTEM]
smoke.0= -2.50, 4.00, -8.50, fx_nicks_watrsnoland_s // Engine 1 water, snow and ice surface types prop dust
smoke.1= -2.50, 4.00, 8.50, fx_nicks_watrsnoland_s // Engine 2 water, snow and ice surface types prop dust
C A B <----- ***place the numbers calculated from the light code lines for each engine in this order***
You can see the same engine location numbers that were already located and calculated in the [LIGHTS] section are used, but they are placed in the [SMOKESYSTEM] code lines in a different order. If this edit is not done properly the water, snow and ice surface types prop dust will appear to be coming from the wrong location in reference to the aircraft prop locations on the screen.
You now have a completed [SMOKESYSTEM] for your 3rd party aircraft!
C. AIRCRAFT.CFG [EFFECTS] EDITS:
This is the last and easiest part of the editing process. Below I will provide a list of generic copy/paste entries for the different types of aircraft that you can quickly transfer to your 3rd party aircraft.
For all Amphibians or water landing PLANES, overwrite the entire [EFFECTS] section with this:
For aircraft that are NOT massive in scale... (C130 military scale)
Note:
Do NOT overwrite the entire [EFFECTS] section. Simply overwrite the following entries under the [EFFECTS] heading:
water=fx_nicks_tchwater
dirt=fx_nicks_tchdirt
For aircraft that ARE massive in scale such as a C-130 military transport or equvilant size...
Note:
Do NOT overwrite the entire [EFFECTS] section. Simply overwrite the following entries under the [EFFECTS] heading:
water=fx_nicks_tchwater
dirt=fx_nicks_tchdirt_m
Save the aircraft.cfg file.
$$$$$$$$$$$$$$$$ Your 3rd party aircraft is ready to go!! $$$$$$$$$$$$$$$$$$$$$$
Along with all the information provided above in this tutorial, I made notations to all the effect code lines and files in the MS_AIRCRAFT.txt file for the following aircraft:
Beech Baron 58
Bell206 Helicopter
C208 Cessna Amphibian
Ford Tri-Motor
Mike Stones Lockheed C-130
With the provided references in this package you should have complete examples of the gauges, code lines, effects files and where they belong when setting up any 3rd party aircraft.
The next section of this README_FIRST.txt file explains in detail each file name, what it represents and where it is used in the aircraft.cfg file.
Below these descriptions is a complete list of all the effects files that were installed when you ran the Winzip installation .exe for this effects package. The following identification rules apply to each file name:
1. Ending File Extensions FOR ALL EFFECTS FILES:
File extension _h = Helicopter ONLY
File extension _m = Massive (scaled for C-130 Military and massive size commercial transport planes ONLY)
File extension _s or no extension listed = Standard (Used for all other planes than the above)
2. *_nickspropdust_*
Each file listed below with the term *nickspropdust* located in its name is designed for prop wash dust/mist effects only. This is the dust/mist that would be seen behind or under a hard running aircraft propeller or helicopter blade. The name of the file will also contain a surface type/condition abreviation for dirt, gravel/sand, water/snow. The files will switch according to the surface type and real time surface condition the aircraft is flying closely over (based on the xml gauge aircraft height setting) or touching. These files are ONLY used under the [LIGHTS] and [SMOKESYSTEM] sections of the aircraft.cfg file as described in this tutorial.
3. *_watrsnoland*
Each file listed below with the term *_watrsnoland* located in its name is designed for prop wash water and snow dust/mist effects when landing on solid ice, deep packed snow or a body of water. This is the water or snow dust/mist that would be seen behind or under a hard running aircraft propeller as it takes off or lands. These files are ONLY used under the [SMOKESYSTEM] section of the aircraft.cfg file as described in this tutorial.
4. *_tchdirt* -and- *_tchwater*
Each file listed below with the term **_tchdirt* -and- *_tchwater* located in its name is designed for ALL aircraft landing gear, landing skids or body parts and it creates the dirt or water dust/mist/splash effects the landing gear, skids or aircraft body part such as a wing tip will make on the surface it touches or scrapes. These files are only used under the [EFFECTS] section of the aircraft.cfg file in the:
dirt=
-or-
water=
code lines as described in this tutorial.
5. *_rtr_dirt_* -and- *_rtr_wtr_*
Each file listed below with the term *_rtr_dirt_* -and- *_rtr_wtr_* located in its name is designed for helicopters only. They create the chopper blade surface wind effects which appear at 30ft above the surface or less. These files are only used under the [EFFECTS] section of the aircraft.cfg file for helicopters in the:
landrotorwash=
-and-
waterrotorwash=
code lines as described in this tutorial.
6. *_wtrspray*
The single file listed below with the term *_wtrspray* located in its name is designed for amphibian aircraft only. It creates a splash effect when the aircraft comes in contact with the water too hard. This file is only used under the [EFFECTS] section of the aircraft.cfg file in the:
waterspeed=
code line as described in this tutorial.
---------
INSTALLED EFFECTS FILE LIST:
DIRT EFFECTS:
fx_nickspropdust_dirt_h
fx_nickspropdust_dirt_m
fx_nickspropdust_dirt_s
(Alternates for above dirt effects for those who fly in a more red colored dirt/dust environments such as Australian outback areas)
fx_nickspropdust_redirt_h
fx_nickspropdust_redirt_m
fx_nickspropdust_redirt_s
SAND, GRAVEL and SHORT GRASS EFFECTS:
fx_nickspropdust_gravsnd_h
fx_nickspropdust_gravsnd_m
fx_nickspropdust_gravsnd_s
WATER, ICE and SNOW SURFACE CONDITION EFFECTS:
fx_nickspropdust_watrsno_h
fx_nickspropdust_watrsno_m
fx_nickspropdust_watrsno_s
WATER, DEEP ICE and PACKED SNOW LANDING EFFECTS:
fx_nicks_watrsnoland_h
fx_nicks_watrsnoland_m
fx_nicks_watrsnoland_s
HELICOPTER DIRT and WATER ROTOR WIND EFFECTS:
fx_nicks_rtr_dirt_h
fx_nicks_rtr_wtr_h
HELICOPTER ROTOR, LANDING GEAR or SKID CONTACT WITH WATER:
fx_nicks_tchwater_h
AMPHIBIAN HARD CONTACT WITH WATER:
fx_nicks_wtrspray
ALL AIRCRAFT LANDING GEAR, SKID, or AIRCRAFT WING/FUSELAGE CONTACT WITH WATER:
fx_nicks_tchwater
ALL AIRCRAFT LANDING GEAR, SKID, or AIRCRAFT WING/FUSALAGE CONTACT WITH DIRT:
fx_nicks_tchdirt
fx_nicks_tchdirt_m
(Alternates for above dirt effects for those who fly in a more red colored dirt/dust environments such as Australian outback areas)
fx_nicks_tchdirt_red
fx_nicks_tchdirt_red_m
ALL AIRCRAFT HARD CONTACT WITH WATER:
fx_watercrash.fx
