PassengerFlying/xkeypad_streamdeck_toliss_a319
PassengerFlying/xkeypad_streamdeck_toliss_a319
1
0
Fork 0
Code Issues 32 Projects 3 Releases 8 Activity

Update README

Browse source 
Signed-off-by: Sander Datema <mail@sanderdatema.nl>
This commit is contained in:
Sander Datema 2023-08-01 22:29:28 +02:00
parent 005ab27048
commit 9cb8fc09a4
Signed by: Sander
SSH key fingerprint: SHA256:Wt0vBy/c+0PaIYPGALOnv6o1olOr4sB41w+DzGr/Zw8
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,45 +1,57 @@
# Buy and download the X-KeyPad plugin
Step one is to buy and download X-KeyPad from, for example, the X-Plane.org store.
![[doc/images/x-plane-org-buy-xkeypad.png]]
![[doc/images/x-plane-org-download-xkeypad.png]]
[[doc/images/x-plane-org-buy-xkeypad.png]]
[[doc/images/x-plane-org-download-xkeypad.png]]
# Download the A319 profile
Next, download the A310 Stream Deck profile from the files section of the X-Plane.org forum.
![[doc/images/x-plane-org-download-a319-profile.png]]
[[doc/images/x-plane-org-download-a319-profile.png]]
# Unzip files and install plugin in the X-Plane folder
Once you have downloaded X-KeyPad from the store, you'll have a ZIP file. Extract it.
![[doc/images/finder-xkeypad.png]]
[[doc/images/finder-xkeypad.png]]
Go to your X-Plane location. If you have the Steam version, right click on X-Plane, select *Properties* and then go to *Installed Files*. Then click *Browse...*. That's your X-Plane folder when using Steam.
![[doc/images/steam-properties-xplane-11.png]]
![[doc/images/steam-x-plane11-installed-files.png]]If you downloaded X-Plane directly from X-Plane.com, I assume you know where you installed it.
[[doc/images/steam-properties-xplane-11.png]]
[[doc/images/steam-x-plane11-installed-files.png]]If you downloaded X-Plane directly from X-Plane.com, I assume you know where you installed it.
In the X-Plane folder go to `Resources` and then `plugins`. Put the X-KeyPad folder you extracted in the previous step here.
![[doc/images/finder-x-plane-11-plugins.png]]
[[doc/images/finder-x-plane-11-plugins.png]]
# Quarantine on Mac
The next step can be ignored on Windows, but is important on the Mac. By default downloaded software will be quarantined by your Mac. To fix this, open the Terminal app (in your Applications folder under Utilities) and type this command:
`sudo xattr -r -d com.apple.quarantine <your X-Plane folder>`
Replace `<your X-Plane folder>` with, well, your X-Plane folder.
# Install Stream Deck plugin
In the X-KeyPad plugin folder there's an `SD-plugin` folder. In it is the Stream Deck plugin that allows X-KeyPad to talk with your Stream Decks. Just double click it and it will be installed.
![[doc/images/finder-xkeypad-sd-plugin.png]]
[[doc/images/finder-xkeypad-sd-plugin.png]]
# Start X-Plane and the ToLiss A319
Now start X-Plane, doesn't matter if it's version 11 or 12. In this tutorial I'll use X-Plane 12. Load the ToLiss A319 on any airport you like.
In the aircraft folder, X-KeyPad will create a configuration file for the Stream Deck. It'll be empty by default.
Now go to the menu and then `X-KeyPad` > `Stream Deck Configuration Editor`
![[doc/images/SCR-20230801-tbic.png]]
[[doc/images/SCR-20230801-tbic.png]]
The the window that appears is where X-KeyPad profiles are made. But you can also import them. There are two ways:
*Append*: import a file, completely overwriting any existing keys
*Selected append*: only import selected items from a file
Assuming this is your first install, we'll choose *Append*.
![[doc/images/SCR-20230801-tavn.png]]
[[doc/images/SCR-20230801-tavn.png]]
By default X-KeyPad will scan your X-Plane folder for profiles, so you'll need to make sure the `json` files from the file you downloaded are somewhere in your X-Plane folder. It doesn't matter where, X-KeyPad will find them. You can type in another path (in the *Root path* field), by the way.
Now select one of those files in the File Selector. Either `X-KeyPad-SD_a319_StdDef.json` or `X-KeyPad-SD_a319.json`, it doesn't matter, they're the same.
![[doc/images/SCR-20230801-tgig-2.png]]
[[doc/images/SCR-20230801-tgig-2.png]]
In this example the file was in the Aircraft folder already.