diff --git a/README.md b/README.md index 6875252e..b4d1bc0e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ -# VFPC Plugin - -The HK-VFPC (Hong Kong Virtual Flight Plan Checker) is a plugin for EuroScope for HKvACC controllers to check flight plans against relevant route and altitude restrictions. -Originally developed by hpeter2 and DrFreas, it has been expanded on with modified functionality to better suit the needs of HKvACC. You can find the codebase of the original plugin [here](https://github.com/hpeter2/VFPC). -As such, the code will continue to remain open source and free to download for any controllers. However, other vACCs looking to implement or modify a similar flight plan checker may find the original plugin's versatility more useful.' +# HKCP Plugin +The HKCP (Hong Kong Controller Plugin) contains improvements and added functionality to Euroscope for Hong Kong vACC Controllers. -This plugin is still in active development, and may still contain bugs in the logic and general instability. Controllers, and especially new trainees, should not rely on this plugin for all flight plan validation. -While it will greatly aid delivery controllers, it **does not negate the need for delivery controllers to thoroughly check every flight plan before release.** It cannot provide a solution to more major route issues. +| Branch | Latest Release | Status | +|---|---|---| +| Stable | ![Latest Release](https://img.shields.io/github/v/release/vatsimhk/HKCP) | ![Master Status](https://github.com/vatsimhk/HKCP/actions/workflows/build.yml/badge.svg?branch=master) | +| Development | ![Latest Release](https://img.shields.io/github/v/release/vatsimhk/HKCP?include_prereleases) | ![Dev Status](https://github.com/vatsimhk/HKCP/actions/workflows/build.yml/badge.svg?branch=dev) | + +## VFPC +VFPC (Virtual Flight Plan Checker) checks flight plans against relevant route and altitude restrictions. +Originally developed by hpeter2 and DrFreas, it has been expanded on with modified functionality to better suit the needs of HKvACC. You can find the codebase of the original plugin [here](https://github.com/hpeter2/VFPC). While it greatly aids delivery controllers, it **does not negate the need for delivery controllers to thoroughly check every flight plan before release.** It cannot provide a solution to more major route issues. + +## Missed Approach Alarm (In Development) +The missed approach alarm allows tower controllers to send a visual and audio alert to TMA controllers for missed approaches. When the alert is sent (via the tag or window), the relevant TMA controllers receive a popup containing the details about the missed approach aircraft (callsign, airport, runway). The TMA controller can then acknowledge the request, saving the need for extra coordination over voice or chat. + +## Always On ATIS Display (In Development) +The Always On ATIS Display polls the vatsim datafeed for the latest ATIS at all 4 airports within the Hong Kong FIR, so they can be visually referenced at all times by controllers. The datafeed is slightly delayed, however this is the best option as there is no way to access the ATIS letter through the EuroScope SDK. ## How to use: - Load up the plugin -- Add Tag Item type & function to Departure List +- Add VFPC Tag Item type & function to Departure List If you get an error on load, please install the [latest C++ redistributables](https://aka.ms/vs/17/release/vc_redist.x86.exe)