Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vatACARS/plugin

vatACARS is designed to enhance the functionality of vatSys, a popular air traffic control simulation software, by integrating ACARS capabilities.
https://github.com/vatACARS/plugin

Last synced: 3 months ago
JSON representation

vatACARS is designed to enhance the functionality of vatSys, a popular air traffic control simulation software, by integrating ACARS capabilities.

Awesome Lists containing this project

README

        

vatACARS Logo

**vatACARS/plugin**

[![](https://img.shields.io/github/issues/vatACARS/plugin)](https://github.com/vatACARS/plugin/issues)

vatACARS is designed to enhance the functionality of vatSys, a popular air traffic control simulation software, by integrating ACARS capabilities.

## Features

- **Real-time Communication**: Facilitate real-time text-based communication between air traffic controllers and pilots within vatSys.
- **vatSys Integration**: Seamlessly integrates with vatSys user interface, ensuring a smooth user experience.

## Installation

We recommend using [our updater client](https://github.com/vatACARS/hub) to manage your installation of both our controller plugin and pilot's client. Alternatively, you can clone this repository locally and compile the plugin yourself.

## Contributing

Contributions to the vatACARS plugin are welcome and encouraged. If you would like to contribute to the development of the plugin, please follow these guidelines:

1. **Fork the Repository:** Start by forking the repository to your own GitHub account.
2. **Clone the Repository:** Clone your forked repository to your local machine using Git.
```
git clone https://github.com/you/plugin.git
```
3. **Create a Branch:** Create a new branch for your changes.
```
git checkout -b feature/my-feature
```
4. **Develop!** Make your desired changes to the codebase.
5. **Test:** Ensure that your changes work as expected and do not introduce any regressions.
6. **Commit Changes:** Commit your changes with descriptive commit messages.
```
git commit -am 'feat: description of the changes'
```
7. **Push Changes:** Push your changes to your forked repository.
```
git push origin feature/my-feature
```
8. **Submit a Pull Request:** Once your changes are ready, submit a pull request from your forked repository to the main repository. Provide a clear description of the changes and any relevant information.
9. **Review:** Your pull request will be reviewed by the project maintainers. Be prepared to address any feedback or make additional changes if necessary.
10. **Merge:** Once your pull request is approved, it will be merged into the main repository and be shipped with the next update. Congratulations and thank you for your contribution!

## Code Style Guidelines

- Follow the existing code style and formatting conventions.
- Write clear and concise code with descriptive variable and function names.
- Comment your code where necessary to explain complex logic or functionality.

## Bug Reports and Feature Requests

If you encounter any bugs or would like to request a new feature, please open an issue [on the GitHub repository](https://github.com/vatACARS/plugin/issues). Provide detailed information about the issue or feature request, including steps to reproduce for bugs.

## License

The vatACARS plugin is licensed under the [GNU General Public License v3.0](https://github.com/vatACARS/plugin/blob/master/LICENSE.txt).

## Disclaimer

This plugin is developed independently and is not officially endorsed or affiliated with vatSys or any associated organizations. Use at your own risk.