Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EvenAR authored Jan 10, 2025
1 parent 76796d9 commit 921f073
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Shows aircraft position relative to the ILS.


## Installation and use

1. Download the latest release from the [Releases](https://github.com/EvenAR/ILS-Window/releases) page.
Expand All @@ -11,14 +10,16 @@ Shows aircraft position relative to the ILS.

By default the plugin will automatically open ILS windows based on the active arrival runways. It's also possible to open windows manually using `.ils <title>` (where `<title>` refers to the `"title"` in the configuration file).

> [!NOTE]
> **Limitation**: This plugin uses the altitude reported by the pilot clients. Depending on the pilot's weather settings and the flight simulator they are using, the height displayed in the ILS Window may not match what the pilot sees (read why [here](https://forums.flightsimulator.com/t/vatsim-ivao-pilotedge-users-be-aware-of-an-important-bug/426142/468)).
## Configuration

The plugin reads the JSON configuration file when the plugin is loaded. For detailed configuration options, refer to [the sample configuration file](/Sample%20config). Worth noticing:

- `localizerCourse` must be the **true** heading in degrees
- `maxOffsetLeft` and `maxOffsetRight` is used to specify the maximum visible range (in nautical miles) left and right of the localizer. Most relevant for airports with paralell approaches.


## Screenshot

![image](https://github.com/user-attachments/assets/49e513da-1fa5-4483-8823-f557a293c05a)
Expand Down

0 comments on commit 921f073

Please sign in to comment.