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

Settings

Plugin

Every tab of the Settings page. Controls and how keys reach the game, Drive and auto-switch, lap recording, night mode, the phone dash, shift-light defaults, audio, account and backup, updates and early access, diagnostics, and the actions you can bind in SimHub.

The Settings page has these tabs:

  • General
  • Shift lights
  • Audio
  • Account & backup
  • Updates
  • Diagnostics
  • About

Search settings at the top finds any setting by name.

General

Controls

  • Long-press hold sets how long a press must last to count as a long press.
  • Use SimHub telemetry lets you pick raw SimHub properties in the parameter editors, as well as SimDeckOS’s own values. Fields you wire up by hand aren’t covered by SimDeckOS’s mapping updates.

How keys reach the game

This decides how a key’s press gets into the game:

  • Control Mapper: through SimHub’s control mapper.
  • Keyboard: as keyboard shortcuts.
  • Virtual controller: as buttons of a vJoy virtual joystick, which you bind in the game’s own controls menu. It needs the free vJoy driver.
    • Bind in game… opens a window that stays on top of the game and sends each virtual button when you ask, so the game can learn it.
    • Configure vJoy… opens vJoy’s own settings.

Drive and switching

  • Drive is the master switch.
    • Off: nothing is driven. Stream Decks go back to their own profile, Ulanzi decks go blank, wheel lights go dark and the MOZA dash returns to the wheel.
    • Wheel buttons still reach the game while Drive is off.
    • The same switch is DRIVE in the status bar.
  • Auto-switch switches to the matching profile by game and car.

Lap recording

  • Record your laps keeps your best lap per car and track. The delta, the coach, Tracks and Garage ▸ Laps all read it. Turning it off stops all of them filling.
  • Reject invalid laps keeps a lap the sim marks invalid (a cut, or a lap that goes off track) from becoming a best. The switch only concerns invalid laps: a pit lap never counts, whether it is on or off.
  • Sync my laps to my account sends your lap records and benchmarks to your account in the background, for the full analysis in Studio. It is part of Pro, and off until you turn it on. Turning it off deletes nothing.
  • Delete all recorded laps asks first and saves a backup. Restore from backup brings them back.
    • Your settings, parameters, layouts and profiles stay.
    • Every car stays in your Garage, with its distance, seat time and lap count.

Screens

  • Timing strip shows StreamLogic’s live timing on the Stream Deck + strip. It is part of Pro.
  • Idle screen turns the idle screen on or off.

Studio

Studio live link lets Studio read your rpm and gear, run a shift sweep and send car settings to your Garage. Only Studio can use it, and only while it is on.

Night mode

Auto night mode dims every wheel’s lights between the From and To times, to the Dim to level. A Stream Deck’s brightness is set in the Stream Deck app.

Phone & tablet

Phone & tablet dash lets a phone or tablet on your home network show your live dash. Pairing needs you at this PC to scan a code, and nothing is reachable from the internet. See Devices.

Shift lights

These are the defaults for a car that has nothing better: no car settings, and nothing learned yet.

  • Sweep the defaults · 10 s plays them on your rig.
  • Redline blink and Blink speed set the blink at the rev limit.
  • Learn while I drive learns each car’s shift points from your upshifts. Car settings from the Library are never overwritten. Open Garage shows what each car knows.
  • Fallback range sets Start and Shift point, or uses the game’s own shift points.
  • Gradient and redline colours sets the low, mid and high rev colours, and the redline colours.

Audio

  • Output devices lists the audio outputs that the volume key steps through. Add an output adds one.
  • Volume step sets how far one click moves the volume. It is shared by the volume, mic and app volume dials, and by a wheel’s idle audio.

Account & backup

Account

This card shows whether you are signed in, and your plan: CLUB, PRO or FACTORY.

  • Manage on simdeckos.com opens your account on the website.
  • Sign out signs this PC out. Your rig stays as it is.

Plans and your account explains signing in and the plans.

Cloud backup (Pro)

  • Back up now saves this rig’s whole setup to your account.
  • Restore… brings back a backup. SimHub restarts to load it.
  • The card lists Backups of this rig and Other rigs on your account, so a new PC can take an old rig’s setup.
  • Back up automatically backs up once a day, only if something changed, and never while a game runs. Your account keeps the newest ten automatic backups of this rig; backups you make yourself are always kept.

A cloud backup never contains your password, your sign-in token or your phone pairings.

Backup & transfer: files on this PC

These work on every plan.

  • Profiles: Import… and Export current… handle .simdeckosprofile files, with a profile’s rules and its Look, never a layout.
  • Everything: Back up all… saves a .simdeckosbackup file with every setting: profiles, layouts, parameters, animations, messages, themes and devices.
    • Restore… reads one back. It keeps a copy of your current setup first, then SimHub restarts.

Updates

SimDeckOS checks for a new version when it starts. It never installs one by itself: updating always takes a press, because the installer closes SimHub while it runs.

  • Install downloads the new version, checks it, and runs the installer. SimHub and the Stream Deck app close, then reopen.
  • Get opens the download page instead, when the plugin can’t install that version itself.

Early access gets you test builds before everyone else. It is part of the Factory plan, and you can turn it off any time. You never move to an older version by turning it off.

Built-in content brings new colour themes, idle designs, cues, animations, messages, tracks and telemetry mappings between releases.

  • SimDeckOS looks for new ones at start, then hourly, when Check automatically is on.
  • A download takes effect when SimHub restarts, never under a running deck. Restart SimHub now applies it.
  • Telemetry mappings apply at once.

Diagnostics

  • Verbose logging writes more detail to the log.
  • Publish raw game fields publishes each reader’s raw values to SimHub as well. Your parameters, the plugin’s state and the normalised telemetry are always published.
  • Flag test shows each flag on your rig, to check your flag keys and animations.
  • Auto-switch resolver shows what SimHub reports, which profile auto-switch would pick and why, and which one is live. Use it when a profile doesn’t switch.
  • MOZA link has Reconnect now.
  • Log files:
    • Export diagnostics… saves the log to a file you can send.
    • Open log folder shows the log files.
    • Report a bug sends a report to the SimDeckOS team. It includes the last part of the log; you see it first and can leave it out.

About

This tab shows your version, with links to Discord, the website, the SimHub download and the documentation, plus the legal pages and the third-party licences.

SimHub actions

SimDeckOS adds actions to SimHub’s control mapper, so any button on any controller can drive it.

ActionWhat it does
DeckPageLeft, DeckPageRight, DeckPageHome, DeckPageBackPage the deck.
AllDecksPageLeft, AllDecksPageRight, AllDecksHome, AllDecksBackPage every deck at once.
DeckGoToPage1 to DeckGoToPage8Jump to a page.
CycleDial1 to CycleDial9, with _CW and _CCWPress or turn a dial.
WheelButton1 to WheelButton12, with LongPress a wheel button, or long-press it.
ToggleIdleTurn the idle screen on or off.
CycleAudioDevice, AudioVolumeUp, AudioVolumeDownWindows audio.
NeoNext, NeoPrevStep every info screen.
DashNextScreen, DashNextFolder, DashPrevFolder, DashFolderBase, DashFolderStreamLogic, DashScreenRace, DashScreenDelta, DashScreenFocusDrive the MOZA wheel’s dash.
ToggleStreamLogic, StreamLogicNextScreen, NextReference, ToggleEngineerOverlay, EngineerOverlayNextShapeStreamLogic (Pro).

Every game command, and every entry of your control sets, is also listed there by name.

SimHub properties

SimDeckOS publishes its values to SimHub with the prefix SimDeckOS., so any SimHub dash or overlay can read them:

  • App.*: the plugin’s state, such as the game, the car, the page and idle.
  • Param.<name>: each of your parameters.
  • Shift_*: shift lights and graded upshifts.
  • FFB.* and Tactile.*: the Extras tools.
  • Tel.*: the telemetry catalogue. Pro only.
  • SD_*: StreamLogic. Pro only.