JoyPro2 Discord GitHub
Engine (CLI)

engine arma2 (Arma 2)

Show:

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

#engine arma2 paths

written
engine arma2 paths
For beginners

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

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

#engine arma2 catalog

written
engine arma2 catalog
For beginners

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

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

#engine arma2 scan

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

Shows the joystick binds Arma 2 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 arma2 scan --text
Advanced
  • It reads the key lines of the cataloged actions and the devices of class JoysticksList (32 buttons per device; a device in another mode than Custom counts as off), with each axis's sensitivity slider.
  • 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 2 Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No Arma 2 config file found. Pass the path explicitly.
  • Unknown options fail with Unknown Arma2 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 arma2 import, engine arma2 paths, engine arma2 catalog; game page arma2.

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

Example

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

written
engine arma2 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 2 profile (the standalone game, arma2.exe) into your JoyPro profile, with the sensitivity slider of each axis. Nothing in the game changes. The GUI runs it with Import on the Arma 2 card of the Start page.

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

It reads %USERPROFILE%\Documents\ArmA 2\<name>.ArmA2Profile (or one in Documents\ArmA 2 Other Profiles\<name>\). Operation Arrowhead is the separate game arma2oa.

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the file has.
  • Keyboard binds are not read; --include-keyboard changes nothing.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from Arma 2" 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 2 config file found. Pass the path explicitly.).
  • Without a path it reads the profile engine arma2 paths lists first; a fresh install builds the command list from Dta\bin.pbo first.
  • With --profile the profile is saved afterwards; a game JoyPro never exported to is watched from now on.
  • Related: engine arma2 scan, engine arma2 export, engine arma2oa import; game page arma2.

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 2'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 2 details · what each mode changes

Example

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

written
engine arma2 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 2 profile; only the key lines of the flight actions change. Close the game first, and start it once with every device connected. The GUI's Export now on the Arma 2 card runs it.

engine arma2 export --mode clean --nuke-untouched-devices --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
--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, the game's automatic defaults included
  • --nuke-untouched-devices: the same for other connected joysticks (not with add).
  • Arma 2 alone cannot join both halves of a lever: the throttle and airbrake get one half. 32 buttons, 8 axes and the first hat per device.
  • Never touched: infantry, vehicle and menu lines, keyboard, mouse, TrackIR and pad codes, joysticks that are not connected, --ignore-device(s), the --vjoy-tunnel device, new device entries, ArmA2.cfg.
  • Safety: refused while arma2 runs; backed up first (undo: engine backups list); the profile is kept as "Before export to Arma 2". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error (the game runs, an invalid --mode, no profile found).
  • Without a path it writes the profile engine arma2 paths lists first.
  • After a real run: <profile>.joypro-meta.json, the watcher's fingerprint, the export marks.
  • Related: engine arma2 import, engine arma2oa export; game page arma2.

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

In the game Writes into Arma 2'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 2\<name>.ArmA2Profile (ParamFile text). Arma 2 details · what each mode changes

Example

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

#engine arma2 refresh-db

written
engine arma2 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 2 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 arma2 refresh-db --dry-run --text
Advanced
  • Without a path it reads Dta\bin.pbo of the game folder (the action list of CfgDefaultKeysMapping) with the names of Dta\languagecore.pbo, and the first profile of engine arma2 paths.
  • Path: a folder is read as the game folder, a file as a profile.
  • Kept: the flight actions (Heli, Flaps, LandGear, AutoHover, LaunchCM, NextCM), the actions JoyPro's function list uses, and the weapon, view and push-to-talk actions a HOTAS often carries. JoyPro's axis relations (Axis.*, with the split lever Axis.ThrottleBrake) come from JoyPro itself.
  • 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 2: 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\Arma2\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 arma2 catalog, engine arma2 scan, engine db check-updates; game page arma2.

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