Lists the games whose force feedback and other game-wide control settings JoyPro manages, with every setting, its
range and default. Reload in Settings > Force feedback settings of the games runs it to build the rows.
engine ffb models --text
Advanced
Per game: title, description, settings (key, label, on/off or range, default, help).
A setting marked game-wide is set with --device * (engine ffb set); the others per device.
What it does Lists the games whose force feedback settings JoyPro manages and their settings (DCS ffDiffs per device and aircraft, IL-2 startup.cfg game-wide).
engine ffb show [--device <device>] [--game <game>] [--plane <plane>]
For beginners
Lists the force feedback settings stored in the profile; with --device and --game (and --plane) also what that
device gets in that game. Reload in Settings > Force feedback settings of the games runs it.
Stores force feedback settings of a game for a device (or game-wide), optionally for one aircraft. The next export
writes them into the game. Apply in Settings > Force feedback settings of the games runs it.
--device <name> or * (game-wide settings need *, per-device settings a device name) and --game are
required; --plane makes it an aircraft's own value.
--param <name>=<value> (repeatable): checked against the game's settings and ranges; on/off settings take
true/false or 1/0.
Values you do not store stay as the game has them.
Technical internals
Output: Key, Values, Message (Set <key>: ...), or Force feedback: ...; exit code 0.
Failures (exit 1): ffb set requires --device <device or *> and --game <game>., JoyPro manages no force feedback settings for '...'. See: engine ffb models., ffb set needs at least one --param <name>=<value>., Unknown ... force feedback setting '...', ... is a game-wide setting: use --device *.
Removes stored force feedback settings: a whole scope, or single settings with --param. The game keeps its own
values for them at the next export. Clear and a row's Unset in Settings > Force feedback settings of the games
run it.
JoyPro's telemetry force feedback: settings, game setup, process, last status
For beginners
Shows JoyPro's own telemetry force feedback: its settings, per game whether the telemetry export is set up and the game
runs, the JoyPro.Ffb process and its last status. Reload settings on the Force Feedback page runs it.
engine ffb telemetry status --text
Advanced
Games: DCS, IL-2 Great Battles, IL-2 Korea, War Thunder; each with its endpoint (UDP port, War Thunder's HTTP
address) and whether setup is needed.
What it does JoyPro's own telemetry force feedback (JoyPro.Ffb): the settings, per game whether its telemetry is set up and the game runs, the JoyPro.Ffb process and its last status line.
What it does Lists the effect names of the built-in force feedback graph (buffet, gforce, gear, flaps, speedbrake, runway, guns, hits, shake, spring) that the per-game switches refer to.
Shows the telemetry force feedback settings, with every value you did not set filled in with its default.
engine ffb telemetry config show --text
Advanced
Global: enabled (default off), device, deviceName, strength (1), maxForce (the hard force cap, 0.6),
invertX, invertY, tickRateHz (50), timeoutSeconds (0.5), centringSpring (on), centringStiffness (0.3).
devices: per force feedback device (instance GUID) its own directions.
games: per game enabled (on), port (0 = the game's default), graph, strength (1), url (War Thunder,
http://127.0.0.1:8111/), pollHz (20), effects, and aircraft with their own graph, strength and effects.
A file that cannot be read gives a warning, and the defaults apply. Read-only; not part of the profile.
Technical internals
Output: JSON ConfigPath, Config, Warnings; with --text the settings themselves as indented JSON; exit code
0.
Changes telemetry force feedback settings: the global ones, a game's, an aircraft's, an effect's, or a device's
directions. The Force Feedback page saves each change with it a moment after you make it and then tells a running
JoyPro.Ffb to reload.
enabled, device, device-name, strength (0..1), max-force (0..1, the hard force cap), invert-x, invert-y, tick-rate (10..200 Hz), timeout (0.1..5 s), centring-spring, centring-stiffness (0..1)
game
--game DCS|IL2Game|IL2Korea|WarThunder
enabled, port (0..65535), graph, strength (0..2), url, poll-hz (1..60)
aircraft
--game--plane <aircraft>
graph, strength (0..2)
effect
--game [--plane] --effect <name>
enabled, strength (0..2)
device
--device {guid} alone
invert-x, invert-y
--param <key>=<value> is repeatable. Switches take true/false, 1/0, on/off, yes/no; a number
outside its range is refused.
url must be an http address on this PC. graph is a *.jpffb.json file name (another name gives a warning). An
effect name outside engine ffb telemetry effects gives a warning: it only acts on graphs that use that name.
When one value is refused nothing is written. Not part of the profile.
Technical internals
Output: JSON ConfigPath, Changes, Warnings, Config, or text with a line * <scope>: <field> = <value> per
change; exit code 0.
Failures (exit 1): config set needs at least one --param <key>=<value>., --param needs <key>=<value>: ...,
Unknown <scope> setting '...' (...), <key> must be <min>..<max>., --plane and --effect need --game., --device cannot be combined with --game, --plane or --effect., url must be an http address on this PC (e.g. http://127.0.0.1:8111/).
What it does Sets telemetry force feedback settings: global (enabled, device, device-name, strength, max-force = the hard force cap, invert-x/y, tick-rate, timeout, centring-spring, centring-stiffness), per device (--device: invert-x, invert-y), per game (enabled, port, graph, strength, url, poll-hz), per aircraft (graph, strength) or per effect (enabled, strength).
Option
Values
Meaning
--game
DCSIL2GameIL2KoreaWarThunder
Game filter value. Example: DCS or IL2Game.
--plane
<aircraft>
Include one plane/module per flag. Example: --plane A-10C_2.
--effect
<name>
--device
switch (no value)
Include one device per flag. Example: --device LEFT VPC Throttle.
--param
<key>
A response model parameter as name=value, repeatable. Example: --param sensitivity=22 --param offset=10.
Every value as a command line
engine ffb telemetry config set --game DCS
engine ffb telemetry config set --game IL2Game
engine ffb telemetry config set --game IL2Korea
engine ffb telemetry config set --game WarThunder
Resets part of the telemetry force feedback settings to the defaults: a game, an aircraft, an effect, a device, or
everything. Remove next to an aircraft on the Force Feedback page runs it for that aircraft.
No option: every setting back to the defaults. --game: that game. --game --plane: the aircraft's own graph and
strength. --game [--plane] --effect: the effect back to on, strength 1.
--device {guid}: removes that device's entry (the global directions apply again).
--plane and --effect need --game; --param is refused.
Not part of the profile.
Technical internals
Output: ConfigPath, Changes, Warnings, Config, or text; exit code 0.
Failures (exit 1): config clear takes no --param; it resets the whole scope., config clear --plane/--effect needs --game., --device needs the device's instance guid ({...}): ....
DCS Hooks script / IL-2 startup.cfg telemetry target; backed up
For beginners
Makes a game send its telemetry to JoyPro, or takes that back with --remove. Install, Remove and Dry run
under Telemetry export on the Force Feedback page run it. Close the game first.
engine ffb telemetry setup dcs --dry-run --text
Advanced
dcs: writes Scripts\Hooks\JoyProFfb.lua in every Saved Games\DCS* folder (or --path); Export.lua is not
touched. A file of that name not written by JoyPro is not replaced (and not deleted by --remove).
il2 / il2korea: one addrN line in [KEY = telemetrydevice] of data\startup.cfg (the section is made when
missing); JoyPro remembers what it changed so --remove takes exactly that back.
warthunder: nothing to set up.
--dry-run lists the changes and writes nothing.
Safety: refused while DCS or IL-2 runs; changed files are backed up first (undo: engine backups list).
Technical internals
Output: Game, Action, DryRun, Installed, Detail, Files, Changes, Warnings, Errors; exit code 0,
1 on errors (No DCS Saved Games folder found (use --path <Saved Games\DCS>)., ... does not exist (start the game once)., Close <game> first: ...).
What it does Sets a game up to send telemetry to JoyPro: DCS gets Saved Games\DCS*\Scripts\Hooks\JoyProFfb.lua (Export.lua is not touched), IL-2 one addrN line in [KEY = telemetrydevice] of data\startup.cfg; War Thunder needs nothing. Backed up; --remove undoes it; --dry-run lists the changes.
Option
Values
Meaning
--remove
switch (no value)
--dry-run
switch (no value)
Report what the command would do; nothing is written or changed.
--path
<Saved Games\DCS | IL-2 folder | startup.cfg>
Optional explicit path override. Use when you prefer option form over positional path.