Update README

Signed-off-by: Sander Datema <mail@sanderdatema.nl>
This commit is contained in:
Sander Datema 2025-01-20 01:32:09 +01:00
parent 178385536f
commit 5def74f272
Signed by: Sander
SSH key fingerprint: SHA256:YNXQXiUHV/n7Aud5UFGA6j2/AQz5nCIM7F2P4rCwTgw

View file

@ -15,7 +15,7 @@ Once you have downloaded X-KeyPad from the store, you'll have a ZIP file. Extrac
[[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.
Go to your X-Plane location (either XP11 or XP12 is fine). 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]]
@ -34,8 +34,8 @@ Replace `<your X-Plane folder>` with, well, your X-Plane folder.
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]]
# Start X-Plane and the ToLiss Zibo B738
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 Zibo B738 on any airport you like.
# Start X-Plane and the Zibo B738
Now start X-Plane, doesn't matter if it's version 11 or 12. Load the Zibo B738 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.
@ -53,19 +53,15 @@ Assuming this is your first install, we'll choose *Append*.
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_Zibo B738_StdDef.json` or `X-KeyPad-SD_Zibo B738.json`, it doesn't matter, they're the same.
[[doc/images/SCR-20230801-tgig-2.png]]
In this example the file was in the Aircraft folder already.
Now select one of those files in the File Selector. Either `X-KeyPad-SD_b738.json` or `X-KeyPad-SD_b738_4k.json`, it doesn't matter, they're the same.
# Install the Stream Deck profile
There are two Stream Deck profiles in my ZIP file. One for the Stream Deck XL and one for the Stream Deck Plus. Double click on the ones that you have.
Double click the Stream Deck profile in my ZIP file.
If you have a smaller Stream Deck, you'll need to try out what works for you. You can always add X-KeyPad keys by hand and then get the function names from the X-KeyPad configuration screen.
If you have a smaller Stream Deck, you'll need to try out what works for you. You can always add X-KeyPad keys manually and then get the function names from the X-KeyPad configuration screen.
# Have fun
You're done now. You don't have to edit anything in any of the profiles, unless you want to.
sander@passengerflying.com
February 12, 2024
January 20, 2025