A SimHub plugin that connects OpenFFBoard force-feedback hardware to SimHub, enabling per-game FFB profiles that are automatically applied when you launch a game.
- HID connection — discovers and connects to OpenFFBoard via USB HID; no serial port configuration required
- Per-game profiles — stores FFB settings in a
profiles.jsonfile; the correct profile is automatically applied when SimHub detects a game change - Profile management — create a new profile for the current game (cloned from the Default profile) or apply an existing one to the board with dedicated buttons
- Graceful fallback — if no profile exists for the current game, no changes are sent to the board
- Bundled dashboard — ships with the "OpenFFBoard Companion - Input Display" overlay (input traces with ABS/TC highlighting, corner minimum speed, configurable extras via the plugin settings page; see
simhub_dashboards/) - Dashboard auto-update — when Auto-update bundled dashboards on startup is enabled in the plugin settings (default: on), the dashboard embedded in the plugin DLL is extracted into SimHub's
DashTemplatesfolder whenever its version is newer than the installed one, so the overlay always matches the plugin. Disable the toggle if you've customized the dashboard locally and don't want it overwritten.
| Class | Command | Description |
|---|---|---|
fx |
filterCfFreq |
Center-friction filter freq |
fx |
filterCfQ |
Center-friction filter Q |
fx |
spring |
Spring effect strength |
fx |
friction |
Friction effect strength |
fx |
damper |
Damper effect strength |
fx |
inertia |
Inertia effect strength |
axis |
power |
Overall FFB power |
axis |
degrees |
Steering lock (degrees) |
axis |
fxratio |
FX/direct ratio |
axis |
esgain |
Endstop gain |
axis |
idlespring |
Idle spring strength |
axis |
axisdamper |
Axis damper |
axis |
axisfriction |
Axis friction |
axis |
axisinertia |
Axis inertia |
Note:
axisinertiarequires OpenFFBSharp with the corrected command descriptor (0x17, MorGuux/OpenFFBSharp#8) — included in the bundledlib/OpenFFBSharp.dll. Older builds silently sent the wrong command ID.
- Go to Releases and download
OpenFFBoardPlugin.zip. - Extract all DLLs from the zip into your SimHub installation folder (default:
C:\Program Files (x86)\SimHub):OpenFFBoardPlugin.dllOpenFFBSharp.dllHid.Net.dllDevice.Net.dll
- Restart SimHub.
- Open Add/Remove features, search for
OpenFFBoard, enable it, and check Show in left menu.
The plugin reads a profiles.json file whose path you configure in the plugin settings.
{
"release": 2,
"profiles": [
{
"name": "None",
"data": []
},
{
"name": "Default",
"data": [
{ "fullname": "Effects", "cls": "fx", "instance": 0, "cmd": "spring", "value": 31 },
{ "fullname": "Axis", "cls": "axis", "instance": 0, "cmd": "degrees", "value": 1080 }
]
}
]
}- The
Noneprofile is special — selecting it sends no commands to the board. - The
Defaultprofile is used as the template when creating a new game profile. - Profile names are matched to game names case-insensitively.
- Visual Studio 2022
- SimHub installed (sets
SIMHUB_INSTALL_PATHenvironment variable) - .NET Framework 4.8
"C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin\MSBuild.exe" OpenFFBoardPlugin.sln /p:Configuration=Debug
The post-build event copies output DLLs to %SIMHUB_INSTALL_PATH% and the dashboard files from simhub_dashboards/ to %SIMHUB_INSTALL_PATH%DashTemplates\ automatically. If the env var is not set the build still succeeds and only the XCOPY steps are skipped.
The dashboard's .simhubdash file is also embedded into the plugin DLL as a resource — this is what powers the runtime dashboard auto-update. When you edit the dashboard, re-zip the folder contents into the .simhubdash, bump DashboardVersion in the .djson.metadata, and rebuild.
Set the external program target to C:\Program Files (x86)\SimHub\SimHubWPF.exe and press F5.
SimHub DLL references use the $(SIMHUB_INSTALL_PATH) MSBuild variable. Do not use NuGet for SimHub-provided assemblies — edit the .csproj manually. New DLLs must also be added to the post-build XCOPY.
Add via NuGet normally. Then add a corresponding XCOPY line to the post-build event so the DLL is deployed to SimHub alongside the plugin.
dotnet test OpenFFBoardPlugin.Tests/OpenFFBoardPlugin.Tests.csproj
Tests cover JSON loading/saving, the FlexibleListConverter (handles {} vs []), ProfileHolder logic, and fixture-based tests using a real profiles.json sample.
MIT
