JoyPro2 Discord GitHub
Engine (CLI)

engine arma3 (Arma 3)

Show:

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

#engine arma3 paths

written
engine arma3 paths
For beginners

Lists where JoyPro finds the profiles of Arma 3 on this PC. The first one is what engine arma3 scan, engine arma3 import and engine arma3 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 arma3 paths --text
Advanced
  • Every *.Arma3Profile in %USERPROFILE%\Documents\Arma 3\ and below Documents\Arma 3 - Other Profiles\, newest first; the game's .vars and .3den files are skipped.
  • 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
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or text with --text ("Arma 3 Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine arma3 without an action runs paths.
  • Related: engine arma3 scan, engine games paths, engine games install set; game page arma3.

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 arma3 paths --text

#engine arma3 catalog

written
engine arma3 catalog
For beginners

Lists the Arma 3 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 arma3 catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\Arma3\actions.tsv (when that folder does not exist, the DB\Arma3 folder next to the engine).
  • It is built from the game's config and your profile by engine arma3 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 ("Arma 3 Action Catalog", "Source:", "Actions: ", then <id> | axis|button | <category> | <title> per action).
  • Without a list: the warning Arma 3 action catalog not found: <path> and an empty list, exit code 0.
  • Related: engine arma3 refresh-db, engine arma3 export, engine db games; game page arma3.

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 arma3 catalog --text

#engine arma3 scan

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

Shows the joystick binds Arma 3 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 arma3 scan --text
Advanced
  • It reads the key<Action>[] lines of the cataloged flight actions and the device arrays of class JoysticksList, with the sensitivity, dead zone and steepness of each axis. A binary (rapified) profile is not read.
  • Path (positional or --path): another profile file.
  • --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.
  • A fresh install has no command list yet: the first scan builds it from the installed game and saves it (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 ("Arma 3 Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No Arma 3 config file found. Pass the path explicitly.
  • Unknown options fail with Unknown Arma3 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 arma3 import, engine arma3 paths, engine arma3 catalog; game page arma3.

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 Arma 3's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. Arma 3 details · what each mode changes

Example

engine arma3 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 arma3 import

written
engine arma3 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 aircraft and helicopter binds of your Arma 3 profile into your JoyPro profile, with the sensitivity, dead zone and steepness of each axis. Nothing in the game changes. The GUI runs it with Import on the Arma 3 card of the Start page.

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

It reads %USERPROFILE%\Documents\Arma 3\<name>.Arma3Profile (or another profile in Documents\Arma 3 - Other Profiles\<name>\ given as the path): the key<Action>[] lines of the cataloged flight actions and the device arrays of class JoysticksList.

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the profile file has.
  • Keyboard binds are not read in Arma 3: --include-keyboard changes nothing.
  • The response values per device axis come in as the relation's Arma 3 tuning; JoyPro's own data comes back from <profile>.joypro-meta.json.
  • A binary (rapified) profile is not read.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from Arma 3" 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 Arma 3 config file found. Pass the path explicitly.).
  • Without a path it reads the profile engine arma3 paths lists first; a fresh install builds the command list from the game's config first.
  • With --profile the profile is saved afterwards; a game JoyPro never exported to is watched from now on.
  • Related: engine arma3 scan, engine arma3 export, engine arma2oa import; game page arma3.

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 Arma 3'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. Arma 3 details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' arma3 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 arma3 export

written
engine arma3 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 aircraft and helicopter binds into your Arma 3 profile; only the key lines of the flight actions change, your keyboard and mouse binds stay. Close Arma 3 first, and start it once with every device connected. The GUI's Export now on the Arma 3 card runs it.

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

Only the lines of cataloged aircraft and helicopter actions change; helicopters and planes are different vehicles.

--mode In the profile
add nothing is removed; a bind whose code another action of the same vehicle has gets a mark "Not written to the game"
merge your codes go in; a code of another action of the same vehicle that you put elsewhere is dropped
merge-overwrite (engine default) as merge, and an action you bind loses its other joystick codes of connected joysticks
clean (GUI default) the flight lines also lose every other code of the written devices
  • --nuke-untouched-devices: the same for the codes of other connected joysticks (not with add). Arma 3 is not a flight-only game, so infantry, vehicle and view lines are never touched by either.
  • A device the game's list does not have is skipped ("start the game once with it connected"); a disabled device that gets binds is switched on (the export says so). Invert is written as the opposite half of the axis; the analog thrust and speedbrake get both halves.
  • Response values are written only where you set them for Arma 3 or they came from the import. Game settings you stored are written, also by a profile without Arma 3 binds (then no key line changes).
  • Never touched: keyboard, mouse, TrackIR and Xbox pad codes, joysticks that are not connected, --ignore-device(s), the --vjoy-tunnel device, new device list entries, .vars.Arma3Profile. Keyboard binds and modifiers are not written.
  • Safety: refused while arma3_x64, arma3 or arma3battleye runs; backed up first (.jpbak and the backup store, undo: engine backups list); the profile is kept as "Before export to Arma 3". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error (Arma 3 is running (...). Close the game first; it overwrites its config on exit., an invalid --mode, no profile found, a binary profile).
  • Without a path it writes the profile engine arma3 paths lists first.
  • After a real run: <profile>.joypro-meta.json, the watcher's fingerprint, the export marks (engine export-marks list).
  • Related: engine arma3 import, engine ffb set (device on/off, game settings); game page arma3.

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 arma3 export --mode clean
engine arma3 export --mode add
engine arma3 export --mode merge
engine arma3 export --mode merge-overwrite

In the game Writes into Arma 3's control files while the game is closed (refused while it runs), after a backup. Infantry sims with aircraft and helicopters: JoyPro writes only the cataloged aircraft and helicopter actions. Bind file: Documents\Arma 3\<name>.Arma3Profile (ParamFile text, numeric input codes). Arma 3 details · what each mode changes

Example

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

#engine arma3 refresh-db

written
engine arma3 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 Arma 3 command list from the installed game's config and your profile, 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 arma3 refresh-db --dry-run --text
Advanced
  • Without a path it reads the game folder's Dta\bin.pbo (the action list of CfgDefaultKeysPresets/Default/Mappings) with the names of Dta\languagecore_f.pbo, and the first profile of engine arma3 paths.
  • Path: a folder is read as the game folder, a file as a profile (its key lines only).
  • Kept: the flight actions (names starting with Heli, Air, Plane, vtol, Flaps, LandGear, AutoHover), the other actions JoyPro's function list uses, Eject, EngineToggle, LaunchCM and NextCM. JoyPro's axis relations (Axis.*) come from JoyPro itself. Actions found only in the profile get the category "Flight (from profile)".
  • 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: Arma 3: neither the game's config nor a profile was found. Set the game folder (Settings > Games) or pass --path.; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\Arma3\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 arma3 catalog, engine arma3 scan, engine db check-updates; game page arma3.

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 arma3 refresh-db --text