chriskilding / XPTouchBar

Control X-Plane with your Mac's Touch Bar
MIT License
3 stars 0 forks source link

XPTouchBar

Control X-Plane with the Mac Touch Bar.

Screenshot

Overview

XPTouchBar is a companion app to X-Plane which presents flight controls in the Touch Bar.

XPTouchBar is completely customizable. You choose the controls that appear in the Touch Bar to complement the aircraft you're flying, and the hardware controls you have. (For example, if you don't have a throttle quadrant, you could put the throttle controls in the Touch Bar. If you do have a throttle quadrant, you could put some of the other controls in the Touch Bar).

You could use XPTouchBar as...

Screenshot

Screenshot

Screenshot

Screenshot

You can use XPTouchBar on the same machine as X-Plane (e.g. X-Plane on your external monitor, XPTouchBar on your MacBook monitor), or you can use them on different machines (e.g. X-Plane on your gaming PC, XPTouchBar on your Mac as a remote control).

Design

XPTouchBar aims to provide X-Plane controls which:

The placement and priority of controls in XPTouchBar follows the adage "Aviate, Navigate, Communicate". For example, the throttle quadrant is an "Aviate" control, so it is immediately accessible at the top level of the Touch Bar. Meanwhile the audio panel is a "Communicate" control, so it lives in a popover.

Features

XPTouchBar has Touch Bar widgets for the following aircraft controls:

XPTouchBar also forwards the following X-Plane keyboard shortcuts for convenience:

Key Shortcut
B Parking Brake On/Off
G Landing Gear Up/Down
M Show/Hide Map
P Play/Pause
Y Show/Hide Yoke
⇧1 Linear Spot
⇧2 Still Spot
⇧3 Camera: Runway
⇧4 Camera: Circle
⇧5 Camera: Tower
⇧8 Camera: Chase
⇧9 Camera: 3D Cockpit
⇧W Camera: Forward With HUD

Note: For simplicity, only the X-Plane S-TEC like autopilot controls are included at the moment, and they are designed as one predefined group of controls. If you would like support for other autopilot controls, or the ability to add individual autopilot controls to the Touch Bar, please open a GitHub Issue.

Requirements

Setup

Download the app from GitHub Releases, or compile the app from source with Xcode.

Usage

  1. Start X-Plane and load a new flight.
  2. Start XPTouchBar. (Configure it if necessary.)
  3. Begin your flight.
  4. During flight you may need to click into X-Plane to perform certain operations. When you're done, click on XPTouchBar again (or Cmd-Tab to it) to make the Touch Bar controls reappear.

Configuration

Touch Bar

  1. Start XPTouchBar.
  2. Click the Customize Touch Bar... button.
  3. Add controls to the Touch Bar which are relevant to your aircraft and sim setup.

You can add any controls that you find useful. Here are some suggestions:

Aircraft Controls
Cessna 172 Throttle, Mixture, Flaps
Cirrus Vision SF50 Throttle, Flaps, Landing Gear
Boeing 737 Speedbrake, Throttle, Flaps, Landing Gear
Beechcraft Baron 58 Throttle, Prop, Mixture, Flaps, Landing Gear

UDP connection

XPTouchBar connects over X-Plane's UDP connection. By default it connects to X-Plane on the same machine (localhost:49000).

If X-Plane is running on a different host or port, go to XPTouchBarPreferences to change the connection settings.

Recommendations

Troubleshooting

If you can't see the XPTouchBar controls...

If the XPTouchBar controls don't behave as you expect...

Limitations

Mac apps can only control the Touch Bar when they are in focus. Unfortunately this means that if X-Plane and XPTouchBar are on the same computer, and you click into X-Plane to do something, you need to Cmd-Tab back to XPTouchBar afterwards. This is something we would like to find a workaround for.

In the meantime, XPTouchBar does some things to help you keep it in focus: