Version 1.0.0 documentation

Complete documentation: what to enter and why

This is a searchable operating manual, not a feature summary. Every major numeric field includes units, range, purpose, a practical starting point and where it is edited.

01 Install & upgrade

  1. Exit X-Plane and the old controller; never overwrite the plugin while the simulator is running.
  2. Keep the installer EXE beside the payload folder, then run it.
  3. Select the X-Plane root containing Resources. The installer detects XP11/XP12 and copies the matching XPPython3.
  4. Wait for determinate progress to reach 100%. Old binaries are replaced while AppData licensing and profiles are preserved.
  5. Enter a cockpit before launching the desktop controller.
Uninstall removes this plugin and desktop shortcut but does not remove a shared XPPython3 installation.

02 Connection & updates

StageMeaningIf it fails
0–25%Waiting for the executor on 127.0.0.1:49091XPPython3Log.txt
25–55%Reading the basic catalogMatch internal and external versions
55–90%Reading advanced DataRefs in pagesAllow paging to finish; do not spam Reconnect
90–100%Synchronizing plans and shortcut slotsCheck the local profile file

Check Updates reads the website stable version and shows both values. Failure affects only update lookup, never the simulator connection.

03 Failures & repairs

Simple mode selects by symptom, while Advanced mode selects exact systems or DataRefs. Double-click triggers immediately; for instruction, select once and use Trigger now to avoid mistakes.

  • Repair selected writes only the selected target back to its working value.
  • Repair all resets discoverable standard failures; private aircraft systems may still require their own panel reset.
  • Validate with a default aircraft before testing third-party compatibility.

04 Random failures

Mode / fieldUnit and meaningExample
Min / max intervalSeconds; a new wait is drawn after each trigger. Minimum must not exceed maximum.300 / 900 = 5–15 min
Fixed intervalSeconds; repeatedly selects at the same interval.600 = 10 min
Flight timeSeconds from the current schedule start.1200 = 20 min
Reach altitude / airspeedAltitude uses ft and airspeed uses kt; fires on the transition into the threshold.10000 ft / 180 kt

Applying a random schedule switches automation to Random. Condition and plan configurations remain saved but paused.

05 Conditions

VariableUnit / rangeTypical use
Barometric / radio altitudeftClimb threshold / near-ground approach gate
IAS / groundspeedktHigh-speed reject / ground roll
Vertical speedft/minRapid descent or climb
Mach0–1+High-speed cruise scenario
Heading, pitch, bankdegTurn or attitude gate
Normal loadGAfter turbulence or aggressive maneuver
Flap ratio0–10=UP, 1=FULL
Total fuelkgLow-fuel cascade
Gear / on ground0 or 1Approach configuration / ground gate

between uses Value as the lower bound and Upper as the upper bound, inclusive. 700 and 1600 means 700≤value≤1600. == is best for 0/1 states, not continuously changing values.

06 Plan steps

In 1.0.0, selecting a step fills the editor with its name, trigger, conditions, probability, action, targets, note and environment snapshot. Use Update selected step to replace it; Add step always creates a new one.

TriggerHow Time is interpretedCondition behavior
At plan elapsed timeAbsolute seconds from plan start—
Delay after previousSeconds after the previous step completes—
Wait for conditionTime does not cause firingContinuously checks until true
Evaluate at timeEvaluates once at the absolute secondSkips if false; does not wait

With a second condition, AND requires both and OR requires either. Probability 100 always executes; 65 leaves a 35% skip chance after conditions pass; 0 keeps a disabled step in place.

Actions can trigger, repair selected, repair all or show a note. The Environment edition adds Apply environment and Restore pre-plan environment. Environment steps store a snapshot of selected fields.

07 Full scenario example

Example: low-visibility approach, wind shear and instrument anomaly

  1. Step 1: establish weather — Wait for radio altitude between 2200–2800 ft AND IAS ≥130 kt; apply 2 km visibility, 80% rain, 700 ft cloud base, 25 kt shear and turbulence 5.
  2. Step 2: instructor note — 3 seconds later show “Monitor wind and energy trend.”
  3. Step 3: probabilistic failure — 12 seconds later, apply a pitot anomaly at 60% probability.
  4. Step 4: timed decision — At 180 seconds evaluate radio altitude <800 ft AND vertical speed <-900 ft/min; show a go-around training note if true, otherwise skip.
  5. Step 5: restore — 45 seconds later repair selected failures, then restore pre-plan weather after another 5 seconds.
Accident-inspired scenarios are training designs, not second-by-second reconstructions and never replace QRH/SOP.

08 Profiles

FormatContentsWhen to use
.xpfaultRandom pool, conditions, plans, slots, environment editor, overlay, language and notesMove or back up a complete course
.xpplanOne or more action groups and stepsShare scenario scripts
.xpenvValues, enabled fields, wind/cloud layer and commit optionReuse fog, crosswind or wet-runway weather

Inspect is read-only; Load replaces current configuration; Merge retains it and adds new rules. After merging, check for duplicate triggers.

09 Environment reference

Only checked fields are written. Wind layer 1 is the lowest; XP12 supports up to 13 and XP11 compatibility up to 3. Cloud layers are 1–3.

FieldUnit / valid valuesEffect and guidance
Visibility0.05–160 kmHorizon/object visibility. 0.3=dense fog, 2=low-vis approach, 10=haze, 40+=good.
Sea-level pressure870–1085 hPaAffects altimeter reference and performance. Standard is 1013.25; do not enter airport elevation.
Sea-level temperature-80–60 °CAffects density altitude and icing context. -8 for winter icing, 42 for hot-weather performance.
Rain intensity0–100%0 none, 30 light, 70 heavy, 100 extreme training rain; pair with cloud and visibility.
Wind speed / direction0–250 kt / 0–360°TDirection is true direction from which wind blows. 270 means from west; applies to the selected layer.
Shear gain / direction0–120 kt / 0–360°Layer speed/direction change, not steady wind. 10–20 moderate, 30–45 severe; combine with turbulence and validate aloft.
Turbulence0–100 calm, 2–3 light, 4–6 moderate, 7–8 severe, 9–10 extreme simulation values.
Cloud type0/1/2/30 cirrus, 1 stratus, 2 cumulus, 3 cumulonimbus; coverage controls extent.
Cloud coverage0–100%0 clear, 25 few, 50 scattered, 75 broken, 100 overcast; fog/low cloud usually uses 100.
Cloud base / top MSL0–60000 ftBoth are MSL, not AGL. Top must exceed base. At a 500 ft airport with 700 ft AGL ceiling, enter about 1200 ft MSL.
Thermal climb0–3000 ft/minMainly affects light aircraft/gliders. 0 off, 300–800 gentle, 1200+ strong convection.
Wave height / direction0–15 m / 0–360°Affects water operations and seaplanes; leave unchecked for ordinary land operations.
Runway condition0–150 dry; 1–6 damp to standing water; 7–15 snow to severe ice. Used for braking/directional-control training.
Variability, XP120–100%0 static, 10 slight, 50 obvious, 90 highly variable; higher values reduce repeatability.
Weather trend, XP120–70–2 improving, 3 static, 4–6 worsening, 7 real weather. Training presets force 3 to prevent overwrite.

10 Weather troubleshooting

  1. Fog/heavy-rain presets automatically select trend=3 and enter static regional weather first.
  2. Values are committed together and recommitted about 0.8 seconds later so XP12 can rebuild clouds, fog and rain.
  3. A third-party weather engine can still overwrite values. Pause it or disable real weather before testing.
  4. Cloud base/top use MSL. Entering AGL can place clouds unexpectedly and appear ineffective.

11 Overlay

SettingRange and purpose
Opacity30–100%; 75% balances readability and obstruction.
Width / height330–1200 px / 240–1000 px, or drag the lower-right grip.
Font size8–18; use 11–13 on high-resolution displays.
Theme and colorsDeep Navy, High Contrast, Warm Instructor and Soft Light; or enter #RRGGBB for background, panel, text, accent and warning.

Right-click anywhere for settings or close; drag the custom header. Each field can be hidden independently, including random, conditions, plans, active failures, telemetry and events.

12 Licensing

Free includes simple failures, random mode, shortcuts and four condition variables, but not profile files. Advanced adds the full catalog, conditions, plans and archives. Advanced + Environment adds all weather features. Licenses are device-bound and survive upgrades; cancel online before changing an active code.

13 New-flight reset

When the aircraft reloads or flight time rolls back, discoverable failures, active state and recent events are cleared, plans return to step 1 and the saved automation is re-armed. Pause and view changes do not trigger a reset.

14 Troubleshooting

Controller cannot connect
Enter a cockpit; verify PI_AdvancedFailures.py loaded in Resources/plugins/XPPython3/XPPython3Log.txt; allow local port 49091; reinstall to replace mismatched versions.
Plan step does not fire
Confirm the group is enabled, Save and sync was clicked, and automation is Failure plan. Check between bounds, both AND conditions and whether probability is 0.
Connection appears slow after weather
Weather rebuild can delay one or two polls; the app does not disconnect immediately. Wait about 2 seconds, then reconnect and inspect failed DataRefs in the log.

15 Author & feedback

Creator: Fly飞飞; collaborative production: Fly飞飞 With Chat GPT; QQ: 2168688790. Visit Bilibili profile.

When reporting a problem, include app version, XP11/XP12, aircraft, reproduction steps, recent controller log and relevant XPPython3Log.txt lines. Never post a full license code.