diff --git a/docs/Cockpit.md b/docs/Cockpit.md index 23f6900f..b398993e 100644 --- a/docs/Cockpit.md +++ b/docs/Cockpit.md @@ -4,7 +4,7 @@ It starts up the entire Cockpitdecks application. It establishes connection to t # Aircraft Configuration -Decks are particular to one aircraft. Cockpitdeck will look for a folder named `deckconfig` in the X-Plane folder of that aircraft. +Decks are particular to one aircraft. Cockpitdecks will look for a folder named `deckconfig` in the X-Plane folder of that aircraft. If a `deckconfig` folder is found in the folder of the aircraft currently used, Cockpidecks will first look for a file named `config.yaml`. In that file, Cockpitdecks will find all decks connected to the system and available to it. It will also find a set of global parameters. diff --git a/docs/Extending/Internals/Cockpitdecks Internals.md b/docs/Extending/Internals/Cockpitdecks Internals.md index c7067b4c..ea2f36af 100644 --- a/docs/Extending/Internals/Cockpitdecks Internals.md +++ b/docs/Extending/Internals/Cockpitdecks Internals.md @@ -42,7 +42,7 @@ When there is no connection to X-Plane, Cockpitdecks works as expected, however, # Internal Datarefs -Datarefs whose name starts with a prefix (currently `local:`) behave like any other datarefs but are neither forwarded to X-Plane, nor read from it. They can be set, read, etc. like any other datarefs allowing for a kind of *inter-button communication*: one button sets it, another one adjust its appearance based on it, even buttons on another deck! +Datarefs whose name starts with a prefix (currently `data:`) behave like any other datarefs but are neither forwarded to X-Plane, nor read from it. They can be set, read, etc. like any other datarefs allowing for a kind of *inter-button communication*: one button sets it, another one adjust its appearance based on it, even buttons on another deck! Truly, the sky is the limit. Enjoy. diff --git a/docs/Installation.md b/docs/Installation.md index 53ba7c64..bc2508a4 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -24,7 +24,7 @@ It is recommended to create a virtual environment and run Cockpitdecks within th 6. Test run Cockpitdecks without X-Plane. 7. Install optional Deck Helper plugin in X-Plane 8. Download and install aircraft deck configurations and layout. -9. Start Cockpitdeck application. +9. Start Cockpitdecks application. 10. Start X-Plane. 11. Enjoy all your deck devices activated in X-Plane. @@ -85,7 +85,7 @@ $ pip install git+https://github.com/devleaks/python-berhinger-xtouchmini.git Some commands cannot be executed directly through UDP. For exemples, commands that have a start and an end cannot be started or ended though UDP. It is an X-Plane UDP limitation. -To circumvent this, Cockpitdeck provides a small python plugin called the Cockpitdecks Helper plugin, that need to be installed into X-Plane to allow for start and end commands. The Cockpitdecks Helper plugin will execute start and end commands on behalf of the Cockpitdecks application. Cockpitdecks Helper plugin just need to be installed and will provide its services to Cockpitdecks. This plugin does not take any resource, it only adds and removes commands each time an aircraft is loaded. +To circumvent this, Cockpitdecks provides a small python plugin called the Cockpitdecks Helper plugin, that need to be installed into X-Plane to allow for start and end commands. The Cockpitdecks Helper plugin will execute start and end commands on behalf of the Cockpitdecks application. Cockpitdecks Helper plugin just need to be installed and will provide its services to Cockpitdecks. This plugin does not take any resource, it only adds and removes commands each time an aircraft is loaded. The Cockpitdecks Helper Plugin works automatically, reads `deckconfig` configuration and creates a pair of (beginCommand, endCommand) for each *long press* command. @@ -94,7 +94,7 @@ Cockpitdecks Helper Plugin is written in the python language. So it needs the [X Cockpitdecks XPPython3 plugins are located in the ```sh -< cockpitdeck-installed-code > /cockpitdecks/resources/xppython3-plugins +< Cockpitdecks-installed-code > /cockpitdecks/resources/xppython3-plugins ``` folder in the source code. There are 2 single files. diff --git a/docs/Resources.md b/docs/Resources.md index db52c7eb..4f3bbc73 100644 --- a/docs/Resources.md +++ b/docs/Resources.md @@ -30,7 +30,7 @@ Fonts are loaded on start up. text-font: DIN Condensed Black.otf ``` -Cockpitdeck comes with a few fonts appropriate for aeronautical use: Standard formal fonts like DIN, fancier fonts like LED fonts, icon fonts like font-awesome and weather-icon. +Cockpitdecks comes with a few fonts appropriate for aeronautical use: Standard formal fonts like DIN, fancier fonts like LED fonts, icon fonts like font-awesome and weather-icon. For Truetype font, it is not necessary to add the `.ttf` extension. For Opentype fonts it is necessary to add the `.otf` extension. @@ -50,7 +50,7 @@ Icons are loaded on start up and optionally cached. Typical icon size should be (square) 128 to 256 pixels. -Internally, Cockpitdeck use 256 pixel icons. Icons are resized to the deck requested size upon display. +Internally, Cockpitdecks use 256 pixel icons. Icons are resized to the deck requested size upon display. ```yaml icon: OFF_WHITE_FRAMED