JoyPro2 Discord GitHub
Engine (CLI)

engine ffb

Show:

10 commands of engine ffb. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.

#engine ffb models

written
engine ffb models
For beginners

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.
  • Read-only; no profile needed.
Technical internals

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).

Used by the GUI Settings: Reload

Example

engine ffb models --text

#engine ffb show

written
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.

engine ffb show --device "VPforce Rhino FFB Joystick" --game DCS --plane F-16C_50 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • --device filters the stored entries (key <device>|<scope>).
  • The resolved values: "(game file values)" when nothing is stored, so the game keeps its own.
  • Read-only.
Technical internals

What it does Lists the stored force feedback settings; with --device and --game, what that device gets in the game (and aircraft).

OptionValuesMeaning
--device<device>Include one device per flag. Example: --device LEFT VPC Throttle.
--game<game>Game filter value. Example: DCS or IL2Game.
--plane<plane>Include one plane/module per flag. Example: --plane A-10C_2.

Used by the GUI Settings: Reload · Settings: Unset · Settings: Apply · Settings: Clear

Example

engine ffb show --device 'VPforce Rhino FFB Joystick {...}' --game DCS --plane F-16C_50 --text

#engine ffb set

written
engine ffb set --device <device>|* --game <game> [--plane <plane>] --param <name>=<value>...
For beginners

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.

engine ffb set --device * --game IL2Game --param force=0.8 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • --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 *.
  • Stored in the profile; one undo step with --profile. Related: engine ffb clear, engine dcs ffb set (DCS's swap and invert per device).

What it does Sets force feedback settings of a device (or * for game-wide ones) for a game or one aircraft; written on the next export of that game.

OptionValuesMeaning
--device<device>The device whose settings these are, or * for the game-wide settings.
--game<game>The game the settings are for (engine ffb models lists them). Example: DCS or IL2Game.
--plane<plane>Only this aircraft (a per-aircraft scope); default: the whole game.
--param<name>A force feedback setting as name=value, repeatable (engine ffb models lists the names and ranges). Written on the next export of the game.

Used by the GUI Settings: Apply

Example

engine ffb set --device 'VPforce Rhino FFB Joystick {...}' --game DCS --plane F-16C_50 --param trimmer=0.8 --param shake=0.3 --text
engine ffb set --device * --game IL2Korea --param enabled=false --text

#engine ffb clear

written
engine ffb clear --device <device>|* --game <game> [--plane <plane>] [--param <name>]...
For beginners

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.

engine ffb clear --device "VPforce Rhino FFB Joystick" --game DCS --plane F-16C_50 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • --device <name>|* and --game required, --plane for an aircraft scope.
  • Without --param: every value of that scope; --param <name> (repeatable): only those.
Technical internals
  • Output: Key, Values, Message (Cleared <key>. when nothing is left); exit code 0.
  • Failures (exit 1): as engine ffb set.
  • One undo step with --profile.

What it does Removes a scope's force feedback settings, or single values with --param; the game file's values then stay as they are.

OptionValuesMeaning
--device<device>The device whose settings are removed, or * for the game-wide settings.
--game<game>The game the settings are for. Example: DCS.
--plane<plane>Only this aircraft's settings; default: the game's.
--param<name>Remove only this setting (repeatable); without it the whole scope is removed.

Used by the GUI Settings: Unset · Settings: Clear

Example

engine ffb clear --device * --game IL2Korea --text

#engine ffb telemetry status

written
engine ffb telemetry status

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.
  • Read-only; no profile needed.
Technical internals

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.

Used by the GUI Force Feedback: Reload settings

Example

engine ffb telemetry status --text

#engine ffb telemetry effects

written
engine ffb telemetry effects
For beginners

Lists the effect names of JoyPro's built-in telemetry force feedback graph: the names the per-game and per-aircraft effect switches use.

engine ffb telemetry effects --text
Advanced
  • buffet (stall / AoA buffet), gforce (G-force stick weight), gear and flaps (rumble while they move), speedbrake (speed brake buffet), runway (runway rumble), guns (gun fire bursts), hits (hits taken), shake (cockpit shake, IL-2), spring (centring spring: airspeed stiffening and trim).
  • Switch one on or off, or change its strength, with ffb telemetry config set --game <game> [--plane <aircraft>] --effect <name>.
  • Read-only; no profile needed.
Technical internals

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.

Example

engine ffb telemetry effects --text

#engine ffb telemetry config show

written
engine ffb telemetry config show
For beginners

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

What it does Shows the telemetry force feedback settings file (<data>\Ffb\Telemetry\telemetry-ffb.json) with every default filled in.

Example

engine ffb telemetry config show --text

#engine ffb telemetry config set

written
engine ffb telemetry config set [--game DCS|IL2Game|IL2Korea|WarThunder] [--plane <aircraft>] [--effect <name>] | [--device {guid}] --param <key>=<value>...

Keys: global enabled, device, device-name, strength, max-force, invert-x, invert-y, tick-rate, timeout, centring-spring, centring-stiffness; --device invert-x, invert-y; --game enabled, port, graph, strength, url, poll-hz; --plane graph, strength; --effect enabled, strength

For beginners

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.

engine ffb telemetry config set --game DCS --effect buffet --param strength=0.7 --text
Advanced
Scope Options --param keys
global none 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.
  • Game names also: dcs, il2 / il-2 / il2gb, il2korea / korea, wt / warthunder.
  • 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/).
  • Writes %LOCALAPPDATA%\JoyPro2\Ffb\Telemetry\telemetry-ffb.json. Reference: ffb-telemetry. Related: engine ffb telemetry config show, engine ffb telemetry config clear.

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).

OptionValuesMeaning
--gameDCS IL2Game IL2Korea WarThunderGame filter value. Example: DCS or IL2Game.
--plane<aircraft>Include one plane/module per flag. Example: --plane A-10C_2.
--effect<name>
--deviceswitch (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

Example

engine ffb telemetry config set --param enabled=true --param max-force=0.5 --text
engine ffb telemetry config set --game DCS --effect buffet --param strength=0.7 --text
engine ffb telemetry config set --game DCS --plane F-16C_50 --param graph=viper.jpffb.json --text

#engine ffb telemetry config clear

written
engine ffb telemetry config clear [--game <game>] [--plane <aircraft>] [--effect <name>] | [--device {guid}]
For beginners

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.

engine ffb telemetry config clear --game DCS --plane F-16C_50 --text
Advanced
  • 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 ({...}): ....
  • Writes telemetry-ffb.json. Related: engine ffb telemetry config show.

What it does Resets a scope of the telemetry force feedback settings to the defaults (a game, an aircraft, an effect, or everything).

OptionValuesMeaning
--game<game>Game filter value. Example: DCS or IL2Game.
--plane<aircraft>Include one plane/module per flag. Example: --plane A-10C_2.
--effect<name>
--deviceswitch (no value)Include one device per flag. Example: --device LEFT VPC Throttle.

Used by the GUI Force Feedback: Reload settings · Force Feedback: Remove

Example

engine ffb telemetry config clear --game DCS --plane F-16C_50 --text

#engine ffb telemetry setup

written
engine ffb telemetry setup dcs|il2|il2korea|warthunder [--remove] [--dry-run] [--path <Saved Games\DCS | IL-2 folder | startup.cfg>]

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: ...).
  • Reference: ffb-telemetry. Related: engine ffb telemetry status.

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.

OptionValuesMeaning
--removeswitch (no value)
--dry-runswitch (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.

Used by the GUI Force Feedback: Install

Example

engine ffb telemetry setup dcs --dry-run --text
engine ffb telemetry setup il2 --text
engine ffb telemetry setup il2 --remove --text