@fboes/aerofly-patterns/docs/holding.md

Landegerät - Create random custom missions for Aerofly FS 4.

# Aerofly Landegerät: Holding Pattern Generator

The generator creates holding patterns for practicing entries and flying the pattern. See ["Holding" at Code 7700](https://www.code7700.com/holding.htm) and ["Holding Pattern" at SKYBrary Aviation Safety](https://skybrary.aero/articles/holding-pattern).

## What does it do?

1. The Landegerät gets data for a VOR, NDB or fix…
2. …and creates a holding pattern
3. …with either left-hand turns or right-hand-turns.
4. Depending on your configuration it may also use a DME fix.
5. Actual weather data for the given time and date is added…
6. …and a random starting location for your aircraft
7. …which will set the entry procedure.

## How to use it

```
Usage: npx @fboes/aerofly-patterns@latest aerofly-holding NAVAID_CODE [AFS_AIRCRAFT_CODE] [AFS_LIVERY_CODE] [...options]
v2.6.1: Landegerät - Create random custom missions for Aerofly FS 4.

Arguments:
  NAVAID_CODE               NavAid code which is holding fix. Needs to be available in Aerofly FS 4.
                            Default value: GND
  AFS_AIRCRAFT_CODE         Internal aircraft code in Aerofly FS 4.
                            Default value: c172
  AFS_LIVERY_CODE           Internal livery code in Aerofly FS 4.

Options:
  --inbound-heading=..      Heading of inbound leg in degrees. Default is -1, meaning that the inbound leg will be random.
                            Default value: -1
                            Example value: 180
  --min-altitude=..         Minimum safe altitude of aircraft, in 100ft MSL. '100' means 10,000ft MSL.
                            Default value: 100
  --max-altitude=..         Maximum altitude of aircraft, in 100ft MSL. '0' means that the minimum altitude will be used.
                            Default value: 0
                            Example value: 200
  --min-hold-altitude=..    Minimum altitude of holding pattern, in 100ft MSL. '0' means the rgular altitude will be used.
                            Default value: 0
                            Example value: 200
  --max-hold-altitude=..    Maximum altitude of holding pattern, in 100ft MSL. '0' means the rgular altitude will be used
                            Default value: 0
                            Example value: 200
  --min-dme-dist=..         Minimum DME distance in Nautical Miles.
                            Default value: 5
  --max-dme-dist=..         Maximum DME distance in Nautical Miles.
                            Default value: 10
  --missions=..             Number of missions in file.
                            Default value: 10
  --distance=..             Initial aircraft distance from holding fix in Nautical Miles.
                            Default value: 5
  --left-probability=..     Probability of an left-hand pattern being used in the mission.
                            Default value: 0.1
  --dme-probability=..      Probability of an DME procedure being used in the mission.
                            Default value: 0.1
  --dme-holding-away-probability=..  Probability of an DME procedure holding away from the navaid instead of towards.
                            Default value: 0.1
  --airport-code=..         Optional ICAO airport code to fetch METAR weather information for.
  --no-guides               Try to remove virtual guides from missions.
  --directory, -d           Create files in a subdirectory instead of current directory.
  --help, -h                Will output the help.
```

## Download the missions

There are already multiple mission files generated in [`/data`](./data/). They are stored in directories with the pattern `data/Holding_Pattern-[NAVAID_CODE]-[AFS_AIRCRAFT_CODE]/`.

See [the installation instructions](https://fboes.github.io/aerofly-missions/docs/generic-installation.html) on how to import the missions into Aerofly FS 4.

---

For more information see the [main documentation](../README.md).