From b80f7272d431264867e7bcd2991bc8103788862f Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Wed, 17 Apr 2019 11:28:50 -0400 Subject: [PATCH] GIT: FAQ revised --- FAQ.md | 40 +++++++++++++++++++++++----------------- ISSUE_TEMPLATE.md | 1 + 2 files changed, 24 insertions(+), 17 deletions(-) diff --git a/FAQ.md b/FAQ.md index 546ccf70..9a37cbe7 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,21 +1,32 @@ # Frequently Asked Questions -## Start-up +## Startup -### Q. `Error code: 0x223` is raised +### Q. Error Code: 0x121 appears -You are most likely trying to start up the airplane in mid-air, for example on a final approach to a runway. This is [not possible with this aircraft](https://github.com/it0uchpods/IDG-A32X/issues/84#issuecomment-475035478). +This error occurs if you are attempting to use this IDG Aircraft on a version of FlightGear that is too old. See [INSTALL.md](https://github.com/it0uchpods/IDG-A32X/blob/master/INSTALL.md) for more information. + +### Q. Error Code: 0x223 appears + +This error occurs when there is an issue with the scenery that prevents initialization, or if you are starting in air. + +Starting in air is [not possible with this aircraft](https://github.com/it0uchpods/IDG-A32X/issues/84#issuecomment-475035478). The simulation is so complex that there is no support for starting it in mid-air. Therefore, please make sure that you start it on the ground, powering it up appropriately. -In case that you want to practice landing, it might be better to fly to your destination and by doing it using "touch-down" and "going around" (like real pilots do so, too). +In case that you want to practice landing, it might be better to fly to your destination and by doing it by landing, and performing a missed approach (like real pilots do). +### Q. Error Code: 0x247 appears + +This error most commonly occurs if your download is corrupted, or a serious problem with the aircraft's systems occurs. + +This error can also appear if you are starting FlightGear for the very first time with this aircraft. This is a known issue and we are working to correct it. To fix this, simply start FlightGear again at an airport that is in a different scenery file. After this, all airports (including the original one attempted) will work properly. ## Reporting Issues / Debugging ### Q. Where should I report issues? -Please use our [issues page](https://github.com/it0uchpods/IDG-A32X/issues/new) to report bugs. Try to fill out the template there to the best of your knowledge. +Please use our [issues page](https://github.com/it0uchpods/IDG-A32X/issues/new) to report bugs. Please fill out the template there to the best of your knowledge. Issues submitted with blank templates will be closed. ### Q. I encountered a strange behavior while flying. Should I report a bug? @@ -23,9 +34,9 @@ Yes, please do so! If we do not know about the bugs, there is no-one to fix them ### Q. I have a flight recording which shows the problem. Could you please have a look? -I does not make sense sending in flight recordings, as they do not contain enough information. That is why they are more or less useless for us. +It does not make sense sending in flight recordings, as they do not contain enough information. That is why they are more or less useless for us. -Properly enabling the recording is also not what is reasonable: The recording would be quite CPU and memory intensive and certainly would have a negative impact on your flight experience. +Properly enabling the recording is also not reasonable: The recording would be quite CPU and memory intensive and certainly would have a negative impact on your flight experience. Instead, for documenting issues, please perform the steps mentioned in the next question: @@ -35,24 +46,19 @@ Besides describing it with words, you may do two things, which helps us reproduc 1. Hit the screenshot buttons (hotkey `F3` by default) often and send them all in! Five screenshots with redundant data isn't a problem to sort out, but one screenshot missing out which would have contained vital information may prevent understanding the problem properly. -2. If able you may also dump the property tree (see menu "Debug"). That is also a very helpful source of information. - - +2. If able you may also dump the property tree. That is also a very helpful source of information. To do so, please open the "Nasal Console" from the "Debug" menu, paste this command, and press "Execute". `io.write_properties(getprop("/sim/fg-home") ~ "/Export/IDG-A32X-dump.xml", "/");` The dumped file will be located in `$FGHOME/Export`. ## Do's and Don'ts ### Q. The current version has a bug, but I still want to keep flying. Can I downgrade? -First of all, did you ensure that the bug is reported on our [issues page](https://github.com/it0uchpods/IDG-A32X/issues/new)? If no, please do so (see also questions above on how to report them)! +First of all, did you ensure that the bug is reported on our [issues page](https://github.com/it0uchpods/IDG-A32X/issues/new)? If not, please do so (see also questions above on how to report them)! -Besides that, **never** downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file as well. You may find it in `$FGHOME/Export`. +IDG suggests **never** downgrading your aircraft for the best expirience. If you must do so, **you must** delete your `IDG-A32X-config.xml` file. You may find it in `$FGHOME/Export`. ### Q. I like increasing the simulation speed on long flights. However, I encounter issues with it once in a while. What's up? -Increasing the simulation speed is quite tricky for the simulator. Depending on hardware capabilities it can be very stressful and the algorithms behind the scenes can be challenged quite heavily. If the simulation is running faster than the corresponding algorithms can be computed, many funny (or even [ugly things](https://github.com/it0uchpods/IDG-A32X/issues/86#issuecomment-478328407)) may happen. So, be careful with that. +Increasing the simulation speed is quite tricky for the simulator. Depending on hardware capabilities it can be very stressful and the algorithms behind the scenes can be challenged quite heavily. If the simulation is running faster than the corresponding algorithms can be computed, many funny (or even [ugly things](https://github.com/it0uchpods/IDG-A32X/issues/86#issuecomment-478328407)) may happen. **IDG suggests not setting simulation speed above 4x or below 1/2x at any time**. -In general, one could say: - -* Don't increase the simulation speed above 4x. A simulation speed of 8x is already quite heavy load for everything. -* Check your frame rate (you can enable showing it using the "View" menu, option "View Options", toggle "Show frame rate" there) when increasing the simulation speed. As a rule of thumb, if the frame rate stays constantly above 10fps, you are fine. Keep in mind that already one little phase (and not just the average) where the frame rate drops significantly, you are in danger facing issues. +Check your frame rate ("View" menu, option "View Options", toggle "Show frame rate") when increasing the simulation speed. As a rule of thumb, if the frame rate stays constantly above 10fps, you are fine. Keep in mind that already one little phase (and not just the average) where the frame rate drops below 10 frames per second, you are in danger facing issues. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 4df972e0..9f6c443c 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,4 +1,5 @@ + ### General ----