SimHub Installation

Requirements

• SimHub installed (any recent version)
• iRacing
• Windows 10 or 11
• iReporter Button Box (optional - 4, 8, 16 or 24 button) OR Elgato Stream Deck (optional)

Quick Install (Recommended)

The easiest way to install iReporter is using the installer script. It downloads and installs everything automatically - no manual file copying required.

1. Download Install-iReporter.ps1 from the dist repo at https://github.com/AlanScottNZ/iReporter-dist
2. Right-click the downloaded file and choose Run with PowerShell
3. The installer will:
   • Download and install the latest iReporter DLL into SimHub
   • Detect whether Elgato Stream Deck software is installed and install the Stream Deck plugin automatically
   • Restart Stream Deck and open SimHub when complete
4. In SimHub, go to Additional Plugins and enable iReporterPlugin if not already active
5. Click iReporter in the SimHub left menu to open the settings panel

Manual Installation

If you prefer to install manually:

1. Close SimHub if it is running
2. Download iReporterPlugin.dll from the dist repo
3. Copy it into your SimHub installation folder, typically: C:\Program Files (x86)\SimHub\
4. Start SimHub and enable the plugin under Additional Plugins

Stream Deck Plugin Installation

If you use an Elgato Stream Deck, the iReporter Stream Deck plugin adds live button colour updates and status displays to your Stream Deck keys.

Option A - Double-click installer (easiest)

Download nz.co.logicalsolutions.ireporter.sdPlugin.streamDeckPlugin from the dist repo Double-click the file - Stream Deck software will install the plugin automatically The iReporter v0.181 category will appear in the Stream Deck action list

Option B - Install from within iReporter

Open iReporter settings in SimHub Set Input Mode to Stream Deck or iReporter Button Box & Stream Deck Click the Install Stream Deck Plugin button - iReporter downloads and installs the plugin automatically When prompted, click Yes to restart Stream Deck

First Run

On first launch iReporter creates a settings folder at: Documents\iReporter\

This folder contains:

iReporterSettings.txt - all your settings templates.txt - saved message templates logs\ - dated log files (one per day)

No further installation steps are required. Configure the plugin using the settings panel described in the Settings Reference section.

Updating iReporter

iReporter checks for updates automatically when SimHub starts. If a new version is available, a banner appears at the top of the settings panel. Click Check for Update at any time to manually trigger a check. The update downloads and installs with a single click - SimHub restarts automatically to apply it.

The Stream Deck plugin version is shown in the iReporter action category in Stream Deck software (e.g. iReporter v0.181). If a newer version is available after a SimHub update, the Update Stream Deck Plugin button in iReporter settings will turn amber - click it to update.