Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rico23rico authored Jun 13, 2021
1 parent f8213da commit 6cbd3fb
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
[![Building](https://github.com/rico23rico/avionics-bay/actions/workflows/cmake.yml/badge.svg)](https://github.com/rico23rico/avionics-bay/actions)


This is a C++ support library for X-Plane 11 Lua plugins (working via FFI).
This is a helper library for C/C++ and Lua plugins in X-Plane 11. Lua is exposed via FFI and it supports any Lua plugin (SASL, XLua, etc.).

The library is in the early stage of development and it will offer:
- The asynchronous reading of X-Plane files (e.g., apt.dat and other files)
- Graphics-related support functions (such as polygon triangulation)
(Planned) Features
==================
- Multi-threaded parsing, transparent to the user plugin
- Parsing of the following X-Plane files:
- `apt.dat` :heavy_check_mark:
- `earth_awy.dat` :construction:
- `earth_fix.dat` :heavy_check_mark:
- `earth_hold.dat` :heavy_check_mark:
- `earth_mora.dat` :heavy_check_mark:
- `earth_msa.dat` :construction:
- `earth_nav.dat` :heavy_check_mark:
- Parsing of CIFP files
- SID :heavy_check_mark:
- STAR :heavy_check_mark:
- APPCH :heavy_check_mark:
- RWVY :heavy_check_mark:
- Polygon triangulation with holes

Current status and development
==============================

The library is currently developed to support the open source [A321Neo project](https://github.com/JonathanOrr/A321Neo-FXPL),
and the development is currently focused on the needs and integration with this project.

Following the first release of the A320 aircraft, this library will be improved (especially regarding documentation) and released separately.

License
=======
This library is released with GPL3.0 (check the [LICENSE](LICENSE) file). Be aware of the limitations and implications of this license when the
library is included in your plugin (especially for commercial products).

0 comments on commit 6cbd3fb

Please sign in to comment.