Compare commits
2 commits
137266d5db
...
a154934799
| Author | SHA1 | Date | |
|---|---|---|---|
a154934799
|
|||
|
82c7e8d27a
|
2 changed files with 83 additions and 40 deletions
121
README.md
121
README.md
|
|
@ -1,66 +1,109 @@
|
|||
# Buy and download the X-KeyPad plugin
|
||||
Step one is to buy and download X-KeyPad from, for example, the X-Plane.org store.
|
||||
# How to Set Up X-KeyPad with the Zibo B738
|
||||
|
||||
[[doc/images/x-plane-org-buy-xkeypad.png]]
|
||||
## Table of Contents
|
||||
- [How to Set Up X-KeyPad with the Zibo B738](#how-to-set-up-x-keypad-with-the-zibo-b738)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [1. Buy and Download X-KeyPad](#1-buy-and-download-x-keypad)
|
||||
- [2. Download the Zibo B738 Profile](#2-download-the-zibo-b738-profile)
|
||||
- [3. Install the X-KeyPad Plugin](#3-install-the-x-keypad-plugin)
|
||||
- [Quarantine Fix on macOS](#quarantine-fix-on-macos)
|
||||
- [4. Install the Stream Deck Plugin](#4-install-the-stream-deck-plugin)
|
||||
- [5. Load the Zibo B738 and configure X-KeyPad](#5-load-the-zibo-b738-and-configure-x-keypad)
|
||||
- [6. Install the Stream Deck Profile](#6-install-the-stream-deck-profile)
|
||||
- [7. Final Steps and Customization](#7-final-steps-and-customization)
|
||||
- [Need Help?](#need-help)
|
||||
|
||||
[[doc/images/x-plane-org-download-xkeypad.png]]
|
||||
> And if you were wondering: no, the serial number isn't real. ;)
|
||||
---
|
||||
|
||||
# Download the Zibo B738 profile
|
||||
Next, download the B738 Stream Deck profile from the files section of the X-Plane.org forum.
|
||||
## 1. Buy and Download X-KeyPad
|
||||
|
||||
# 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.
|
||||
1. Purchase **X-KeyPad** from the [X-Plane.org store](https://link.passengerflying.com/lj4o4m) or another authorized retailer.
|
||||
|
||||
2. Download the plugin to your computer.
|
||||
|
||||
|
||||
[[doc/images/finder-xkeypad.png]]
|
||||
> ⚠ **Note:** The serial number shown in images is not real. 😏
|
||||
|
||||
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]]
|
||||
## 2. Download the Zibo B738 Profile
|
||||
|
||||
[[doc/images/steam-x-plane11-installed-files.png]]
|
||||
1. Go to the **files section** of the [X-Plane.org forum](https://forums.x-plane.org).
|
||||
2. Download the **B738 Stream Deck profile** for use with X-KeyPad.
|
||||
|
||||
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.
|
||||
## 3. Install the X-KeyPad Plugin
|
||||
|
||||
[[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.
|
||||
1. Locate the ZIP file you downloaded from the store.
|
||||
2. Extract the ZIP file to your computer.
|
||||
|
||||
3. Find your **X-Plane installation folder**:
|
||||
- **For Steam:**
|
||||
- Right-click X-Plane in Steam, select *Properties* > *Installed Files*, then click *Browse...*.
|
||||
|
||||
- **For Direct Download:** Use the installation path you selected.
|
||||
4. Inside the X-Plane folder, go to `Resources/plugins`.
|
||||
5. Copy the extracted **X-KeyPad** folder into the `plugins` folder.
|
||||
|
||||
|
||||
[[doc/images/finder-xkeypad-sd-plugin.png]]
|
||||
# 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.
|
||||
### Quarantine Fix on macOS
|
||||
|
||||
Now go to the menu and then `X-KeyPad` > `Stream Deck Configuration Editor`
|
||||
> ⚠️ **Important for macOS Users:** Downloaded software is quarantined by default on macOS. To fix this:
|
||||
1. Open the **Terminal** app (found in Applications > Utilities).
|
||||
2. Enter the following command:
|
||||
`bash sudo xattr -r -d com.apple.quarantine <your X-Plane folder>`
|
||||
|
||||
[[doc/images/SCR-20230801-tbic.png]]
|
||||
Replace `<your X-Plane folder>` with the actual path to your X-Plane installation.
|
||||
|
||||
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
|
||||
This step is not required on Windows.
|
||||
|
||||
Assuming this is your first install, we'll choose *Append*.
|
||||
---
|
||||
|
||||
[[doc/images/SCR-20230801-tavn.png]]
|
||||
## 4. Install the Stream Deck Plugin
|
||||
|
||||
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.
|
||||
1. Open the **X-KeyPad** plugin folder.
|
||||
2. Locate the `SD-plugin` folder.
|
||||
3. Double-click the Stream Deck plugin file to install it.
|
||||
|
||||
|
||||
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
|
||||
Double click the Stream Deck profile in my ZIP file.
|
||||
## 5. Load the Zibo B738 and configure X-KeyPad
|
||||
|
||||
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.
|
||||
1. Start X-Plane (version 11 or 12) and load the **Zibo B738** at any airport.
|
||||
2. X-KeyPad will automatically create an empty configuration file for the Stream Deck in the aircraft folder.
|
||||
3. Go to the menu:
|
||||
**X-KeyPad** > **Stream Deck Configuration Editor**.
|
||||
|
||||
|
||||
4. In the configuration editor window:
|
||||
- Choose **Append** to import a new profile (overwrites existing keys).
|
||||
- Optionally, choose **Selected Append** to import only selected keys.
|
||||
|
||||
|
||||
5. Ensure the JSON profile file `X-KeyPad-SD_b738.json` is located somewhere in your X-Plane folder.
|
||||
|
||||
---
|
||||
|
||||
## 6. Install the Stream Deck Profile
|
||||
|
||||
1. Double-click the Stream Deck profile file from the downloaded ZIP.
|
||||
2. For smaller Stream Decks, experiment with layouts or manually add keys using X-KeyPad's configuration screen.
|
||||
|
||||
---
|
||||
|
||||
## 7. Final Steps and Customization
|
||||
|
||||
1. You're now set up! Start flying and enjoy the convenience of your Stream Deck integration.
|
||||
2. If desired, customize profiles or add new keys using the X-KeyPad editor.
|
||||
|
||||
### Need Help?
|
||||
|
||||
# Have fun
|
||||
You're done now. You don't have to edit anything in any of the profiles, unless you want to.
|
||||
If you have any questions or issues, feel free to reach out:
|
||||
|
||||
sander@passengerflying.com
|
||||
|
||||
|
|
|
|||
2
copy.sh
2
copy.sh
|
|
@ -1,6 +1,6 @@
|
|||
echo Copying X-KeyPad profile
|
||||
cp "/Users/sander/X-Plane 12/Aircraft/B737-800X/X-KeyPad-SD_b738.json" "./X-KeyPad/X-KeyPad-SD_b738.json"
|
||||
cp "/Users/sander/X-Plane 12/Aircraft/B737-800X/X-KeyPad-SD_b738.json" "./X-KeyPad/X-KeyPad-SD_b738_4k.json"
|
||||
# cp "/Users/sander/X-Plane 12/Aircraft/B737-800X/X-KeyPad-SD_b738.json" "./X-KeyPad/X-KeyPad-SD_b738_4k.json"
|
||||
|
||||
# cp "/Users/sander/X-Plane 12/Resources/plugins/FlyWithLua/Scripts/passengerflying-xkeypad-zibo.lua" "./FlyWithLua/passengerflying-xkeypad-zibo.lua"
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue