| name | iracedeck-actions |
| description | Use when looking up Stream Deck actions, sub-actions, modes, categories, or control counts, or when updating documentation and website content about available features |
iRaceDeck Actions Reference
Data File
Complete action definitions: docs/reference/actions.json
This skill file documents 32 actions with 297 modes using a detailed per-mode count (the totals in the category table below). The user-facing website (packages/website/src/content/docs/) uses a coarser counting convention and shows a lower total (265 modes) — treat the website as the source of truth for user-facing copy and this skill file as the detailed inventory. docs/reference/actions.json has not yet been re-synced to the per-mode counting convention; treat it as a detailed inventory of individual mode values that is occasionally out of date.
Each action entry:
{
"id": "com.iracedeck.sd.core.session-info",
"name": "Session Info",
"file": "session-info.ts",
"encoder": false,
"settingsKey": "mode",
"modes": [
{ "value": "incidents", "label": "Incidents", "description": "..." }
]
}
Dial/encoder support was de-claimed in issue #640 pending a rebuild; that rebuild has begun in issue #681. Dial surfaces are Elgato Stream Deck+ only for now — the Mirabox and Ulanzi manifests declare no dial controllers (#786) until dial input is verified on that hardware. Fuel Service (encoder: true) carries the first and reference dial surface (the former standalone Fuel Dial action, merged into Fuel Service in #759) — on a Stream Deck+ dial + touchscreen it is the fuel dial, on a keypad button it is the modal fuel action. Setup Brakes (encoder: true) is the second dial-capable action — the former standalone Setup Brakes Dial (#730), merged into Setup Brakes in #775 following the same pattern: on a dial it adjusts one brake setup value by turning, on a keypad button it is the modal brake action. Audio Controls (encoder: true, #782) carries the third dial surface — on a dial, rotation adjusts the selected audio's volume and the press is configurable as push-to-talk or mute/unmute. Setup Traction, Setup Hybrid, Setup Fuel, Setup Engine, Setup Aero, and Setup Chassis (all encoder: true, #795–#800) each carry a dial surface following the same dual-surface pattern — on a dial, dial.setting picks which value rotation adjusts (via the same setup key bindings as the keypad) with the live value on the touch strip; settings with no dc* readback (engine boost-level, aero qualifying-tape, chassis springs/shocks) rotate but show a label-only strip. Setup Fuel's press can toggle FCY mode and Setup Aero's can toggle the RF brake; Traction's can toggle TC; Hybrid/Engine/Chassis offer no press gesture. Force Feedback (encoder: true, #802) carries a dial surface too — on a dial, dial.setting picks which FFB/LFE value rotation adjusts (via the same increase/decrease bindings, scaled by ticks with a per-event cap of 5); FFB Force shows the live max force in Nm on the touch strip (SteeringWheelMaxForceNm, the only value iRacing reports — formatted by a local Nm formatter, not the shared View machinery), and the four LFE settings render label-only. Its press/touch gestures can run Auto FFB (default None — auto-compute overwrites the tuned force, so it is not a blind default). Camera Controls (encoder: true, #803) carries a dial surface for spectating/broadcasting — on a dial, dial.mode picks the target (camera / sub-camera / car-number / race-position / driving; default car-number, with the pre-rework car value migrating to car-number) and rotation moves one step per detent (clockwise = next): the cycle modes reuse the keypad's own SDK camera dispatch, while car-number and race-position focus the neighbouring car computed from an explicit ordering (ascending car number, or the canonical getLiveRacePositions order with official CarIdxPosition as fallback) — both dispatched via Switch-by-Number, since race-position also resolves its target to a car number from that same order rather than a bare position (a bare switchPos would be resolved against iRacing's own official order, which can diverge from canonical in tow/finish/freeze cases and land the camera on a different car than the carousel previewed — #803 rework review). The touch strip names the MODE on its top line and shows a CAROUSEL of what that mode controls below — the current camera group icon, the current sub-camera by name, or the focused car number — with the dimmed prev/next either side where previewable (a P<pos> badge in race-position mode; driving is current-only, since it hands group ± 1 to iRacing to resolve+wrap), falling back to a mode-identity label out of session; Cycle Camera's dial PI reuses the keypad camera-groups selector bound to the global cameraGroupSubset. Its four gesture slots (press / long-press / tap / long-touch) offer Focus My Car / Change Camera / Focus on Leader / Focus on Incident / Focus on Most Exciting / None, all default None, all iRacing API. Camera Editor Adjustments (encoder: true, #804) carries a dial surface for camera operators — on a dial, dial.setting picks which of the 14 camera-tool parameters rotation adjusts (via the same camEdit* bindings as the keypad); iRacing exposes no camera-tool state, so every parameter is identity-only (the strip shows the parameter's full name only, no live value); each press and touch gesture can Auto Set Mic Gain or fire any Camera Editor Controls one-shot (the camCtrl* keys reused verbatim, #804). Cockpit Misc (encoder: true, #805) also carries a dial surface — on a dial, dial.setting picks dash page 1 or dash page 2 and turning cycles it via the shared cockpitMiscDashPage* bindings, with the live page number (dcDashPage / dcDashPage2, --- when the car has no dash pages) on the touch strip; the press/touch gestures are configurable over every keypad one-shot (Toggle Wipers, Trigger Wipers, In-Lap Mode, Report Latency; all default None), and ffb-max-force is excluded as a rotation setting (its FFB rotation belongs to the Force Feedback dial). View Adjustment (encoder: true, #806) carries a dial surface too — on a dial, dial.setting picks fov/horizon/driver-height/ui-size and turning steps it via the same View Adjustment key bindings; iRacing exposes no telemetry for any of these, so the strip is label-only (identity-only, the #782 compromise), and the press defaults to Recenter VR (blind-safe, the VR use case that motivates the dial). Splits & Reference (encoder: true, #807) is the smallest surface of the batch — a single rotation behaviour (no dial.setting select): turning cycles the splits/delta display modes (clockwise next, counter-clockwise previous) via the same splitsDeltaNext/splitsDeltaPrevious bindings, and the press defaults to Toggle Reference Car; iRacing exposes no telemetry for the selected mode, so the touch strip shows action identity only. Black Box Selector (encoder: true, #808) also carries a dial surface — rotation always cycles through iRacing's black boxes (clockwise = next, counter-clockwise = previous; scaled by ticks, capped at 5 per event) and a press gesture can Open Selected Box (single-taps the per-box binding chosen by dial.pressBox, exactly like the keypad Direct mode). Its touch strip is static and identity-only — a "BB" badge + "BLACK BOX" wordmark — because iRacing exposes no open-box state; the strip only dims under the #612 warning when the Cycle bindings are unset (refreshed on global-settings changes, not telemetry). Every other action remains keypad-only (encoder: false) until it is individually rebuilt. See .claude/rules/encoders-and-touchscreen.md for the per-action dial rules.
Communication method (per mode) — action-comms.json (#612)
Every action mode talks to iRacing through one of three methods, formalized per-(action, mode) in packages/iracing-actions/src/actions/data/action-comms.json (generated from comms-catalog.ts):
api — iRacing API / SDK command (getCommands().*); most reliable, no binding needed.keybind — a configurable key binding (keyboard OR SimHub role); requires the binding to be set. The descriptor's binding carries a constant key, a keyBy a secondary setting, multiple keys, or is absent for a fixed key (no user binding).chat — an iRacing chat/text command, e.g. a #… pit macro.
This is the authoritative source for a mode's communication method when answering "how does action X mode Y talk to iRacing?" or labeling docs. An action can mix all three across its modes (e.g. Fuel Service). Display-only / internal actions (session-info, telemetry-display, pit-crew) and Camera Controls' keypad surface (its camera command modes use the SDK; the Elgato-only Focus Car pick-from-grid mode is a deck-side profile switch, not a camera command — nothing to configure either way) are absent from the catalog — Camera Controls' dial surface still carries an all-API camera-focus-dial entry (#803) as this catalog's per-mode communication-method record, but its dial PI no longer renders the status line built from it (dropped as redundant since every dial mode reads the same "iRacing API", #803 rework review). The Telemetry Control snapshot mode is likewise absent (it writes telemetry to disk, issuing no iRacing command), so it shows no status line. The method surfaces in the PI (an ird-binding-status line under the Mode selector) and on the key icon (a centered ⚠️ when a required binding is unset).
How to Use
When asked about actions or controls:
- Read
docs/reference/actions.json and search by action name, mode value, or category (and data/action-comms.json for each mode's communication method)
- Report: action name, ID, file, modes with labels
- For implementation details, check the source at
packages/iracing-actions/src/actions/{action-name}/{action-name}.ts
- For PI templates, check
packages/iracing-actions/src/actions/{action-name}/{action-name}.ejs
Category Overview
| Category | Actions | Modes | Description |
|---|
| Display & Session | 2 | 10 | Live session data: incidents, laps, position, estimated iRating gain/loss, fuel, laps to empty, flags, track wetness |
| Driving Controls | 6 | 35 | AI spotter, audio (incl. Race Engineer & Radar volume), black boxes, look direction, car control, pit crew (Race Engineer toggle + radar) |
| Cockpit & Interface | 5 | 32 | Wipers, force feedback, splits & reference, telemetry, UI toggles |
| View & Camera | 5 | 89 | FOV, replay, camera controls, broadcast tools |
| Media | 1 | 7 | Video recording, screenshots, texture management |
| Pit Service | 3 | 15 | Fuel (keypad modes + a Stream Deck+ dial surface, #759), tires, compounds, tearoff, fast repair |
| Car Setup | 7 | 73 | Brakes (button and dial surface, #730/#775), chassis, aero, engine, fuel mix, hybrid/ERS, traction control — adjustment modes plus live-display "View …" sub-modes; each View sub-mode also supports dual-press (tap = configured direction, long-press = opposite) so one key both shows the value and adjusts it (#540); adjustment/View modes with a live telemetry value can also render as paired +/− key styles (2-key and 3-key layouts, several selectable styles, hold-to-repeat) — Phase 1 covers these seven setup actions (#810) |
| Communication | 2 | 35 | Chat, macros (15), whisper, toggle, reply, race admin commands, car selector |
| Stream Deck | 1 | 1 | Switch Profile — switch to a bundled iRaceDeck profile or back to the previous one (Elgato-only, no iRacing command) |
| Total | 32 | 297 | |
Mode counts reflect the PI Mode/Setting dropdown choices documented in each action page. Directional variants (Increase/Decrease) are treated as a single mode with a Direction sub-setting, matching the per-mode website format. Legacy replay actions (Replay Transport, Replay Speed, Replay Navigation) and Camera Cycle (Legacy) still exist in the plugin manifest for backward compatibility but are not counted as documented actions.
Actions by Category
Display & Session
| Action | Modes | Mode values |
|---|
| Session Info | 9 | incidents, time-remaining, laps, position, irating (estimated iRating gain/loss if the race ended now, green/red value, scored within the player's class; shown in race, qualifying, and race pre-green — -- in practice/test or when no estimate is possible; #268, #872), fuel (Fuel Value sub-modes: current level / used last lap / average per lap over a configurable 1–20 lap window; #465), laps-to-empty (live tank level ÷ the same 1–20-lap average, two decimals, -- until a clean lap exists; #748), flags, track-wetness |
| Telemetry Display | 1 | template (Mustache-driven display, no Mode dropdown; templates also support {{= expr }} expressions — arithmetic, comparisons, ternary, round/floor/ceil/abs/min/max — #192) |
Driving Controls
| Action | Modes | Mode values |
|---|
| AI Spotter Controls | 7 | damage-report, weather-report, toggle-report-laps, announce-leader, louder, quieter, silence |
| Audio Controls | 5 | push-to-talk (hold), voice-chat (with volume-up/down/mute action), master (with volume-up/down action), race-engineer (with volume-up/down action; steps global raceEngineerVolume ±5, respects the master enable gate), radar (with volume-up/down action; steps global radarVolume ±5). The race-engineer/radar categories control iRaceDeck's own audio buses directly (no keyboard binding). One action for BOTH surfaces (#782, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Dial (settings under the dial root; PI branches per actionInfo.payload.controller): dial.category picks what rotation adjusts — voice-chat/master tap the iRacing volume bindings once per detent (capped at 5 per event; iRacing exposes no volume state, so the self-drawn touch strip shows category identity only), race-engineer/radar step the 0–100 globals by 5 per detent with a live level bar + value on the strip (dimmed OFF when the feature gate is off; refreshed on global-settings changes, throttled ≤10/s). dial.pressAction (default none): push-to-talk holds audioControlsPushToTalk for the press duration (red ON AIR band while held; release also fires on willDisappear), mute-unmute taps audioVoiceChatMute for voice-chat or toggles the Pit Crew feature gate for race-engineer/radar via the shared audio-toggles.ts pathway (ack clips included) — not offered for master (iRacing has no master-mute keybind). Strip layout layouts/audio-controls.json (full-canvas box pixmap); strip + trigger descriptions are Elgato-only (__FEATURE_DIAL_FEEDBACK__). |
| Black Box Selector | 3 | direct (with 11 Black Box options), next, previous. One action for BOTH surfaces (#808, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Dial (settings under the dial root; PI branches per actionInfo.payload.controller; logic in black-box-selector-dial-surface.ts behind a host interface): rotation always cycles — clockwise taps blackBoxCycleNext, counter-clockwise blackBoxCyclePrevious (scaled by ticks, capped 5/event); a press gesture (dial.pressAction/dial.longPressAction default None, plus Elgato-only dial.tapAction/dial.longTouchAction default None) can Open Selected Box — single-taps the per-box binding chosen by dial.pressBox (the 11 Direct options), matching the keypad Direct single-tap toggle. Identity-only static touch strip (BB badge + "BLACK BOX"; no open-box readback exists), dimmed under the #612 warning when the Cycle bindings are unset |
| Look Direction | 4 | look-left, look-right, look-up, look-down (all hold pattern) |
| Car Control | 14 | pit-speed-limiter (telemetry-aware), push-to-pass (telemetry-aware), drs (telemetry-aware), headlight-flash (hold), tear-off-visor, ignition, starter (hold), enter-exit-tow (hold, telemetry-aware, session-context icon/color/label when out of car: Test/Practice/Qualify/Grid/Race, red background in-car, per-state auto-hold options for exit/reset/tow), escape (hardcoded ESC, auto-hold option), pause-sim, handbrake (hold), second-clutch (hold), second-up-shift, second-down-shift (backup driver inputs, #183 — no default iRacing bindings) |
| Pit Crew | 2 | race-engineer (Race Engineer Toggle — flips the engineer voice gate on/off), radar (toggles the directional proximity tick loop). The radar-volume mode moved to the Audio Controls action (#590) — hidden from the Pit Crew Mode dropdown but kept functional so existing buttons keep working. The Spotter is NOT a mode — it's a Race Engineer voice callout family (spoken side-awareness — "car left", "three wide", "clear"), gated by the Race Engineer master (pitCrewRaceEngineerEnabled) plus two PI opt-ins calloutEnabledSpotterCars + calloutEnabledSpotterStillThere (both default on); issue #651. Corner Names is likewise a callout family, not a mode — in practice/test sessions the engineer announces each named corner ("Eau Rouge", "Turn five") with a speed-scaled lead (cornerCalloutLeadSeconds, default 1 s); data from Lovely Sim Racing's lovely-track-data (@iracedeck/track-data, ~68 tracks, attribution is a grant condition), opt-in calloutEnabledCornerNames (default on); issue #888. |
Cockpit & Interface
| Action | Modes | Mode values |
|---|
| Cockpit Misc | 6 | toggle-wipers, trigger-wipers, report-latency, dash-page-1 (+/-), dash-page-2 (+/-), in-lap-mode (ffb-max-force is a hidden legacy alias of Force Feedback's ffb-force since #827 — kept functional, not in the PI dropdown). One action for BOTH surfaces (#805, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Dial (settings under the dial root; PI branches per actionInfo.payload.controller; dial logic in cockpit-misc-dial-surface.ts behind a host interface): dial.setting picks dash-page-1 or dash-page-2 and turning cycles it via the shared cockpitMiscDashPage* increase/decrease bindings; the touch strip shows the live page number (dcDashPage/dcDashPage2) as a self-drawn color-coded dash box (DASH 1/DASH 2 label + big number, --- when the car has no dash pages) via layouts/cockpit-misc.json; dial.pressAction/dial.longPressAction/dial.tapAction/dial.longTouchAction are configurable gestures over every keypad one-shot {Toggle Wipers, Trigger Wipers, In-Lap Mode, Report Latency, None}, all defaulting to None; ffb-max-force is excluded as a rotation setting (FFB rotation belongs to the Force Feedback dial) |
| Splits & Reference | 6 | cycle (+/- direction), toggle-ref-car, custom-sector-start, custom-sector-end, active-reset-set, active-reset-run. One action for BOTH surfaces (#807, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Dial (settings under the dial root; PI branches per actionInfo.payload.controller; dial logic in splits-delta-cycle-dial-surface.ts behind a host interface): a single rotation behaviour (no dial.setting select) — turning cycles the splits/delta modes by tapping splitsDeltaNext/splitsDeltaPrevious (clockwise/counter-clockwise), scaled by tick magnitude and capped at 5 taps/event. iRacing exposes no telemetry for the selected mode, so the self-drawn touch strip is identity-only (a DELTA label, no value; the #782 compromise) and the surface never subscribes to telemetry — the strip's only dynamic part is the #612 missing-binding warning, refreshed on global-settings changes. dial.pressAction (default Toggle Reference Car → taps toggleUiDisplayRefCar), dial.longPressAction/dial.tapAction/dial.longTouchAction (default None) each over every keypad one-shot mode — {Toggle Reference Car, Custom Sector Start, Custom Sector End, Set Active Reset Point, Reset to Start Point, None} — tapping the same binding key as its keypad-mode counterpart; classified at dialUp. Strip + trigger descriptions are Elgato-only (__FEATURE_DIAL_FEEDBACK__, layouts/splits-delta-cycle.json, box pixmap). |
| Telemetry Control | 6 | toggle-logging, mark-event, start/stop/restart recording (SDK), snapshot (developer tool — saves current telemetry + session info to disk as timestamped JSON + Markdown; configurable Output Folder; no iRacing command) |
| Force Feedback | 4 | auto-compute-ffb-force, ffb-force (+/-), wheel-lfe (+/-), bass-shaker-lfe (+/-). The retired wheel-lfe-intensity / haptic-lfe-intensity duplicates migrate to the LFE modes on both surfaces (#848 — iRacing's Options pages label the same controls "More/Less Intense"). One action for BOTH surfaces (#802, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Keypad: the four modes above (ffb-force shares the Cockpit Misc FFB keys, #827). Dial (settings under the dial root; PI branches per actionInfo.payload.controller; dial logic in force-feedback-dial-surface.ts behind a host interface, the Fuel Service pattern): dial.setting picks one of {ffb-force, wheel-lfe, bass-shaker-lfe}; turn adjusts it via the shared increase/decrease bindings (scaled by ticks, capped at 5 taps/event). ffb-force shows the live SteeringWheelMaxForceNm as "XX.X Nm" in a self-drawn color-coded dash box on the Elgato touch strip (layouts/force-feedback.json); the two LFE settings are identity-only (label-only strip). dial.pressAction/dial.longPressAction/dial.tapAction/dial.longTouchAction are configurable gestures over {Auto FFB, None}, all defaulting to None (Auto FFB overwrites the tuned force — not blind-safe). auto-compute-ffb-force stays keypad-only (not a rotation value) |
| Toggle UI Elements | 10 | dash-box, speed/gear/pedals, radio, FPS/network, weather, virtual mirror, UI edit, driving-line, display-ref-car (deprecated), replay-ui (SDK) |
View & Camera
| Action | Modes | Mode values |
|---|
| View Adjustment | 5 | fov (+/-), horizon (+/-), driver-height (+/-), recenter-vr, ui-size (+/-). One action for BOTH surfaces (#806, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Keypad: the 5 modes above. Dial (settings under the dial root; PI branches per actionInfo.payload.controller; dial logic in view-adjustment-dial-surface.ts behind a host interface): dial.setting picks one of {fov, horizon, driver-height, ui-size}; turn adjusts it via the shared View Adjustment increase/decrease bindings. Identity-only — iRacing exposes no telemetry for FOV/horizon/driver-height/UI-size, so the self-drawn dash box on the Elgato touch strip shows the setting's label only (no value), via layouts/view-adjustment.json. dial.pressAction/dial.longPressAction/dial.tapAction/dial.longTouchAction are configurable gestures over {Recenter VR, None}, Press defaulting to Recenter VR (blind-safe, the VR use case that motivates the dial); Recenter VR is a press gesture here, not a rotation mode |
| Replay Control | 27 | play/pause, play-backward, stop, FF, rewind, slow-mo, slow-mo-rewind (FF/RW + slow-mo modes share a configurable Step Rate that walks the speed ladder per press), frame +/-, speed +/-, set-speed, speed-display, session next/prev, lap next/prev, incident next/prev, jump to beginning/live/my car, jump-to-fastest-lap (target: Viewed Car / Always my car; session-scoped; no clean-lap filter), next/prev car, next/prev car number |
| Camera Controls | 13 | change-camera, cycle (camera / sub-camera / car / driving), focus (your car / leader / incident / most exciting), switch (by position / car number), set-camera-state, focus-select-car (Elgato-only: opens the iRaceDeck Car Selector profile with a focus intent; car presses focus the camera and stay on the grid). One action for BOTH surfaces (#803, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Dial (settings under the dial root; PI branches per actionInfo.payload.controller; dial logic in camera-dial-surface.ts behind a host interface, the Fuel Service pattern; shared camera-group subset walk in camera-groups.ts): dial.mode picks the target (camera / sub-camera / car-number / race-position / driving; default car-number, legacy car migrates to car-number) and rotation moves one step per detent (clockwise = next). The cycle modes (camera/sub-camera/driving) reuse the keypad's own executeCycle SDK dispatch; car-number and race-position focus the neighbouring car computed from an explicit ordering — ascending car number (getAllCarNumbers), or the canonical getLiveRacePositions order per race-positions.md (official CarIdxPosition fallback) — both dispatched via Switch-by-Number: race-position resolves its target to a car number from that same order (never a bare position) so the carousel preview and the actual focus always agree, even where canonical and official position orders diverge (#803 rework review). The touch strip is a CAROUSEL (Elgato-only via layouts/camera-focus.json) with the MODE name on its top line: Cycle Camera shows the current camera group's icon (from CAMERA_SELECT_ICONS, the enabled global cameraGroupSubset) with dimmed prev/next either side; Cycle Sub-Camera shows the current camera's NAME within the focused group (from CameraInfo.Groups[].Cameras[] via getCamerasInGroup + computeSubCameraCarousel — the same carousel the sub-camera dispatch steps through, so preview == execution incl. wrap) flanked by the adjacent cameras; the car modes show the focused car number (CamCarIdx + driver list) flanked by prev/next, with a P<pos> badge in race-position; Cycle Driving Camera shows the current group icon+name ONLY (driving hands group ± 1 to iRacing to resolve+wrap, so no coherent neighbour to preview) — per-mode color-coded, falling back to a mode-identity label out of session. Cycle Camera's dial PI reuses the keypad camera-groups checkbox grid bound to the global cameraGroupSubset. Four gesture slots (press / long-press / tap / long-touch) over {Focus My Car, Change Camera, Focus on Leader, Focus on Incident, Focus on Most Exciting, None}, all default None, all iRacing API |
| Camera Editor Adjustments | 15 | latitude, longitude, altitude, yaw, pitch, fov-zoom, key-step, vanish-x, vanish-y, blimp-radius, blimp-velocity, mic-gain (all +/-), auto-set-mic-gain, f-number (+/-), focus-depth (+/-). One action for BOTH surfaces (#804, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Dial (settings under the dial root; PI branches per actionInfo.payload.controller; camera-editor-adjustments-dial-surface.ts): dial.setting picks one of the 14 rotatable parameters (Auto Set Mic Gain excluded — it is a press gesture, not a rotation value); turning steps it via the shared camEdit* increase/decrease bindings (both must be bound). iRacing exposes no camera-tool state, so the self-drawn dash box on the Elgato touch strip (layouts/camera-editor-adjustments.json) is identity-only — label only, never a live number. dial.pressAction/dial.longPressAction and the Elgato-only dial.tapAction/dial.longTouchAction are configurable over {None, Auto Set Mic Gain, and every Camera Editor Controls one-shot — the camCtrl* keys reused verbatim (#804)}, all defaulting to None; Auto Set Mic Gain taps camEditAutoSetMicGain, each camera-tool one-shot taps its camCtrl* binding |
| Camera Editor Controls | 30 | Open Camera Tool, 14 toggles (key accel/10x, parabolic mic, temp edits, dampening, zoom, beyond fence, in cockpit, mouse nav, pitch/roll gyro, limit shot range, show camera, shot selection, manual focus), cycle position/aim type, acquire start/end, camera CRUD (insert/remove/copy/paste), group CRUD (copy/paste), track/car save/load |
Media
| Action | Modes | Mode values |
|---|
| Media Capture | 7 | start-stop-video, video-timer, toggle-video-capture, take-screenshot, take-giant-screenshot (keyboard), reload-all-textures, reload-car-textures |
Pit Service
| Action | Modes | Mode values |
|---|
| Pit Quick Actions | 3 | clear-all-checkboxes, windshield-tearoff (telemetry-aware), request-fast-repair (telemetry-aware) |
| Fuel Service | 8 | toggle-fuel-fill (telemetry-aware), add-fuel, reduce-fuel, set-fuel-amount, clear-fuel, toggle-autofuel (telemetry-aware), lap-margin-increase, lap-margin-decrease. One action for BOTH surfaces (#759, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Keypad: the eight modes above; every fuel value goes through the iRacing API — add/reduce send pit.fuel(round(PitSvFuel ± amount)) against the live baseline, set sends the absolute amount, a target ≤ 0 empties the request (1 L then clearFuel — pit.fuel(0) means "keep existing"). The shared unit setting is auto|l|g|k (default Auto from live DisplayUnits; kg converts via DriverInfo.DriverCarFuelKgPerLtr, warn-and-skip when unavailable; legacy instances with a persisted mode but no unit migrate to l, persisted back so the PI shows it). Add/Reduce hold-to-repeat ≈250 ms. enableFuelingOnChange ("Auto-enable fueling") is KEYPAD-ONLY: preserve-off = pit.fuel(n) then pit.clearFuel(). Dial (settings under the dial root; PI branches per actionInfo.payload.controller): modal (manual vs autofuel, derived live from dpFuelAutoFillActive, not stored). A bare turn in manual mode sets fuel via dial.mode: Add Amount (amount to add) or Target Amount (desired total after the stop, the needed add (target − current) rounded up so you never finish under target, recomputed continuously as fuel burns and the request updated whenever the whole-unit amount changes while fuel-fill is on — while fuel-fill is off the fuel amount is not updated, though rotating still plans the target and turning fueling on/pressing sends it; marked by a red target line on the bar). A bare turn in autofuel mode adjusts the autofuel lap margin via the fuelServiceLapMarginIncrease/Decrease key bindings (coalesced). Rotating always auto-arms fueling (the dial deliberately ignores enableFuelingOnChange). The touch-strip slot is fully self-drawn with a full-width tri-state status band across the TOP (#728) — green "REFUEL: ON" / red "REFUEL: OFF" in manual mode, "AUTOFUEL: ON"/"AUTOFUEL: OFF"/gray "AUTOFUEL: N/A" in autofuel mode. The strip uses a single full-canvas pixmap encoder layout (layouts/fuel-service.json, box key, like Setup Brakes' layouts/setup-brakes.json); texts are positioned by explicit baselines (the deck app's QT renderer ignores dominant-baseline). Five configurable gesture slots — dial.pressAction (default Toggle Fueling), dial.longPressAction (default Toggle Autofuel, all platforms), dial.pushTurnAction (Full / No Fuel — CW fills, CCW empties — or None), dial.tapAction and dial.longTouchAction (default None, Elgato-only touch strip) — each over {Toggle Fueling, Toggle Full / No Fuel, Toggle Autofuel, Switch Mode, None}. Toggle Autofuel taps fuelServiceToggleAutofuel; Toggle Fueling and Toggle Full / No Fuel use the iRacing API; Switch Mode talks to nothing (it flips dial.mode). Press/long-press/push+turn are classified at dialUp (no timer). Both surfaces share one fuel-request pipeline (dedup clear-guard is action-wide). The readout refreshes every 5 s and immediately on a displayed-state change. Toggle reads the live PitSvFlags/FuelFill checkbox |
| Tire Service | 4 | change-all-tires, clear-tires, toggle-tires (telemetry-aware per-wheel), change-compound (telemetry-aware) |
Car Setup
| Action | Modes | Mode values |
|---|
| Setup Aero | 6 | view-{front-wing, rear-wing} (read-only, live dcFrontWing/dcRearWing), front-wing (+/-), rear-wing (+/-), qualifying-tape (+/-), rf-brake-attached |
| Setup Brakes | 13 | view-{brake-bias, brake-bias-fine, peak-brake-bias, brake-misc, engine-braking, abs-adjust} (read-only, live dcBrakeBias/dcBrakeBiasFine/dcPeakBrakeBias/dcBrakeMisc/dcEngineBraking/dcABS), abs-toggle, abs-adjust (+/-), brake-bias (+/-), brake-bias-fine (+/-), peak-brake-bias (+/-), brake-misc (+/-), engine-braking (+/-). One action for BOTH surfaces (#775, encoder: true, Controllers: ["Keypad","Encoder"] on Elgato only — Mirabox/Ulanzi are Keypad-only per #786). Keypad: the 13 modes above. Dial (settings under the dial root; PI branches per actionInfo.payload.controller; dial logic in setup-brakes-dial-surface.ts behind a host interface, the Fuel Service pattern): dial.setting picks one of {brake-bias, brake-bias-fine, peak-brake-bias, brake-misc, engine-braking, abs-adjust}; turn adjusts it via the shared Setup Brakes increase/decrease bindings (telemetry-aware; live value as a self-drawn color-coded "dash box" — short label BB/BBF/PEAK/MISC/ENG/ABS + big number, no bar, no % — on the Elgato touch strip via layouts/setup-brakes.json); dial.pressAction/dial.longPressAction/dial.tapAction/dial.longTouchAction are configurable gestures over {Toggle ABS, None}, Press defaulting to Toggle ABS; no View modes, no ABS Toggle rotation mode (#730) |
| Setup Chassis | 22 | view-{diff-preload, diff-entry, diff-middle, diff-exit, anti-roll-front, anti-roll-rear, power-steering, weight-jacker-left, weight-jacker-right} (read-only, live dcDiffPreload/dcDiffEntry/dcDiffMiddle/dcDiffExit/dcAntiRollFront/dcAntiRollRear/dcPowerSteering/dcWeightJackerLeft/dcWeightJackerRight), differential-preload/entry/middle/exit, front/rear ARB, left/right spring, LF/RF/LR/RR shock, power-steering (all +/-) |
| Setup Engine | 7 | view-{engine-power, throttle-shape, launch-rpm} (read-only, live dcEnginePower/dcThrottleShape/dcLaunchRPM), engine-power (+/-), throttle-shaping (+/-), boost-level (+/-), launch-rpm (+/-) |
| Setup Fuel | 7 | view-{fuel-mixture, fuel-cut-position} (read-only, live dcFuelMixture/dcFuelCutPosition), fuel-mixture (+/-), fuel-cut-position (+/-), disable-fuel-cut, low-fuel-accept, fcy-mode-toggle |
| Setup Hybrid | 9 | view-{mguk-deploy-mode, mguk-regen-gain, mguk-deploy-fixed} (read-only, live dcMGUKDeployMode/dcMGUKRegenGain/dcMGUKDeployFixed), mguk-regen-gain (+/-), mguk-deploy-mode (+/-), mguk-fixed-deploy (+/-), hys-boost (hold), hys-regen (hold), hys-no-boost |
| Setup Traction | 9 | view-tc-slot-{1,2,3,4} = "TC1"…"TC4" (read-only, live dcTractionControl/dcTractionControl2/dcTractionControl3/dcTractionControl4), tc-toggle, tc-slot-1/2/3/4 (all +/-, labelled TC1–TC4 in the PI) |
Communication
| Action | Modes | Mode values |
|---|
| Chat | 7 | send-message, macro (1-15), reply, whisper (keyboard), toggle (keyboard), open-chat, cancel (respond-pm is a hidden alias of reply retained for backward compatibility — not exposed in the PI dropdown) |
| Race Admin | 28 | yellow, black-flag, dq-driver, show-dqs-field, show-dqs-driver, clear-penalties, clear-all, wave-around, eol, pit-close, pit-open, pace-laps, single/double-file-restart, advance-session, grid-set, grid-start, track-state, grant/revoke-admin, remove-driver, enable/disable-chat (all/driver), message-all, rc-message, select-car (Elgato-only car selector: auto-fills a car per key, stores the shared admin target). Driver Target adds a selected-car option that acts on that shared target. |
Stream Deck
| Action | Modes | Mode values |
|---|
| Switch Profile | 1 | single behavior, no Mode dropdown (#736) — the Profile setting picks a bundled profile to switch to (default iRaceDeck Default) or "Back to previous" (walks the per-device history of visited iRaceDeck profiles, ending at the device's Default); a "Placed in profile" marker setting (#762) keeps the back-history correct for keys inside bundled profiles. Elgato-only, keypad-only, no iRacing command; forward switches land on the first page (page index 0). |
Control Patterns
| Pattern | Description | Examples |
|---|
| Directional (+/-) | Setting key + direction enum | Setup actions, view adjustments |
| Enumerated | Single dropdown selects the control | Camera focus targets, UI elements |
| Composite | Multiple dropdowns combine | Audio (category + action), black box (mode + box) |
| Hold | Key held while button pressed | Look direction, HYS boost/regen |
| Telemetry-aware | Icon updates from live data | Session info, car control (pit limiter), tire service |
| Read-only View | Setting prefixed view-…; the action subscribes to telemetry and renders the live dc* value, with key presses suppressed | Setup actions' View sub-modes (issue #541) |
Keeping in Sync
When actions are added, removed, or modified (new modes, renamed settings, changed categories), update these files in the same change:
docs/reference/actions.json — add/update the action entry with all modes- This skill file (
SKILL.md) — update the category overview table (counts) and the per-category action tables
packages/website/src/content/docs/index.mdx — update category cards and stats if counts changedpackages/website/src/content/docs/docs/actions/overview.md — update the header totals and category table if counts changedpackages/website/src/content/docs/docs/actions/ — add/update the action's documentation pagepackages/website/astro.config.mjs — add new action slugs to the sidebar if a new action was created
Key Project Files
| File | Role |
|---|
packages/iracing-plugin-stream-deck/com.iracedeck.sd.core.sdPlugin/manifest.json | Action registration, UUIDs |
packages/iracing-actions/src/actions/<name>/ | Per-action folder: <name>.ts, <name>.test.ts, <name>.ejs, icon.svg, key.svg |
packages/iracing-actions/src/actions/data/key-bindings.json | Global key binding definitions |
packages/iracing-actions/src/actions/data/icon-defaults.json | Default icon colors by action/variant |
packages/iracing-actions/src/actions/data/docs-urls.json | PI "Open documentation" links |
packages/iracing-actions/src/actions/settings/settings.ejs | Plugin-global Property Inspector |
packages/iracing-actions/icons/ | Dynamic SVG Mustache templates used at runtime |
packages/icons/ | Standalone icon library (Mustache color placeholders + <desc>) |
packages/iracing-plugin-stream-deck/src/plugin.ts | Action registration and initialization |
