From 063de2c215f9fbc82b53ea4dffc22c3272e89de4 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:39:27 +0200 Subject: [PATCH 01/11] Initial version of an FAQ page --- FAQ.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ ISSUE_TEMPLATE.md | 1 + README.md | 6 +++++- 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 00000000..cc759fc3 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,46 @@ +# Frequently Asked Questios + +## Start-up + +### Q. `Error code: 0x223` is raised + +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). + +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). + + +## 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. + +### Q. I encountered a strange behavior while flying. Should I report a bug? + +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. + +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. + +Instead, for documenting issues, please perform the steps mentioned in the next question: + +### Q. I want to document an issue. What is the right approach doing so? + +Besides describing it with words, you may do two things, which helps us reproducing your issue locally such that it can be debugged: + +1. Hit the screenshot buttons 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. + + + +## Do's and Don'ts + +### Q. The current version has a bug, but I still want to keep flying. Can I downgrade? + +NEVER downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file. You may find it in `$FGHOME/Export`. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 53e90f7d..6d670c46 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,5 +1,6 @@ + ### Expected Behavior diff --git a/README.md b/README.md index 050f3f8f..7b6f90c1 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,8 @@ Present pack includes the following Airbus A320 Family variants: - A320-214 - A320-232 - A320-251N -- A320-271N \ No newline at end of file +- A320-271N + + +## Frequently Asked Questions +For answers on frequently asked questions, refer to our [FAQ page](./FAQ.md). From 10aed85bd814a40ad4a742dc590f2a63374d08b4 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:42:46 +0200 Subject: [PATCH 02/11] FAQ: fix typos --- FAQ.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/FAQ.md b/FAQ.md index cc759fc3..2b0fc832 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,4 +1,4 @@ -# Frequently Asked Questios +# Frequently Asked Questions ## Start-up @@ -33,7 +33,7 @@ Instead, for documenting issues, please perform the steps mentioned in the next Besides describing it with words, you may do two things, which helps us reproducing your issue locally such that it can be debugged: -1. Hit the screenshot buttons 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. +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. From bc6f7ed258f482df53024d08233556fe511b7c6d Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:45:26 +0200 Subject: [PATCH 03/11] FAQ: additional comments on downgrading --- FAQ.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/FAQ.md b/FAQ.md index 2b0fc832..43172280 100644 --- a/FAQ.md +++ b/FAQ.md @@ -43,4 +43,7 @@ Besides describing it with words, you may do two things, which helps us reproduc ### Q. The current version has a bug, but I still want to keep flying. Can I downgrade? -NEVER downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file. You may find it in `$FGHOME/Export`. +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)! + +Besides that, **never** downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file as well. You may find it in `$FGHOME/Export`. + From 9f6f084733ae6b9f8b5a3435e418a6277d7be389 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 20:38:32 +0200 Subject: [PATCH 04/11] Hints on simulation speed --- FAQ.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/FAQ.md b/FAQ.md index 43172280..c21e8ec5 100644 --- a/FAQ.md +++ b/FAQ.md @@ -47,3 +47,12 @@ First of all, did you ensure that the bug is reported on our [issues page](https Besides that, **never** downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file as well. 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. + +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 are able to enable it in the "Debug" menu) 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. + From bbf03d8630d2a645b7f7dfd40ae40f55d6914194 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 20:47:31 +0200 Subject: [PATCH 05/11] FAQ: Correcting menu option for frame rate --- FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/FAQ.md b/FAQ.md index c21e8ec5..546ccf70 100644 --- a/FAQ.md +++ b/FAQ.md @@ -54,5 +54,5 @@ Increasing the simulation speed is quite tricky for the simulator. Depending on 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 are able to enable it in the "Debug" menu) 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 (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. From 423544881faee0f3990223fdc766b48f5cc3c8a3 Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Wed, 17 Apr 2019 11:00:59 -0400 Subject: [PATCH 06/11] GIT: Issue template --- ISSUE_TEMPLATE.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 6d670c46..4df972e0 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,20 +1,31 @@ - - -### Expected Behavior +### General +---- + +I am submitting a: (select one) +* [x] Bug report +* [ ] Feature request + +### Details +---- +#### Expected Behavior (bug reports) -### Current Behavior +#### Current Behavior (if applicable) -### Possible Solution +#### Requested Behavior (feature requests) + + +#### Possible Solution (if applicable) -### Steps to Reproduce +#### Steps to Reproduce (bug reports) - -1. -2. -3. -4. \ No newline at end of file + +1. +2. +3. +4. +5. \ No newline at end of file From b80f7272d431264867e7bcd2991bc8103788862f Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Wed, 17 Apr 2019 11:28:50 -0400 Subject: [PATCH 07/11] 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 ---- From 157ecaceafa5ec8355020b28ea4e179bbb816d5c Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Wed, 17 Apr 2019 11:33:22 -0400 Subject: [PATCH 08/11] GIT: FAQ revised --- FAQ.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/FAQ.md b/FAQ.md index 9a37cbe7..e6cffe48 100644 --- a/FAQ.md +++ b/FAQ.md @@ -10,7 +10,7 @@ This error occurs if you are attempting to use this IDG Aircraft on a version of 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). +Starting in air is not possible with this aircraft. 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. @@ -58,7 +58,6 @@ IDG suggests **never** downgrading your aircraft for the best expirience. If you ### 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. **IDG suggests not setting simulation speed above 4x or below 1/2x at any time**. +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) may happen. **IDG suggests not setting simulation speed above 4x or below 1/2x at any time**. 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. - From 0163488357c86ef7f12d1ff2c3d357940a343d0a Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Sun, 21 Apr 2019 00:09:38 -0400 Subject: [PATCH 09/11] Sim: FAQ revised --- FAQ.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/FAQ.md b/FAQ.md index e6cffe48..b82b9ac2 100644 --- a/FAQ.md +++ b/FAQ.md @@ -2,11 +2,11 @@ ## Startup -### Q. Error Code: 0x121 appears +### Q. Error Code: 0x121 appears. Why? 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 +### Q. Error Code: 0x223 appears. Why? This error occurs when there is an issue with the scenery that prevents initialization, or if you are starting in air. @@ -16,12 +16,30 @@ The simulation is so complex that there is no support for starting it in mid-air 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 +### Q. Error Code: 0x247 appears. Why? 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. +## Behavior + +### Q. I can't control the rudder with my aileron axis after turning on the FlightGear auto coordination system. Why? + +This aircraft has a complex and realistic flight control system, which contains a yaw damper and turn coordinator. Therefore, auto coordination is not nessesary and the rudder is only used in the air when de-crabbing during crosswind landings. + +When the aircraft detects that auto coordination has been turned on, it enables the aileron drives tiller system. This way, you will be able to control the nose wheel with the aileron axis to steer on the ground. Please use keyboard for rudder functionality. + +### Q. Some menu items are greyed out when using this aircraft. Why? + +Some functions in the regular menu (like Autopilot) have moved to custom menus. This is due to limitations in the way the default menus can be manipulated to prevent unsupported functionality (ex: Previous/Next Waypoint) from being executed. + +Some of the functions may be implemented in custom way and still usable. Check the custom menus to the right of the "|" for these functions. + +### Q. Why does the cold and dark state load after exiting replay mode? + +The flight recording system does not record the systems or internal functions of the aircraft. Doing so would require recording thousands of properties, and this would likely cause bugs and a performance hit. This means, that after replay, the systems might be in an invalid state. To ensure the aircraft remains functional, we reset the aircraft to cold and dark to reset everything. + ## Reporting Issues / Debugging ### Q. Where should I report issues? @@ -34,9 +52,7 @@ 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? -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 reasonable: The recording would be quite CPU and memory intensive and certainly would have a negative impact on your flight experience. +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. We do not plan on recording full information in the recorder. See the "Why does the cold and dark state load after exiting replay mode?" section for more information. Instead, for documenting issues, please perform the steps mentioned in the next question: From 11c48d8bac2302cbca0463d89b2e38874a43b6e2 Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Sun, 21 Apr 2019 00:10:31 -0400 Subject: [PATCH 10/11] Sim: README revised --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 7b6f90c1..c335a4b3 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,5 @@ Present pack includes the following Airbus A320 Family variants: - A320-251N - A320-271N - ## Frequently Asked Questions For answers on frequently asked questions, refer to our [FAQ page](./FAQ.md). From 5af70969bd9d05c8d24a0534ae84f28ddbc62d4d Mon Sep 17 00:00:00 2001 From: Josh Davidson Date: Sun, 21 Apr 2019 00:11:55 -0400 Subject: [PATCH 11/11] Sim: README revised --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c335a4b3..2fc76b97 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,4 @@ Present pack includes the following Airbus A320 Family variants: - A320-271N ## Frequently Asked Questions -For answers on frequently asked questions, refer to our [FAQ page](./FAQ.md). +For answers on frequently asked questions, refer to our [FAQ page](https://github.com/it0uchpods/IDG-A32X/blob/master/FAQ.md).