SimDeckOS
Installer soon Sign in Notify me
PluginRace ControlStudioLibraryPricingDocsFAQ Sign in Notify me

Docs

Every guide for the plugin, Race Control and Studio, in the app’s own words.

Docs › Plugin › Build

Layouts and pages

Plugin

A layout is what one device shows and does, its pages, keys and dials. Making one, the layout editor, page triggers, pins, bands, and what Club and Pro allow.

A layout is what one of your devices shows and does. It holds the device’s keys, dials and buttons, spread over as many pages as you like. Each layout is made for one device model, because a 15-key deck and a wheel have different controls.

Plans. Club runs one layout per device, with unlimited pages in it. Pro keeps several layouts per device, and each profile can pick its own, so the layout changes with the game and the car. Page triggers are free on every plan.

The Layouts page

The page lists every layout you have. A chip on each one tells you where it plays:

  • Runs in … names the profiles that use it.
  • Not in any profile yet means nothing plays it.
  • Plays where a profile leaves this device unset means it is the fallback for that device.

Other tools on the page:

  • New makes a layout. It asks which device first. On Club, a device that already has a layout is dimmed in that list.
  • Tidy up deletes the layouts that have nothing placed on any control.
  • Filter by device shows one device’s layouts only.
  • More ▸ Save as a starter template… keeps the layout’s controls with nothing bound to them, ready to fill again.

If you are on Club and have more than one layout for a device (for example, after Pro ended), the extra layouts become read-only. The banner says This layout needs Pro and names the layout that plays. Nothing is deleted; everything comes back with Pro.

You can’t delete the last layout of a device model. When you delete a layout that a device was using, the device switches to one of its other layouts.

The layout editor

Open a layout to edit it. The device is drawn as it really is, with every key, dial, button and paddle in its place.

  • Click a control to edit it.
  • Drag a control onto another to swap them.
  • Delete clears the selected control.
  • Right-click for the full menu:
    • Edit…
    • Change what it shows… points the control at another parameter and keeps how it is set up. On an empty key it opens the picker.
    • Pin or Unpin.
    • Place a StreamLogic block here… (on screen keys).
    • Copy, Paste.
    • Clear. Hold it to confirm.

Anything you clear or delete with a hold can be brought back from the toast for 8 seconds, or with Ctrl+Z.

The element picker

When you put something on a control, the picker lists everything that fits it. Search it by name.

  • Your parameters, then your launchers and control sets. The − and + buttons on a parameter’s row place an Adjust key that steps it.
  • Adjust (+/−), Volume and Page jump.
  • Plugin controls: the plugin’s own settings, such as key style, colour theme, night mode or Windows volume. See Keys, dials and controls.
  • StreamLogic fields, including the free Lights group: Shift light and Beacon.

A row already on the control is marked ON. If you drop something a control can’t take, the picker says why, for example that an element works on a key but this control turns.

Keys, dials and controls explains every element and every kind of control.

Pages

The pages bar sits above the device. Add page adds one. Right-click a page for its menu:

  • Rename gives it a name and an identity colour. The colour tints the page’s chip, and on a wheel it lights the page encoder too. Auto goes back to the colour by position.
  • Page trigger… brings the page up by itself (see below).
  • Page colour… and Automatic colour set or reset the colour.
  • Set as main makes it the page the device opens on.
  • Move left (Alt+Left) and Move right (Alt+Right) reorder the pages.
  • Delete removes the page.

More ▸ Import page… and Export page… move a single page between layouts as a file.

To move between pages on the device, put a Page jump on a key, dial or wheel button. You can also bind the page actions in SimHub’s control mapper; see Settings.

Page triggers

A page trigger brings a page to the front when something happens in the car. For example, the pit page can appear in the pit lane, or the fuel page when fuel runs low.

  1. Right-click the page and choose Page trigger….
  2. Pick the value it watches: a SimDeckOS telemetry value, or Custom for a raw SimHub property.
  3. Under Switch when it is, choose On, =, ≥ or ≤ and enter a number.
  4. Under When triggered, choose one:
    • While true holds the page while the condition is true, then goes back to the page you were on.
    • When it turns true switches to the page once, then lets you page away.
  5. Choose Done.

Clear trigger removes it. Hold the button to confirm.

Pins

A pinned control stays the same on every page.

  • A pinned key shows on every page of the layout.
  • A pinned dial is used on every page that has no dial of its own in that place.
  • A pinned paddle or rear button applies on every page of the device.

On a funky switch, the pin applies to all seven ways.

Bands: several pages side by side

A wide deck can be split into bands: groups of columns that each run their own page. For example, the left half can keep the car’s controls while the right half pages through readouts.

Choose Split into … bands in the editor. It is offered on decks with at least 8 columns, up to 3 bands. The split travels with the layout. Page triggers and Page jump keys can name the band they act on.

StreamLogic blocks and pages (Pro)

Add StreamLogic in the pages bar does one of two things:

  • A block places a StreamLogic instrument that spans several keys, such as a tyre block or the radar, on this page.
  • A full page adds a ready-made StreamLogic page to this band.

You can also right-click a key and choose Place a StreamLogic block here…. You see which keys the block takes before it is placed.

On Club you can look at every block and page, but placing them needs Pro. The Lights fields, Shift light and Beacon, are free. StreamLogic lists the blocks and pages.

Put SimDeckOS on the device

A layout plays on a Stream Deck once SimDeckOS is installed to it. A wheel’s layout plays once its inputs are mapped. Both are on Devices.