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

Getting started

Plugin

Install SimDeckOS, sign in, and get live values on your deck, wheel or dash. The short path from nothing to a working rig.

The installer isn’t public yet. These steps are for release day. Notify me sends one email when it is out.

What you need

  • Windows 10 or 11.
  • SimHub, which is free. SimDeckOS runs inside it as a plugin.
  • A free SimDeckOS account. Create one here and confirm your email address.
  • A supported device.
    • A Stream Deck also needs Elgato’s Stream Deck app.
    • A Ulanzi deck needs Ulanzi Studio.
    • A wheel-only rig works too; a deck isn’t required.

Install

  1. Install SimHub if you don’t have it yet, and start it once.
  2. Get the SimDeckOS installer from the download page and run it. It closes SimHub and the Stream Deck app while it copies, and can start them again when it is done.
  3. The installer adds:
    • the SimHub plugin,
    • the Stream Deck companion, if you have the Stream Deck app, with ready-made profiles for every Stream Deck model,
    • the SimDeckOS bridge for Ulanzi Studio, if you have it.

If Windows SmartScreen warns you the first time, the installer isn’t code-signed yet. Choose More info, then Run anyway.

Later versions update from inside the plugin: see Settings ▸ Updates.

Sign in

  1. Open SimHub and choose SimDeckOS in the left menu.
  2. Open the account badge at the bottom of the plugin’s rail, and sign in with your SimDeckOS email and password.

The account opens the Library’s favourites and cloud backup, pairs the phone dash, and carries Pro if you have it. Plans and your account has the details.

Check your devices

  1. Plug in your devices.
  2. Open Devices and choose Detect. SimDeckOS adds what it finds on USB. Add lets you pick a device yourself, for one SimDeckOS can’t see on USB.
  3. Each device shows a status. Running means SimDeckOS drives it. Connected means it is plugged in, but SimDeckOS doesn’t drive it yet. Anything other than Running comes with the reason and a button that fixes it.

The Dashboard shows every device as it looks right now, and a checklist of the first steps. Devices covers every device in detail.

The first-run walkthrough

On a fresh install, the plugin opens a short walkthrough once it sees your devices:

  1. It checks each link to your device, one by one, and shows the fix for any link that’s missing.
  2. You press a key or button, to prove the whole path works.
  3. It offers a starter bundle: GT3, Hypercar or Street. Each brings its parameters and a layout for every device you have. With Pro, the first choice installs all three, and each car then runs its own class’s layouts.
  4. It asks how your keys reach the game: SimHub’s Control Mapper, vJoy or keyboard. This is the same choice as Settings ▸ General ▸ Control output.
  5. A short tour of the pages.

Closing it at any step is fine. It doesn’t come back, and Help ▸ Take the tour or Help ▸ Check my rig runs it again.

A device you plug in later is asked once whether it should get your starter bundle’s layout.

Put SimDeckOS on a Stream Deck

A Stream Deck shows SimDeckOS through a profile in Elgato’s Stream Deck app.

  1. On Devices, select the deck. While it reads Connected, its first card is Stream Deck app profile.
  2. Choose Install to Stream Deck.
    • If the companion is connected, the deck switches to the SimDeckOS profile straight away.
    • Otherwise the Stream Deck app opens and asks which device to use.
  3. The deck reads Running.

If the deck is mounted turned, set how far under Mounting on the same page. Also set the same Device Orientation in the Stream Deck app (Preferences ▸ Devices). SimDeckOS can’t change that setting for you. A Stream Deck + can’t be turned.

A Ulanzi deck works through Ulanzi Studio instead: see Ulanzi decks.

Map a wheel

A wheel needs its buttons, encoders and paddles mapped once.

  1. On Devices, select the wheel.
  2. Choose Map inputs on the Inputs card.
  3. Press each control once when asked.

After that, each control does what its layout gives it.

Re-map encoders captures only the position encoders again. Holding Clear removes the mapping; Put it back restores it until you map again or close SimHub.

The PXN GT One’s lights work as soon as it is plugged in: turn on Wheel lights on its page. Map a wheel has the details.

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

  1. For the wheel’s display, import the SimDeckOS dash once in MOZA Pit House.
  2. Close Pit House.
  3. On the wheel’s page, turn on Wheel link.

To hand the wheel back to Pit House, switch Wheel link off or turn off Drive. The wheel display and the lights work on every plan.

Your first session

Load into a session in a supported sim. SimDeckOS picks the value for each key and dial by name, so gear, delta, fuel, tyres and shift lights read correctly in every sim without mapping anything per game.

Some sims need a one-time step first: in Assetto Corsa, open SimDeckOS Bridge once from the in-game apps list, and in Le Mans Ultimate, turn on Enable Plugins. Notes for each sim lists them.

To change what a key shows:

  1. Open the Layouts page and pick the device’s layout.
  2. Right-click a key or dial and choose Change what it shows….

Parameters and values explains how that works.

Next