Skip to content

X Keys support

Julian Waller edited this page Feb 5, 2025 · 9 revisions

X-keys is now supported

In recent Companion versions, you may need to resize the grid for your xkeys to fit onto a single page. For now this behaviour is configurable, and supports the old flow of spanning multiple pages, but this will be removed in a future version.

Almost every model should be supported, but we have not been able to test them all. Let us know if one doesn't work, and we can see if it can be.

Feedback

The xkeys backlight will respond to programmed feedback. For older models which only support red/blue backlight, we will approximate the colours as best as possible.

T-Bar

When your model has a t-bar, it will update the variable $(internal:t-bar) you can use this variable in other modules.

When you have questions, drop a message in Slack


Old documentation on the split page flow

Some tip's;

  • Button 1 on the xkeys is page 1 button/bank 1. As Streamdeck XL has 32 buttons, button 33 on your xkeys is automatically page 2 button/bank 1 for programming
  • Empty buttons on the xkeys de count, so make sure you skip those when needed (use companion log to see which button you are pressing).
  • If your xkeys is pressing buttons you don't like (because of numbering), use the page option in settings to create an offset. This way you can set button 1 from your xkeys to for example page 10 button 1. When you press button 1 on your xkeys, it will be button 10.0. When you press button 33 on the xkeys it will be 11.1

Best tip I could give is to create pages just for the xkeys, start for example on page 50. Remove the page up/down/index buttons and put the page setting of the surface to 50.

When you see Button 2.1 pressed while you press 1 on the xkeys and Button 99.17 pressed while you press 17, you still have the page up/down buttons programmed.