JoyPro2 Discord GitHub
Engine (CLI)

engine wardogs (WARDOGS)

Show:

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

#engine wardogs paths

written
engine wardogs paths
For beginners

Lists where JoyPro finds the settings file of WARDOGS on this PC. The first one is what engine wardogs scan, engine wardogs import and engine wardogs export use when you give no path. Detect in the Other Games panel (Start page, Expert import) runs it and puts the first one into File / Folder.

engine wardogs paths --text
Advanced
  • %LOCALAPPDATA%\Wardogs\Saved\Config\WindowsClient\GameUserSettings.ini, listed when the file exists (the game writes it).
  • A config location you set yourself (engine games config set, Settings > Games) comes first.
  • No options. Reads only; it also works while the game runs or when it is not installed.
Technical internals

What it does Lists where JoyPro looks for this game's controls on this machine: files, folders or registry keys (your config location from games config set first). A file the game has not written yet can be listed (e.g. Arma Reforger's JoyPro.conf, Project Wingman's Input.ini).

Example

engine wardogs paths --text

#engine wardogs catalog

written
engine wardogs catalog
For beginners

Lists the WARDOGS actions JoyPro manages (its command list): id, axis or button, category and title. An export writes only these actions, and the relation editor and the search list them.

engine wardogs catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\Wardogs\actions.tsv (when that folder does not exist, the DB\Wardogs folder next to the engine).
  • It is built from your own GameUserSettings.ini by engine wardogs refresh-db, or by the first scan, import or export.
  • catalog only shows the list; it never builds it. Titles that look like ids are shown readable.
  • No options. Reads only; works without the game installed.
Technical internals
  • Output: JSON (Game, Source, Actions with Id, Title, IsAxis, Category, Warnings), or text with --text ("WARDOGS Action Catalog", "Source:", "Actions: ", then <id> | axis|button | <category> | <title> per action).
  • Without a list: the warning WARDOGS action catalog not found: <path> and an empty list, exit code 0.
  • Related: engine wardogs refresh-db, engine wardogs export, engine db games; game page wardogs.

What it does Lists every action of JoyPro's command list of this game with its kind and category: <data>\GameData\DB\<Game>\actions.tsv, else the program folder's DB\<Game>.

Example

engine wardogs catalog --text

#engine wardogs scan

written
engine wardogs scan [<config-path>] [--path <config-path>] [--ignore-device <name>] [--ignore-devices <csv>]
For beginners

Shows the joystick binds WARDOGS has now, without changing your profile or the game. Use it to look before an import. Look first on the game's card of the Start page and Scan in the Other Games panel run it.

engine wardogs scan --text
Advanced
  • It reads the section [/Script/WDJoystick.WDJoystickSettings]: the six axes (pitch, throttle, roll, yaw, look pitch, look yaw) with invert, sensitivity and dead zone, the axes' button halves, and the action binds. A warning says when the game's HOTAS option is off.
  • Path (positional or --path): another GameUserSettings.ini.
  • --ignore-device <name> / --ignore-devices <a;b> (separated by | or ;, --ignore-devices also by commas) leave the binds of those devices out (a name without {GUID} means every device of that name); a step line names them and counts the binds.
  • Keyboard binds are not read in this game.
  • Safety: reads only and is not refused while the game runs. It is refused when the game is not installed (set its folder: engine games install set) or switched off in Settings > Games.
  • The command list is built from your settings file the first time (a step line says so).
Technical internals
  • Output: JSON (ConfigPath, BindingsRead, Bindings with ActionId, Device, Input, IsAxis, Reformers, Inverted, then Steps, Warnings, Errors), or text with --text ("WARDOGS Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No WARDOGS config file found. Pass the path explicitly.
  • Unknown options fail with Unknown Wardogs scan argument(s): ...; MSFS options (--game-profile, --include-disconnected, --include-sim-defaults) are refused.
  • Binds of the vJoy device JoyPro forwards into (--vjoy-tunnel) are left out.
  • Related: engine wardogs import, engine wardogs paths, engine wardogs catalog; game page wardogs.

What it does Reads the game's controls (its control file or folder, or registry values for Nuclear Option and Tiny Combat Arena; Ace Combat 8 stores none) and shows the joystick binds, without changing the profile. Without a command list yet (fresh install) it first builds the list from the game and saves it.

OptionValuesMeaning
--path<config-path>Optional explicit path override. Use when you prefer option form over positional path.
--ignore-device<name>Leave the binds of this device out (one per flag; a name without {GUID} means every device of that name). Example: --ignore-device 'vJoy Device'.
--ignore-devices<csv>Leave the binds of these devices out (separated by commas, | or ;). Example: --ignore-devices 'vJoy Device,Old Pedals'.

In the game Reads WARDOGS's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. WARDOGS details · what each mode changes

Example

engine wardogs scan --text
How the options interact
  • --ignore-device / --ignore-devices leave the binds of those devices out of the scan or import (the result names how many).

#engine wardogs import

written
engine wardogs import [<config-path>] [--path <config-path>] [--replace] [--include-keyboard] [--ignore-device <name>] [--ignore-devices <csv>]

--ignore-device(s): the binds of these devices are left out

For beginners

Reads the binds of WARDOGS' HOTAS page into your JoyPro profile: pitch, roll, yaw, the collective, the look axes and the flight actions, each with invert, sensitivity and dead zone. Nothing in the game changes. The GUI runs it with Import on the WARDOGS card of the Start page.

engine wardogs import --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

It reads the section [/Script/WDJoystick.WDJoystickSettings] of %LOCALAPPDATA%\Wardogs\Saved\Config\WindowsClient\GameUserSettings.ini.

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the file has.
  • Keyboard binds (in the same file and in EnhancedInputUserSettings.sav) are not read; --include-keyboard changes nothing.
  • Sensitivity and dead zone come in as the relation's WARDOGS tuning, so your other games keep their own curves.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from WARDOGS" first.
  • --ignore-device <name> / --ignore-devices <a;b> leave the binds of those devices out (a name without {GUID} means every device of that name); a step line says how many binds were left out.
Technical internals
  • Output: JSON of the import result or a text report with --text; exit code 1 on an error (No WARDOGS config file found. Pass the path explicitly.).
  • Without a path it reads the file engine wardogs paths lists first. The command list is built from your settings file plus JoyPro's axes (engine wardogs refresh-db).
  • With --profile the profile is saved afterwards; a game JoyPro never exported to is watched from now on.
  • Related: engine wardogs scan, engine wardogs export; game page wardogs.

What it does Imports the game's joystick binds into the loaded profile (merged by default; --replace starts from an empty relation list). Without a command list yet it first builds the list from the game.

OptionValuesMeaning
--path<config-path>Optional explicit path override. Use when you prefer option form over positional path.
--replaceswitch (no value)For game import: start from an empty relation list instead of merging into the loaded profile.
--include-keyboardswitch (no value)
--ignore-device<name>Leave the binds of this device out (one per flag; a name without {GUID} means every device of that name). Example: --ignore-device 'vJoy Device'.
--ignore-devices<csv>Leave the binds of these devices out (separated by commas, | or ;). Example: --ignore-devices 'vJoy Device,Old Pedals'.

In the game Reads WARDOGS's files only; nothing changes in the game. The binds come into the profile as relations; JoyPro's own data next to the game file brings back names, groups, modifiers and curves. WARDOGS details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' wardogs import --text
How the options interact
  • --ignore-device / --ignore-devices leave the binds of those devices out of the scan or import (the result names how many).

#engine wardogs export

written
engine wardogs export [<config-path>] [--path <config-path>] [--mode clean|add|merge|merge-overwrite] [--dry-run] [--include-keyboard] [--nuke-untouched-devices] [--ignore-device <name>] [--ignore-devices <csv>]

Only aircraft/helicopter actions: clean and nuke release those on the written / unused devices; --ignore-device(s) and --vjoy-tunnel devices are never cleared

For beginners

Writes your helicopter binds into WARDOGS' settings file and switches Enable HOTAS on, so the game uses them. Close the game first, and open its HOTAS page once before the first export. The GUI's Export now on the WARDOGS card runs it.

engine wardogs export --mode clean --nuke-untouched-devices --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced

The game uses one bind per action. Every mode works only on JoyPro's cataloged helicopter actions in the joystick section of GameUserSettings.ini.

--mode In the file
add a bind goes in only where the action's slot is free and no other cataloged action uses the input; a bound slot is never replaced
merge your bind takes the action's slot; another cataloged action on the same input loses it; a second line of the action stays
merge-overwrite (engine default) as merge, and extra lines of the action go, so a moved action fully moves
clean (GUI default) the devices you write keep only your binds of the cataloged actions
  • --nuke-untouched-devices: connected devices without binds in your profile lose their cataloged binds (not with add).
  • Per axis: invert, sensitivity (0.1 to 2.0) and dead zone (0 to 0.5); without WARDOGS values they are fitted from your base curve. Enable HOTAS and Self-Centering Collective are written as you stored them (only when the file has the key); a profile without WARDOGS binds writes only those.
  • Without a joystick section in the file the export stops and asks you to open the HOTAS page in the game.
  • Never touched: keyboard and mouse binds, the keyboard save file, other sections, actions JoyPro does not catalog, unknown fields of a bind line, devices that are not connected, --ignore-device(s), the --vjoy-tunnel device.
  • Safety: refused while WardogsClient-Win64-Shipping or WardogsClient runs; backed up first (.jpbak and the backup store, undo: engine backups list); the profile is kept as "Before export to WARDOGS". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error (WARDOGS is running (...). Close the game first; it overwrites its config on exit., an invalid --mode, no file or no joystick section).
  • Without a path it writes the file engine wardogs paths lists first.
  • After a real run: GameUserSettings.ini.joypro-meta.json, the watcher's fingerprint, the export marks (engine export-marks list).
  • Related: engine wardogs import, engine ffb set (enableHotas); game page wardogs.

What it does Writes the profile's binds for this game. Only the flight actions JoyPro manages are changed, the game must be closed, and the game's files are backed up first (engine backups). Without a command list yet it first builds the list from the game.

OptionValuesMeaning
--path<config-path>Optional explicit path override. Use when you prefer option form over positional path.
--modeclean add merge merge-overwriteExport mode for DCS/IL2 export commands: clean, add, merge, merge-overwrite.
--dry-runswitch (no value)Report what the export would write; the game's files are not changed.
--include-keyboardswitch (no value)
--nuke-untouched-devicesswitch (no value)DCS export only: delete untouched device .diff.lua/.jp files under Config\\Input (true/false).
--ignore-device<name>Exclude one device per flag. Example: --ignore-device Keyboard.
--ignore-devices<csv>Exclude devices, separated by commas, | or ;. Example: --ignore-devices Keyboard,Mouse.
Every value as a command line
engine wardogs export --mode clean
engine wardogs export --mode add
engine wardogs export --mode merge
engine wardogs export --mode merge-overwrite

In the game Writes into WARDOGS's control files while the game is closed (refused while it runs), after a backup. Combat flight sims and combat flight games that read several joysticks. Bind file: %LOCALAPPDATA%\Wardogs\Saved\Config\WindowsClient\GameUserSettings.ini (Unreal ini, hashed field names). WARDOGS details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' wardogs export --dry-run --text engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' wardogs export --mode merge-overwrite --text

#engine wardogs refresh-db

written
engine wardogs refresh-db [<source-path>] [--path <source-path>] [--dry-run]

Reads the installed game or <source-path> and adds its new actions to the catalog, the known ones stay; writes it only when it changes

For beginners

Builds JoyPro's WARDOGS command list from your own WARDOGS settings file, or adds the actions that are new. Run it after a game update, or when JoyPro says the list is missing. Refresh DB in the Other Games panel (its DB Source box is the path) and the Start page's notice "Command lists to build or update" run it.

engine wardogs refresh-db --dry-run --text
Advanced
  • It reads GameUserSettings.ini (the file engine wardogs paths lists, or the file given as the path): every action its ActionBindings lines name comes in with category Flight. Only actions that have a line in the file can be found, so bind them in the game once.
  • The six axes and their positive and negative button halves come from JoyPro itself, so they are in a list built from nothing.
  • Known actions keep their entry.
  • --dry-run reads everything and writes nothing (step "Dry run: nothing was written."). Without it the list is written only when it changed.
  • Safety: only JoyPro's list changes, never a game file; it is refused when the game is not installed or switched off in Settings > Games. The GUI can cancel it while the game's files are read; nothing is written then.
Technical internals
  • Output: JSON of the refresh (DryRun, FilesWritten, Steps with Actions: <old> -> <new>, Warnings, Errors), or text with --text.
  • Exit code 0; 1 when nothing could be read: No WARDOGS actions could be read; the catalog was left unchanged. or the file's read error; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\Wardogs\actions.tsv (with a header line that has the date). After a real run the game's build is recorded for engine db check-updates.
  • Related: engine wardogs catalog, engine wardogs scan, engine db check-updates; game page wardogs.

What it does Reads the installed game or <source-path> and adds its new actions to the catalog, the known ones stay; writes it only when it changes.

OptionValuesMeaning
--path<source-path>Same as <source-path>: the game's installation or a file of the game to read the actions from.
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.

Example

engine wardogs refresh-db --text