JoyPro2 Discord GitHub
Engine (CLI)

engine sync

Show:

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

#engine sync status

written
engine sync status [--game <id>] [--path <config>]

Per game the config files / registry values JoyPro manages, their fingerprint and whether the game changed them since JoyPro's last export, accept or apply

For beginners

Shows per game whether the game changed the config files (or registry values) JoyPro manages since JoyPro's last export, import or accept. The watcher runs it after a game closed; the Start page and Settings > Games use it to show what is watched (sync-watcher).

engine sync status --game DCS --text
Advanced
  • --game <id> checks one game (DCS, IL2Game, StarCitizen or an id of engine games integrations); --path <config> checks another config of it (needs --game).
  • States: unchanged, changed (with the changed files and, for DCS, the aircraft), untracked (no export or import recorded yet: not watched), missing (no config found), not-installed, disabled (hidden game).
  • A file with new content counts; a new write time with the same content does not. Configs JoyPro exported to elsewhere are listed too.
  • Read-only. Also reports what the watcher needs: folders and file filters or the registry key, the game's processes and the settle time.
Technical internals
  • Output: JSON (DataFolder, Games with State, ConfigPath, Kind, Fingerprint, ChangedFiles, ChangedPlanes, Watch, ProcessNames, SettleSeconds, ...), or text with --text. Records are in %LOCALAPPDATA%\JoyPro2\Sync\<game>.json.
  • Exit code 0; 1 with Unknown game: ..., --path needs --game. or an unknown option.
  • Related: engine sync diff, engine sync accept, engine sync pending.

What it does Per game the config files (or registry values) JoyPro manages, their fingerprint and whether the game changed them since JoyPro's last export, accept or apply (docs/sync-watcher.md).

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--path<config>Optional explicit path override. Use when you prefer option form over positional path.

Used by the GUI Start: Refresh · Settings: Detect again · Settings: Use detected · Dialogs and notices: Take over · Dialogs and notices: Not now · Dialogs and notices: Ignore these

Example

engine sync status --text
engine sync status --game DCS

#engine sync accept

written
engine sync accept --game <id> [--path <config>]

The current config counts as known; nothing is imported

For beginners

Records the game's current config as known, without importing anything. The watcher then stops offering those changes, and the next export writes your profile over them. The watcher dialog's Ignore these runs it; the GUI also runs it by itself when a change touches nothing JoyPro manages.

engine sync accept --game DCS
Advanced
  • --game <id> is required; --path <config> names another config of the game.
  • Stores a new fingerprint and baseline of the config in the sync record. The profile and the game do not change.
Technical internals
  • Output: JSON (Game, ConfigPath, State unchanged, Fingerprint, RecordedUtc, Baseline, Warnings), or a text line with --text.
  • Exit code 0; 1 with engine sync accept needs --game <id>. or No <game> config found: <path>.
  • Related: engine sync status, engine sync apply.

What it does Marks the game's current config as known without importing anything.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--path<config>Optional explicit path override. Use when you prefer option form over positional path.

Used by the GUI Dialogs and notices: Take over · Dialogs and notices: Not now · Dialogs and notices: Ignore these

Example

engine sync accept --game WarThunder

#engine sync diff

written
engine sync diff --game <id> [--path <config>]

What the game changed that JoyPro manages, compared with the profile: added, removed, changed-tuning, changed-modifiers, with candidate relations

For beginners

Lists what the game changed in the binds and settings JoyPro manages, compared with your profile, with the relations each change could go to. The watcher runs it to fill its dialog after a game closed.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" sync diff --game DCS --text
Advanced
  • --game <id> is required; --path <config> names another config. Pass --profile.
  • Kinds: added, removed, changed-tuning, changed-modifiers, changed-setting (a game-wide setting the profile holds). Each change has an id, candidate relations and a suggested target (a relation, new or ignore).
  • Only what JoyPro manages counts: devices the profile uses, actions JoyPro writes, values compared rounded as the game uses them, against the baseline of the last record.
  • The config is read into a scratch copy; the loaded profile and the game do not change.
Technical internals
  • Output: JSON (Game, ConfigPath, Tracked, Baseline, Planes, ProfileBinds, FileBinds, Changes, Warnings, Errors), or text with --text.
  • Exit code 0; 1 when the config cannot be read (sync diff failed: ... on stderr) or without --game.
  • Change ids stay the same while the file and the profile do not change, so engine sync apply can use them.

What it does Reads the game's config with its own import into a scratch profile and lists what changed that JoyPro manages (added, removed, changed-tuning, changed-modifiers) with the candidate relations.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--path<config>Optional explicit path override. Use when you prefer option form over positional path.

Used by the GUI Dialogs and notices: Take over · Dialogs and notices: Not now · Dialogs and notices: Ignore these

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' sync diff --game DCS --text

#engine sync apply

written
engine sync apply --game <id> --choices <file.json> [--path <config>]

Per change id: Target = relation name, "new" (+ Name) or "ignore"; then the config counts as known

For beginners

Takes the game's changes into your profile, each into the relation you chose, and records the config as known. The watcher dialog's Take over runs it with your choices.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" sync apply --game DCS --choices "C:\Users\Pilot\Documents\choices.json"
Advanced
  • --choices <file.json>: {"Choices":[{"Id":"c1a2b3c4d5","Target":"Gear Toggle"},{"Id":"...","Target":"new", "Name":"My Relation"},{"Id":"...","Target":"ignore"}]} (or the bare list). Ids come from engine sync diff.
  • Target: a relation name, new (a new relation, Name optional) or ignore; for a changed-setting any target but ignore takes the game's value. Changes not listed count as ignored.
  • Removals are applied first, so a moved bind is not undone by its old relation's removal.
  • Afterwards the config counts as known: ignored changes are not offered again.
  • With --profile the profile is saved afterwards (one undo step). The game does not change.
Technical internals
  • Output: JSON (Applied, Ignored, NewRelations, ChangedRelations, Fingerprint, Steps, Warnings), or text with --text.
  • Exit code 0; 1 with engine sync apply needs --choices <json file>., Choices file not found: <path>, a file that is no choices list, or sync apply: the game's config could not be read: .... A change id that is no longer in the config is skipped with a warning.
  • Related: engine sync accept, engine sync pending.

What it does Applies the user's choice per change (a relation, a new relation or ignore) to the profile; then the config counts as known.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--choices<file.json>For sync apply: JSON file with the user's choice per change id: {"Choices":[{"Id":"c1a2b3c4d5","Target":"Gear Toggle"},{"Id":"...","Target":"new","Name":"My Relation"},{"Id":"...","Target":"ignore"}]}.
--path<config>Optional explicit path override. Use when you prefer option form over positional path.

Used by the GUI Dialogs and notices: Take over

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' sync apply --game DCS --choices 'C:\JoyPro\sync-choices.json'

#engine sync pending

written
engine sync pending --game <id> [--path <config>]

What you changed in JoyPro since the last export of the game and the game does not have yet: an import before the next export brings the old binds back

For beginners

Shows what you changed in JoyPro since the last export of a game that the game does not have yet. The GUI asks before an import that would bring the old binds back.

engine sync pending --game DCS --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

--game <id> is required (DCS, IL2Game, StarCitizen or a game of engine games integrations); --path <config> checks another config folder and needs --game. Read-only.

Technical internals

What it does What you changed in JoyPro since the last export of the game and the game does not have yet: an import before the next export brings the old binds back.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--path<config>Optional explicit path override. Use when you prefer option form over positional path.

Used by the GUI Start: Import now · Start: Import · Start: Import · Start: Import · Start: Import

Example

engine sync pending --game <id> --text