Setup
Prerequisites
Section titled “Prerequisites”- Node.js 24 or newer
- pnpm (install with
npm install -g pnpm) - Windows (required for the native addon and iRacing integration)
- Stream Deck software 7.1 or newer
Getting Started
Section titled “Getting Started”# Clone the repositorygit clone https://github.com/niklam/iracedeck.gitcd iracedeck
# Install dependenciespnpm install
# Build all packagespnpm build
# Link the plugin to Stream Deck for testingpnpm link:stream-deck
# Start watching for changes (auto-rebuilds on save)pnpm watch:stream-deckAfter linking, restart the Stream Deck software. The plugin will appear in the action list as iRaceDeck. Changes you make will be picked up automatically when using watch:stream-deck.
Useful Commands
Section titled “Useful Commands”| Command | Description |
|---|---|
pnpm build | Build all packages |
pnpm build:stream-deck | Build only the Stream Deck plugin |
pnpm watch:stream-deck | Watch mode — rebuild on file changes |
pnpm link:stream-deck | Register the plugin with Stream Deck |
pnpm unlink:stream-deck | Unregister the plugin |
pnpm relink:stream-deck | Unlink + link (useful when switching branches) |
pnpm test | Run all tests |