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

Keys, dials and controls

Plugin

Reference for every kind of control SimDeckOS drives (key, dial, encoder, paddle, funky switch) and every element a control can be (Value, Adjust, Launcher, Flag, Page jump, Volume, StreamLogic, plugin controls, shift-light and beacon keys, overlays).

This page is the reference for what you can put on a control. Layouts and pages explains how to place it.

Kinds of control

SimDeckOS works from what a control can do (press, turn, light, show a picture) rather than from the device’s brand. The same element behaves the same on a Stream Deck key and on a wheel button.

ControlFound onWhat it can do
Screen keyStream Deck, UlanziPress and show a picture.
Lit buttonPXN, MOZA and Simagic wheelsPress and light in a colour. It has no screen.
Dial with touch stripStream Deck + and + XLTurn, press, and show a tile on the strip.
Relative encoder or rollerWheel thumb encoders, Ulanzi D200X knobsTurn to step a value; some can be pressed.
Absolute (position) encoderPXN GT One, MOZA KS ProHas fixed positions, so the position sets the value directly.
Shift paddleWheelsFires the moment you pull it, so it has no long press.
Clutch or long paddleWheelsReads as an analog axis, or as a button with a bite point.
Funky switchWheelsSeven ways: up, down, left, right, push, turn right, turn left. Each way starts at None.
Rear buttonMOZA KS ProPress only, with no light.
Info screenStream Deck Neo, Ulanzi D200 and D200HA key that rotates through entries, a tap cycles it (the device’s own small screen isn’t painted); set it up on Devices.

Some rotaries have no press. Their editor says so: the rotary only turns.

Absolute encoders. When you turn one to position 4, SimDeckOS steps its parameter until the game reads 4. This works in every game. An absolute encoder can also be a page selector, with one page per position.

Elements: what a control can be

The control editor has up to three tabs:

  • Shows: what it displays.
  • Does: what pressing or turning it does.
  • Overlays: what can paint over it.

The picker groups elements into Shows me something, Does something and Goes somewhere.

ElementWhereWhat it does
ValueKey, dialShows a live value as a number, a bar or a gauge. It needs a parameter.
Adjust (+/−)KeySteps a value up or down on each press. It adjusts a parameter directly, or follows whatever a Value key shows. It is the key form of a dial.
ButtonKey, wheel buttonFires an action when pressed: a game control, a keyboard shortcut or a SimHub action. Advanced: macro runs several. Publish as a SimHub input makes the press usable elsewhere in SimHub.
LauncherKeyOpens an app, a file or a link, and shows while it is running. A long press can close what it started.
FlagKeyShows the current racing flag in its real colour. Under Flags shown, pick the flags it shows; with none picked, it shows them all. Free on every plan.
Page jumpKey, dial, buttonMoves between pages: Previous page, Next page, Home, Back or Go to a page. It can act on another device or band.
VolumeKey, dialWindows volume. A dial turns it, a key shows it, and a press switches the output device. Set the Step %.
StreamLogicKey, dialShows a StreamLogic readout. On a key, a press cycles its functions; on a dial, a turn does. Part of Pro, except the Lights fields.
Plugin controlKey, dialShows one of the plugin’s own settings and steps it (see below).
Shift light and BeaconKeyDedicated light keys. Free (see below).

Dials that carry parameters

A dial can carry several parameters and switch between them. Press it, or use a Previous or Next key, to move to the next one. A dial with no press carries one parameter.

Dial options include:

  • Transitions, and Auto show changed, which jumps to a parameter when it changes.
  • Ring colour.
  • Idle caption: the text the dial shows while idle.

Plugin controls

Plugin controls put the plugin itself on a key or dial:

  • Looks and colour: Key style, Colour theme, Idle design, Look.
  • Audio and tactile: Windows volume, Microphone, App volume, Tactile volume, Tactile on/off.
  • Wheel: FFB clipping, Clutch bite point, Wheel night mode, Wheel dash.
  • Screen: Monitor brightness.
  • StreamLogic: StreamLogic strip screen, Reference lap, Engineer overlay, Director.
  • Power: Shut down, Restart, Sleep.

The face shows the live value in your key style. A long press does the dial’s press.

  • Pro only: StreamLogic strip screen, Reference lap, Engineer overlay and Director. On Club their face says so. Wheel dash works on every plan, like the wheel display it steps through.
  • On Club, the Look control shows Your setup and does nothing. The theme and idle controls step through the built-in ones only.
  • Bite point and night mode need a MOZA wheel; without one they read NO MOZA.
  • Power controls ask twice. The first press arms the key for 10 seconds. A second press starts Windows’ 20-second shutdown or restart, counting down on the key, and any press during the countdown cancels it.
  • A dial can carry several plugin controls. A long press steps to the next one.

Shift-light and beacon keys

Place Shift light or Beacon keys side by side and they number themselves 1 of n, 2 of n and so on. The row then lights as one strip in the car’s own colours, from its car settings.

Fill style is By column or Continuous strip. These dedicated keys are free on every plan.

Overlays

The Overlays tab lets something paint over a control that already does something else:

  • Messages. A key can carry messages. While one routed to the device is up, it paints over the key. Free.
  • Shift lights and beacons (Pro). Any key or lit wheel button can wear the car’s shift light or beacons on top of its own job. One key alone carries the whole ladder; several in a row become that row’s strip, so a whole deck of overlays works like a dedicated light page. If Pro ends, each overlay switch is kept and simply rests.

Multi-state keys and toggles

A key that changes with a state, such as ignition on and off or the pit limiter, is a parameter with states. The first state that matches wins. A funky switch’s ways or a set of named commands are a control set. There is no separate toggle element.