Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme for a380x #8366

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
![FlyByWire Simulations](https://raw.githubusercontent.com/flybywiresim/branding/1391fc003d8b5d439d01ad86e2778ae0bfc8b682/tails-with-text/FBW-Color-Light.svg#gh-dark-mode-only)
![FlyByWire Simulations](https://github.com/flybywiresim/branding/blob/master/tails-with-text/FBW-Color-Dark.svg#gh-light-mode-only)

# FlyByWire Simulations A32NX
# FlyByWire Simulations Aircraft

[![GitHub latest release version](https://img.shields.io/github/v/release/flybywiresim/a32nx.svg?style=flat)](https://github.com/flybywiresim/a32nx/releases/latest)
[![Github All Releases download count](https://img.shields.io/github/downloads/flybywiresim/a32nx/total.svg?style=flat)](https://github.com/flybywiresim/a32nx/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/flybywiresim/a32nx.svg?style=flat)](https://github.com/flybywiresim/a32nx/graphs/contributors)
[![GitHub latest release version](https://img.shields.io/github/v/release/flybywiresim/aircraft.svg?style=flat)](https://github.com/flybywiresim/a32nx/releases/latest)
[![Github All Releases download count](https://img.shields.io/github/downloads/flybywiresim/aircraft/total.svg?style=flat)](https://github.com/flybywiresim/a32nx/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/flybywiresim/aircraft.svg?style=flat)](https://github.com/flybywiresim/a32nx/graphs/contributors)

[![Discord](https://img.shields.io/discord/738864299392630914.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/UjzuHMU)
[![Twitter](https://img.shields.io/badge/-@FlyByWireSim-e84393?label=&logo=twitter&logoColor=ffffff&color=6399AE&labelColor=00C2CB)](https://twitter.com/FlybywireSim)
[![YouTube](https://img.shields.io/badge/-FlyByWireSimulations-e84393?label=&logo=youtube&logoColor=ffffff&color=6399AE&labelColor=00C2CB)](https://www.youtube.com/c/FlyByWire-Simulations)
[![Facebook](https://img.shields.io/badge/-FlyByWireSimulations-e84393?label=&logo=facebook&logoColor=ffffff&color=6399AE&labelColor=00C2CB)](https://www.facebook.com/FlyByWireSimulations/)
[![Instagram](https://img.shields.io/badge/-@FlyByWireSim-e84393?label=&logo=instagram&logoColor=ffffff&color=6399AE&labelColor=00C2CB)](https://instagram.com/flybywiresim)

The A32NX Project is a community-driven open source project to create a free Airbus A320neo in Microsoft Flight Simulator that is as close to reality as possible.
The A32NX and A380X Projects are community-driven open source projects to recreate, respectively, a free Airbus A320-200N and A380-800 in Microsoft Flight Simulator that are as close to reality as possible.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is "respectively" important?

Suggested change
The A32NX and A380X Projects are community-driven open source projects to recreate, respectively, a free Airbus A320-200N and A380-800 in Microsoft Flight Simulator that are as close to reality as possible.
The A32NX and A380X Projects are community-driven open source projects to recreate a free Airbus A320-200N and A380-800 in Microsoft Flight Simulator that are as close to reality as possible.


The following aircraft configuration is currently simulated or targeted:
The following aircraft configurations are currently simulated or targeted:

### A320neo
### A320-200N (LEAP)

```
Model A320-251N
Expand All @@ -33,7 +33,18 @@ The following aircraft configuration is currently simulated or targeted:
WXR Honeywell RDR-4000
```

Please note that this configuration may change in the future as the A32NX project evolves and changes.
### A380-800 (Trent 900)

```
Model A380-842
Engine Rolls-Royce Trent 972B-84
Weight Variant WV03
```

Please note that this configuration may change in the future as the projects evolve and change.

> [!NOTE]
> While code and some assets for the A380X are present in this repository, no usable sim model is present yet as the aircraft is still in pre-alpha. You cannot compile this repository to produce a usable aircraft.

## How to download and use the aircraft

Expand All @@ -53,7 +64,7 @@ Our [known issues](https://docs.flybywiresim.com/start/reported-issues) list con

### What liveries are available?

Liveries for the A32NX can be found on [Flightsim.to](https://flightsim.to/c/liveries/flybywire-a32nx/).
Liveries for the A32NX can be found on [Flightsim.to](https://flightsim.to/c/liveries/flybywire-a32nx/). They will be available for the A380X once it is released in alpha.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Liveries for the A32NX can be found on [Flightsim.to](https://flightsim.to/c/liveries/flybywire-a32nx/). They will be available for the A380X once it is released in alpha.
Liveries for the A32NX can be found on [Flightsim.to](https://flightsim.to/c/liveries/flybywire-a32nx/).
Liveries for the A380X will be available once it is released in alpha and livery builders had some time to create them.


### When is the next update?

Expand All @@ -63,19 +74,19 @@ We don't know, since it depends on many factors. We will announce each new stabl

Read [Contributing.md](.github/Contributing.md) and join our Discord to get started.

### Is the A32NX payware?
### Are FlyByWire aircraft payware?

No, it is a completely free aircraft, open-source.
No, they are completely free aircraft, open-source, including SimBridge and other FlyByWire projects which are publicly accessible via GitHub.

### How do we report bugs?

Please read the [known Issues and bug reporting](#known-issues-and-bug-reporting) section.

### Is this going to be "study-level"?

While many in the team dislike the term "study-level" as its use is mostly applicable to certified training devices, we are in fact very dedicated on bringing a high fidelity A320neo to the Microsoft Flight Simulator platform.
While many in the team dislike the term "study-level" as its use is mostly applicable to certified training devices, we are in fact very dedicated on bringing a high fidelity A320-200N and A380-800 to the Microsoft Flight Simulator platform.

### Is feature X from the A320neo going to be implemented?
### Is feature X from the real aircraft going to be implemented?

Chances are, yes! While we do not guarantee every single detail of the aircraft will eventually be represented, our goal is to produce an extremely accurate simulation based on technical data and real-world testing. This means you can be almost certain every feature of the aircraft will eventually be simulated to the best of the simulator's ability as long as the technical data backs it up.

Expand All @@ -91,7 +102,7 @@ You can read more about the differences between the versions we offer [on our do

### Is there a list of features or a changelog available?

We do not keep a list of features implemented, but a lengthy [changelog](https://github.com/flybywiresim/a32nx/blob/master/.github/CHANGELOG.md) of what has been implemented, and their associated [pull requests](https://github.com/flybywiresim/a32nx/pulls) can be [found here](https://github.com/flybywiresim/a32nx/blob/master/.github/CHANGELOG.md).
We do not keep a list of features implemented, but a lengthy [changelog](https://github.com/flybywiresim/aircraft/blob/master/.github/CHANGELOG.md) of what has been implemented, and their associated [pull requests](https://github.com/flybywiresim/aircraft/pulls) can be [found here](https://github.com/flybywiresim/aircraft/blob/master/.github/CHANGELOG.md).

## License

Expand Down