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 › Setup

Devices

Plugin

Every device SimDeckOS supports and how to set each one up. Detect and Add, the Stream Deck app profile, Ulanzi Studio, mapping a wheel, MOZA wheel link, PXN lights, turned decks, the info screen, building your own device, and phones and tablets.

The Devices page lists every device SimDeckOS knows, with its settings. You can run several devices at once.

Each supported device also has its own page on the site, with what SimDeckOS puts on it: Works with.

Supported devices

DeviceControlsDetected on USB
Stream Deck +8 keys, 4 dials with a touch stripYes
Stream Deck + XL36 keys, 6 dialsNo: add it with Add
Stream Deck XL32 keysYes
Stream Deck MK.215 keysYes
Stream Deck (original)15 keysYes
Stream Deck Mini6 keysYes
Stream Deck Neo8 keys, info screenYes
Ulanzi D200 and D200H13 keys, info screenYes; you pick the model
Ulanzi D200X13 keys, a window, 3 knobs, 2 buttonsYes; you pick the model
PXN GT One12 lit buttons, 3 position encoders, 2 thumb encoders, shift and clutch paddles, 2 funky switches, 15 RPM LEDsYes
MOZA KS Pro10 lit buttons, 5 lit position knobs, 4 rollers, shift and clutch paddles, 2 funky switches, 2 rear buttons, RPM and side LEDs, displayThrough its wheelbase
Simagic GT Neo10 lit buttons, 6 encoders and rollers, paddles, 2 funky switches, 15 RPM LEDsNo: add it with Add

The Simagic GT Neo hasn’t been tested on a rig yet, and its page says so. Its lights run through SimHub’s RGB LEDs.

Any other wheel or button box can be added as your own device (see below). It gets the same controls, without lights or screens.

Add a device

  1. Plug in your devices.
  2. Open Devices and choose Detect. SimDeckOS adds what it finds on USB.
  3. If a Ulanzi deck is found, pick your model: all three Ulanzi models share one USB id.

Add lets you pick a device yourself, plugged in or not. It links the first time SimDeckOS sees it. Use Add for the Stream Deck + XL, the Simagic GT Neo and your own devices.

Two decks of the same model are two devices; SimDeckOS tells them apart by serial number. Click a device’s name, or press F2, to rename it.

What the status says

Each device has a status word and, when something is missing, a reason and a button that fixes it.

StatusMeaning
RunningSimDeckOS drives it.
ConnectedIt’s plugged in, but SimDeckOS doesn’t drive it yet. The reason says why (see below).
Not mapped yetA wheel or your own device whose inputs aren’t mapped.
Not connected yetIt has never been seen. Plug it in.
OfflineIt was seen before, but isn’t on USB now.
PausedDrive is off.

N need a step in the page head jumps to the next device that is plugged in but not finished.

Put SimDeckOS on a Stream Deck

A Stream Deck shows SimDeckOS through a profile in Elgato’s Stream Deck app. SimDeckOS needs its companion plugin in that app; the SimDeckOS installer adds it.

  1. Make sure the Stream Deck app is running.
  2. On Devices, select the deck. While it reads Connected, its first card is Stream Deck app profile.
  3. Choose Install to Stream Deck.
    • If the companion is already connected, SimDeckOS switches the deck to its SimDeckOS profile straight away.
    • Otherwise the Stream Deck app opens and asks which device to use. The window may open on another screen.
  4. The deck reads Running.

The SimDeckOS profile stays in the Stream Deck app’s profile list. To make it appear by itself whenever SimHub runs, link it to SimHub in that profile’s settings in the Stream Deck app.

If the status stays Connected, the reason tells you what is missing:

  • The Stream Deck app isn’t running.
  • The SimDeckOS plugin isn’t in the Stream Deck app. Run the SimDeckOS installer again.
  • The deck shows another profile. Choose Install to Stream Deck again.

Ulanzi decks

A Ulanzi deck needs Ulanzi Studio running, with the SimDeckOS bridge plugin that the installer adds. In Ulanzi Studio, place a SimDeckOS Key action on every key and a SimDeckOS Dial on each knob; the layout itself comes from SimDeckOS.

If the device reads “The SimDeckOS bridge in Ulanzi Studio isn’t connected”, start Ulanzi Studio.

Map a wheel

A wheel needs its buttons, encoders and paddles mapped once. After that, each control does what its layout gives it.

  1. Run this with no game on track.
  2. On Devices, select the wheel and choose Map inputs on the Inputs card.
  3. Press, turn or pull each control when the window asks. Skip passes over one you don’t have.
    • For a position encoder, start one detent left of position 1, then turn right one detent at a time, a full circle.
  4. Choose Finish.

The PXN GT One is read directly over USB. Other wheels are read through SimHub. If the window says it finds no controller inputs, enable the wheel under SimHub ▸ Controllers so its inputs show as properties, then open the window again.

Other buttons on the Inputs card:

  • Map again replaces the mapping you have.
  • Re-map encoders captures only the position encoders again. Use it when the page says the wheel reports its encoders somewhere new.
  • Holding Clear removes the mapping. Put it back restores it until you map again or close SimHub.

Position encoders

The Absolute encoders card sets how each position encoder looks:

  • Ring shows (MOZA): Ring + position or Fill up to the value.
  • Indicator: the colour of the encoder’s indicator.
  • Auto colour: gives the indicator the opposite of its parameter’s colour.

Same ring for all applies one ring setting to every encoder.

SimDeckOS drives a MOZA KS Pro’s lights and display over the wheelbase’s port. Only one app can hold that port at a time.

  1. In MOZA Pit House, import the SimDeckOS dash once. You only need this for the wheel’s display.
  2. Close Pit House. If it is still running, the card warns you, and Close Pit House asks it to close.
  3. On Devices, select the wheel and turn on Wheel link.
  4. Under Choose what it drives, pick what SimDeckOS drives:
    • Wheel lighting: the LED buttons, the RPM strip and the side LEDs.
    • Encoder rings: the rings round the five position knobs.
    • Wheel display: live values in a session, and the idle screen when there is none.

To hand the wheel back to Pit House, switch Wheel link off or turn off Drive.

The wheel display, the wheel’s lights and its encoder rings work on every plan.

Wheel settings works once the link is on.

  • Brightness: for each of the RPM strip, LED buttons, encoder rings and display. Each row has a SimDeckOS sets it switch; off means Pit House decides.
  • Under More settings:
    • Sleep light: its mode, timer and colour.
    • Clutch bite point: stored in the wheelbase, so every game feels it. A car’s own bite point from the Garage wins while you drive that car.
    • Control step sizes: how far one press of a brightness or bite-point control moves the value.

If the status reads Port busy, Pit House is using the port. If it reads Display not answering, power-cycle the wheelbase and choose Reconnect now. The Wheel link card also always has Reconnect dash, which takes about 15 seconds.

PXN GT One lights

Wheel lights lights the GT One’s LED buttons, encoders and RPM strip over USB, as soon as the wheel is plugged in. Under Choose what it drives, pick Buttons and encoders and RPM strip.

If you also run a SimHub RGB LEDs profile for this wheel, turn that off, or the two will flicker.

Wheel settings sets the brightness of the LED buttons, encoder rings, indicators and RPM strip, and the Clutch bite point.

Night mode

Auto night mode dims wheel lights between the hours you set. It is set once for every wheel, on Settings ▸ General ▸ Night mode. A Stream Deck’s brightness is set in the Stream Deck app.

Idle audio on a wheel

On a wheel with thumb encoders, Idle audio turns them into audio controls while the idle screen runs:

  • One encoder turns the Windows volume.
  • The other cycles the output device.

In a session, both do their normal job. How much one click moves the volume is set once for the whole plugin, on Settings ▸ Audio.

Info screen

The Stream Deck Neo and the Ulanzi D200 and D200H have a small info screen, but SimDeckOS can’t paint it. The Info screen card sets what an Info screen key shows:

  • Entries: each one is a parameter, or a StreamLogic field (Pro). Add them with Add entry; you can give each an optional title.
  • Auto-cycle moves to the next entry by itself, every 0.5 to 30 seconds.
  • Cycle previews the next entry.
  • An Info screen key on the deck cycles it with a tap.

Each device has its own list.

Mounting and turned decks

The Mounting card says where a device sits on your rig.

  • Mounted: Left, Centre or Right. A car’s left beacons show on the device on the left and its right ones on the right. A device in the centre, or one that isn’t set, shows both.
  • Turned: 0°, 90°, 180° or 270°. For a deck mounted on its side or upside down. SimDeckOS lays the keys out the way you see them, and cues play the way you see them too. Decks with dials can’t be turned: the Stream Deck +, + XL and Ulanzi D200X.

On a turned Stream Deck, also set Device Orientation in the Stream Deck app (Preferences ▸ Devices) to the same angle, so the key pictures stand upright. SimDeckOS can’t change that setting for you. Use 90° from the Stream Deck app reads it back.

Ulanzi Studio has no orientation setting, so on a turned Ulanzi deck the key pictures stay as drawn.

Build your own device

Any wheel or button box that isn’t in the list can be added as your own device.

  1. Choose Add, then Build my own.
  2. Choose Wheel or Button box, and name it.
  3. Under What is on it, count its controls:
    • buttons and funky switches
    • position encoders, with their number of positions
    • rotary encoders, and whether they can be pressed
    • paddles: shift, clutch or function
    • momentary and latching switches
  4. Arrange them on the drawing, then choose Create device.
  5. Choose Map inputs, pick the USB device, hold still while it reads the resting state, then press each control.

SimDeckOS only reads the inputs of the device you pick; it writes nothing to it. A built device has no lights or screens.

  • Edit changes what is on it and keeps its layouts.
  • Save to file shares it, so anyone with the same hardware can choose Add ▸ Open a shared one.

Phones and tablets

A phone or tablet on your home network can show your live dash.

  1. On the PC, turn on Settings ▸ General ▸ Phone & tablet dash, and be signed in. If the status warns that your network is Public, set it to Private in Windows Settings.
  2. On the phone, open Studio and choose Connect to PC.
  3. A Pair a phone window with a code opens on the PC. Scan it with the phone. A code works once, for two minutes.

Paired phones are listed under Devices ▸ Phones & tablets, where you can rename or remove them. Share read-only… shows a code a friend’s phone can scan to watch your dash without controlling anything.

Nothing is reachable from the internet. Leave the dash off on a network you don’t trust.