Fixed donation link

Signed-off-by: Sander Datema <mail@sanderdatema.nl>

README.md

@@ -1,71 +1,112 @@
-# 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]]
 
-[[doc/images/x-plane-org-download-xkeypad.png]]
-> And if you were wondering: no, the serial number isn't real. ;)
+## Introduction
 
-# Download the Zibo B738 profile
-Next, download the B738 Stream Deck profile from the files section of the X-Plane.org forum.
-[[doc/images/x-plane-org-download-Zibo-B738-profile.png]]
+Welcome to this guide on setting up X-KeyPad with the Zibo B738 for X-Plane. This guide assumes basic familiarity with X-Plane, your operating system, and the Zibo B738 aircraft.
 
-# 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]]
+## Respect the effort
 
-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.
+I’ve put considerable time and effort into creating this profile, including the images, logic, and configurations. I kindly ask that you **do not redistribute** any part of this profile, including its images or the logic behind the Stream Deck keys. However, feel free to customize and tweak the profile for your own personal use.
 
-[[doc/images/steam-properties-xplane-11.png]]
+If you’ve found this profile helpful and would like to support my work, please buy me a coffee (or tea, I love tea). A donation button is on the Stream Deck, or you can go [here](https://link.passengerflying.com/ko-fi). Thanks!
 
-[[doc/images/steam-x-plane11-installed-files.png]]
+Thank you for respecting my work.
 
-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.
+## 1. Buy and Download X-KeyPad
 
-[[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. Purchase **X-KeyPad** from the [X-Plane.org store](https://link.passengerflying.com/lj4o4m) or another authorized retailer.  
+   ![Purchase Example](doc/images/x-plane-org-buy-xkeypad.png)
+2. Download the plugin to your computer. 
+   ![Download Example](doc/images/x-plane-org-download-xkeypad.png)
 
-[[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.
+> ⚠ **Note:** The serial number shown in images is not real. 😏
 
-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`
+## 2. Download the Zibo B738 Profile
 
-[[doc/images/SCR-20230801-tbic.png]]
+1. Go to the **files section** of the [X-Plane.org forum](https://link.passengerflying.com/IPD06N).
+2. Download the **B738 Stream Deck profile** for use with X-KeyPad.
 
-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*.
+## 3. Install the X-KeyPad Plugin
 
-[[doc/images/SCR-20230801-tavn.png]]
+1. Locate the ZIP file you downloaded from the store.
+2. Extract the ZIP file to your computer.  
+   ![Extract ZIP](doc/images/finder-xkeypad.png)
+3. Find your **X-Plane installation folder**:
+   - **For Steam:**  
+     - Right-click X-Plane in Steam, select *Properties* > *Installed Files*, then click *Browse...*.  
+       ![Steam Path](doc/images/steam-x-plane11-installed-files.png)
+   - **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.  
+   ![Plugin Folder](doc/images/finder-x-plane-11-plugins.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_Zibo B738_StdDef.json` or `X-KeyPad-SD_Zibo B738.json`, it doesn't matter, they're the same.
+### Quarantine Fix on macOS
 
-[[doc/images/SCR-20230801-tgig-2.png]]
+> ⚠️ **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>`
 
-In this example the file was in the Aircraft folder already.
+   Replace `<your X-Plane folder>` with the actual path to your X-Plane installation.
 
-# 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.
+This step is not required on Windows.
 
-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.
+---
+
+## 4. Install the Stream Deck Plugin
+
+1. Open the **X-KeyPad** plugin folder.
+2. Locate the `SD-plugin` folder.
+3. Double-click the Stream Deck plugin file to install it.  
+   ![Install SD Plugin](doc/images/finder-xkeypad-sd-plugin.png)
+
+---
+
+## 5. Load the Zibo B738 and configure X-KeyPad
+
+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**.  
+   ![Configuration Editor](doc/images/SCR-20230801-tbic.png)
+
+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.  
+     ![Append Configuration](doc/images/SCR-20230801-tavn.png)
+
+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
-February 12, 2024
+
+January 20, 2025

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"
 
@@ -9,5 +9,4 @@ cp "/Users/sander/X-Plane 12/Aircraft/B737-800X/X-KeyPad-SD_b738.json" "./X-KeyP
 # 7z a -tzip ./Stream\ Deck/B738\ Flight\ Deck\ Plus.streamDeckProfile ~/Library/Application\ Support/com.elgato.StreamDeck/ProfilesV2/C4F8C103-FD34-43C3-858A-AD82481D4E5C.sdProfile
 echo Zip Stream Deck profile
 rm ./Stream\ Deck/B738\ Flight\ Deck\ XL.streamDeckProfile
-7z a -tzip ./Stream\ Deck/B738\ Flight\ Deck\ XL.streamDeckProfile ~/Library/Application\ Support/com.elgato.StreamDeck/ProfilesV2/C0F01A5E-859C-4532-952B-0D51571400C3.sdProfile
-            
+7z a -tzip ./Stream\ Deck/B738\ Flight\ Deck\ XL.streamDeckProfile ~/Library/Application\ Support/com.elgato.StreamDeck/ProfilesV2/AEA2359F-0144-49CB-AC65-1F08DAF2CC2D.sdProfile