RealEngine v1.1
-------

* For full documentation please see the pdf manual.

Below are a summary overview and installation instructions, from the full pdf manual.

-------
What RealEngine Does 
-------

RealEngine will fail aircraft engines and systems if operating limitations/recommendations are exceeded. 

I have designed this gauge with the objective in mind to (severely) penalize flying an aircraft under conditions outside of those recommended by the POH. Think of it as a strong incentive to respect the limitations and operating procedures recommended in the POH.
In the real world there is the fear of dying, and the “high cost in hard earned cash” if the aircraft is operated outside of the recommended operating conditions.
I hope to replace these driving forces in the sim by the fear of a failure of the engine or aircraft systems.
Watch your gauges!

-------
RealEngine modules
-------

• Engine Power Limitations
	Simulates damage (first roughness, then failure) to the engine if % power limitations are exceeded.
• Engine MP RPM Limitations
	Simulates damage (first roughness, then failure) to the engine if MP or RPM limitations are exceeded.
• Mixture State
	Engine runs rough if mixture is too lean or too rich.
	Engine can be damaged if mixture is too lean at higher power. High power operations like take-off or climb require rich/full rich mixture to avoid damage to the engine due to overheating or detonation.
• Spark Plug Fouling
	Simulates power loss due to spark plug fouling if engine is idled for too long. Do a proper run-up!
• Gear Overspeed Failure
	Generates gear failure if gear speeds are exceeded.
• Flaps Overspeed Failure
	Generates flaps failure if flaps speeds are exceeded.
	Asymmetric failure of flaps is modelled.
• Cylinder Head Temperature (CHT) Limitations
	Generates engine failure if CHT limitations are exceeded.
• Oil Temperature Limitations
	Generates engine failure if oil temperature limitations are exceeded.

RealEngine can be fully tailored to individual preferences
The modules consist in .xml gauges that are added to the aircraft via the panel.cfg.

• Each module can be installed into an aircraft individually. This allows to only add the modules/failure effects wished for.
• Modules can be turned on/off (paused) from the status panel (temporarily), or in the module’s .xml (permanently) 
• Operating limitations can be adapted to the aircraft either permanently in the module’s .xml gauge, or temporarily through the status panel by click spots.

-------
Installation
-------

It is highly likely that the gauge parameters have to be adapted to the aircraft, so it is recommended that the RealEngine folder be placed into the panel folder of the aircraft, and not in the fs gauges folder.

1.	Copy the whole “RealEngine” folder (that contains all RE_ .xml modules) into the “panel” folder of the aircraft. 
(Example default Beech Baron: fs9folder..\Aircraft\beech_baron_58\panel\RealEngine\***.xml files)

Btw, it does not matter if a “RealEngine” folder is placed in the “gauges” folder as well. When looking for a gauge, the sim will first look in the panel folder of the aircraft for the gauge file, and only if it does not find it there in the main gauges folder.
Also, no need for cabbing the folder.

2.	Add the following entries in the “panel.cfg” of the aircraft in question:
(Example default Beech Baron: fs9folder..\Aircraft\beech_baron_58\panel\panel.cfg)		

a.	At the end of the [Window Titles] section at the top of the panel.cfg, as last entry:

WindowYY=RealEngine

Example: If Window05=... is the last entry in the [Window Titles] section, add 
Window06=RealEngine .

b.	In the [Views] section, add the whole following (long) entry at the appropriate place, just after the last [Window..] entry:
(YY = same number as used in the [Window Titles] section.)



// ************** RealEngine v1.1 ************

[WindowYY]               // YY= same number as used in the [Window Titles] section.
window_size=0.2 // Panel width in % of screen
size_mm=200,290
position=0
visible=1

// Delete unwanted Failure Modules as needed, or deactivate line by "// ". For multiengine aircraft, delete/inactivate these modules for all active engines.
// Entries for engines not existing should be deleted from the panel.cfg. E.g. for a Twin engine plane delete the Failure Modules and Effects for Engine 3 and 4 from the panel.cfg.
// 	No need to remove the .xml files from the RealEngine folder though.
// Verify that all _active_ gauges are sequentially numbered.

// *** Status Panel ***
// 	Displays status for engine 1. Beware: Other engines may be less healthy and fail before engine 1!

gauge00=RealEngine!RE1_StatusPanel_v10, 0, 0, 200, 290

// *** Non-Engine Failure Modules ***

gauge01=RealEngine!RE1_GearOverspeed_Failure_v10, 0, 0, 1, 1
gauge02=RealEngine!RE1_FlapsOverspeed_Failure_v10, 0, 0, 1, 1

// Non-Engine Effects

gauge03=RealEngine!RE1_Effect_AsymmetricFlapsFailure_v10, 0, 0, 1, 1
gauge04=RealEngine!RE1_Effect_HydraulicElectricalFailure_v10, 0, 0, 1, 1

// Sound Effects (currently only flaps and gear failure)

gauge05=dsd_xml_sound3!dsd_xml_sound3, 0, 0, 1, 1, ./Gauges/dsd_xml_sound3_RealEngine_v10.ini

// *** Engine Failure Modules ***

// Engine Time-to-Fail modifier: Makes Engine 2 - 4 fail at different speed - Simulates different health level of the engines.

gauge06=RealEngine!RE2_4_EngineTTFModifier_v10, 0, 0, 1, 1

// Engine 1 Failure Modules
// 	Aircraft parameters (limitations, activation of modules, ect) need only to be adjusted for Engine 1. Engine 2 - 4 will pull the Aircraft parameters from Engine 1.

gauge07=RealEngine!RE1_EnginePowerLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge08=RealEngine!RE1_EngineMPRPMLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge09=RealEngine!RE1_MixtureLeanLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge10=RealEngine!RE1_MixtureRichLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge11=RealEngine!RE1_SparkPlugFouling_PowerLoss_v10, 0, 0, 1, 1
gauge12=RealEngine!RE1_CHTLimitations_EngineFailure_v10, 0, 0, 1, 1
gauge13=RealEngine!RE1_OilTemperatureLimitations_EngineFailure_v10, 0, 0, 1, 1

// Engine 1 Effects

gauge14=RealEngine!RE1_Effect_RandomNumber_v10, 0, 0, 1, 1
gauge15=RealEngine!RE1_Effect_MixtureState_v10, 0, 0, 1, 1
gauge16=RealEngine!RE1_Effect_EngineRoughness_v10, 0, 0, 1, 1
gauge17=RealEngine!RE1_Effect_EngineMaxPowerLoss_v10, 0, 0, 1, 1

// Engine 2 Failure Modules

gauge18=RealEngine!RE2_EnginePowerLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge19=RealEngine!RE2_EngineMPRPMLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge20=RealEngine!RE2_MixtureLeanLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge21=RealEngine!RE2_MixtureRichLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge22=RealEngine!RE2_SparkPlugFouling_PowerLoss_v10, 0, 0, 1, 1
gauge23=RealEngine!RE2_CHTLimitations_EngineFailure_v10, 0, 0, 1, 1
gauge24=RealEngine!RE2_OilTemperatureLimitations_EngineFailure_v10, 0, 0, 1, 1

// Engine 2 Effects

gauge25=RealEngine!RE2_Effect_RandomNumber_v10, 0, 0, 1, 1
gauge26=RealEngine!RE2_Effect_MixtureState_v10, 0, 0, 1, 1
gauge27=RealEngine!RE2_Effect_EngineRoughness_v10, 0, 0, 1, 1
gauge28=RealEngine!RE2_Effect_EngineMaxPowerLoss_v10, 0, 0, 1, 1

// Engine 3 Failure Modules

gauge29=RealEngine!RE3_EnginePowerLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge30=RealEngine!RE3_EngineMPRPMLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge31=RealEngine!RE3_MixtureLeanLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge32=RealEngine!RE3_MixtureRichLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge33=RealEngine!RE3_SparkPlugFouling_PowerLoss_v10, 0, 0, 1, 1
gauge34=RealEngine!RE3_CHTLimitations_EngineFailure_v10, 0, 0, 1, 1
gauge35=RealEngine!RE3_OilTemperatureLimitations_EngineFailure_v10, 0, 0, 1, 1

// Engine 3 Effects

gauge36=RealEngine!RE3_Effect_RandomNumber_v10, 0, 0, 1, 1
gauge37=RealEngine!RE3_Effect_MixtureState_v10, 0, 0, 1, 1
gauge38=RealEngine!RE3_Effect_EngineRoughness_v10, 0, 0, 1, 1
gauge39=RealEngine!RE3_Effect_EngineMaxPowerLoss_v10, 0, 0, 1, 1

// Engine 4 Failure Modules

gauge40=RealEngine!RE4_EnginePowerLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge41=RealEngine!RE4_EngineMPRPMLimitations_EngineRoughnessFailure_v10, 0, 0, 1, 1
gauge42=RealEngine!RE4_MixtureLeanLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge43=RealEngine!RE4_MixtureRichLimit_EngineRoughness_v10, 0, 0, 1, 1
gauge44=RealEngine!RE4_SparkPlugFouling_PowerLoss_v10, 0, 0, 1, 1
gauge45=RealEngine!RE4_CHTLimitations_EngineFailure_v10, 0, 0, 1, 1
gauge46=RealEngine!RE4_OilTemperatureLimitations_EngineFailure_v10, 0, 0, 1, 1

// Engine 4 Effects

gauge47=RealEngine!RE4_Effect_RandomNumber_v10, 0, 0, 1, 1
gauge48=RealEngine!RE4_Effect_MixtureState_v10, 0, 0, 1, 1
gauge49=RealEngine!RE4_Effect_EngineRoughness_v10, 0, 0, 1, 1
gauge50=RealEngine!RE4_Effect_EngineMaxPowerLoss_v10, 0, 0, 1, 1

// **************************************




3.	For single engine aircraft delete all the lines referring to engine 2 – 4 from the entry just copied into the panel.cfg (see step 2, // Failure Modules and // Effects sections for the modules starting with “RE2_” to “RE4_”).
For multiengine aircraft leave the entries for the respective engines 2, 3 or 4.
If you want, you can also leave the complete entry from step 2, but that makes FS just execute the additional unnecessary code.

4.	Move the files 
”dsd_xml_sound3.gau” and
“dsd_xml_sound3_RealEngine_v10.ini”
from the RealEngine folder into the main fs./Gauges folder if you want to have sound effects active (gear/flaps failure sounds only). No need to overwrite if you already have dsd_xml_sound3.gau in the gauges folder.

5.	Eventually delete/deactivate modules/effects that you don’t want. See pdf.

6.	You can then edit the individual modules’ .xml files in the RealEngine folder to reflect the limitations of the particular aircraft. See pdf.

The following modules typically need adjustment: 
•	Engine Power Limitations (Engine Power HP is critical!) - RE1_EnginePowerLimitations_EngineRoughnessFailure.xml
•	Engine MP RPM Limitations - RE1_EngineMPRPMLimitations_EngineRoughnessFailure.xml
•	Gear Overspeed - RE1_GearOverspeed_Failure.xml
•	Flaps Overspeed - RE1_FlapsOverspeed_Failure.xml

7.	Start the sim…
Cycle to the 2D panel after loading the aircraft. 
After loading the aircraft the failure effects will only become active after the failure module gauges have been open in the active window. By default the failure modules and the status panel are open in the 2D panel, so if you fly with the 3D panel, cycle to the 2D panel at least once after loading the aircraft.

Note: Default parameters in the gauges are optimized for the default FS2004 Beechcraft Baron 58, so if you just want to check out RealEngine, follow the installation steps 1 to 4 above, and start a flight with the Baron. No need for parameter adjustment. 

-------
Credits
-------

•	Doug Dawson: Freeware Sound Gauge_dsd_xml_sound3.gau (dsdxmls3.zip at flightsim.com) for flaps and gear failure sounds.
•	Asymmetric flaps failure: Idea by A2A Accusim.
•	Power loss effect: TooLowGear http://www.fsdeveloper.com/forum/showthread.php?t=16339
•	Roughness effect has been inspired by Warwick Carter’s Gee Bee Model Z / effect by Robert Sanderson (http://www.flightsim.com/kdl.php?fid=99404).
•	Brett Henderson for testing in FSX and for suggesting a way to implement individual failures for the engines of multiengine aircraft. http://www.sim-outhouse.com/sohforums/showthread.php?t=23054&p=400009&viewfull=1#post400009

-------
License
-------

I have spent a lot of time creating this package, so please respect the following rules:
This product is freeware.
Use in freeware products or for personal use:
•	You may use the whole or parts of any module of RealEngine, and modify as needed, for your personal use and in products distributed as freeware.
•	If you use whole or parts of any module, even modified, I request that you give credits to its use and the author (teson1, me ;-) in the readme and documentation of your product.
Commercial products distributed for profit (payware, donationware, ect.):
•	No use of the whole or of parts or of any module of RealEngine, whether modified or not, is allowed in products distributed for profit without my prior written consent.
Upload of the whole package is only allowed to the following sites:
•	www.flightsim.com
•	www.avsim.com
•	www.sim-outhouse.com
These sites are my “home” on the net, or I have received great help or had a good time, and this is my way of supporting them.
Exceptionally, upload is allowed to sites whose main language is other than English.

For further information please see the included pdf manual.

If you have questions/comments you can send me a PM at the flightsim.com forum board.
http://forums.flightsim.com/vbfs/member.php?u=29126

Hope you like it.
And keep an eye open for an emergency landing site at all times.

Gunter (teson1)

Copyright © 
12 June 2010
