JoyPro2 Discord GitHub
Engine (CLI)

engine reforger (Arma Reforger)

Show:

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

#engine reforger paths

written
engine reforger paths
For beginners

Lists where JoyPro finds the joystick preset of Arma Reforger on this PC. The first one is what engine reforger scan, engine reforger import and engine reforger 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 reforger paths --text
Advanced
  • %USERPROFILE%\Documents\My Games\ArmaReforger\profile\.save\settings\customInputConfigs\JoyPro.conf, listed as soon as the game's settings folder exists. The file itself is JoyPro's preset: the first export 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
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or text with --text ("Arma Reforger Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine reforger without an action runs paths.
  • Before the first export the listed file does not exist yet; a scan or import then reports Reforger input config not found: <path>.
  • Related: engine reforger scan, engine games paths, engine games install set; game page arma-reforger.

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

#engine reforger catalog

written
engine reforger catalog
For beginners

Lists the Arma Reforger 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 reforger catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\ArmaReforger\actions.tsv (when that folder does not exist, the DB\ArmaReforger folder next to the engine).
  • It is built from the game's archives by engine reforger 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 Reforger Action Catalog", "Source:", "Actions: ", then ` | axis|button | |` per action). </li> <li>Without a list: the warning <code>Arma Reforger action catalog not found: <path></code> and an empty list, exit code <code>0</code>.</li> <li>Related: <a href="../cli/reforger.html#reforger-refresh-db"><code>engine reforger refresh-db</code></a>, <a href="../cli/reforger.html#reforger-export"><code>engine reforger export</code></a>, <a href="../cli/db.html#db-games"><code>engine db games</code></a>; game page <a href="../games/arma-reforger.html">arma-reforger</a>.</li> </ul> </section> </div><p><span class="lbl">What it does</span> 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>.</p><p class="lbl">Example</p><pre><code>engine reforger catalog --text</code></pre></article><article class="entry cli level-full" id="reforger-scan"><header><h3 class="eh"><a class="anchor" href="#reforger-scan">#</a><code>engine reforger scan</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine reforger scan [<config-path>] [--path <config-path>] [--ignore-device <name>] [--ignore-devices <csv>]</code></pre><div class="hand"><section class="layer layer-beginner" data-layer="beginner"><div class="layer-badge">For beginners</div> <p>Shows the joystick binds Arma Reforger has now, without changing your profile or the game. Use it to look before an import. <strong>Look first</strong> on the game's card of the Start page and <strong>Scan</strong> in the <strong>Other Games</strong> panel run it.</p> <pre><code class="language-powershell">engine reforger scan --text </code></pre> </section> <section class="layer layer-advanced" data-layer="advanced"><div class="layer-badge">Advanced</div> <ul> <li>It reads the helicopter flight <code>Action</code> blocks of <code>JoyPro.conf</code> with multiplier and invert, and maps the game's <code>joystick0</code> to <code>joystick3</code> back to your devices through the device order of the game's engine settings.</li> <li>Path (positional or <code class="opt">--path</code>): another preset file.</li> <li><code>--ignore-device <name></code> / <code>--ignore-devices <a;b></code> (separated by <code>|</code> or <code>;</code>, <code class="opt">--ignore-devices</code> also by commas) leave the binds of those devices out (a name without <code>{GUID}</code> means every device of that name); a step line names them and counts the binds.</li> <li>Keyboard binds are not read in this game.</li> <li>Safety: reads only and is not refused while the game runs. It is refused when the game is not installed (set its folder: <a href="../cli/games.html#games-install-set"><code>engine games install set</code></a>) or switched off in Settings > Games.</li> <li>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).</li> </ul> </section> <section class="layer layer-technical" data-layer="technical"><div class="layer-badge">Technical internals</div> <ul> <li>Output: JSON (<code>ConfigPath</code>, <code>BindingsRead</code>, <code>Bindings</code> with <code>ActionId</code>, <code>Device</code>, <code>Input</code>, <code>IsAxis</code>, <code>Reformers</code>, <code>Inverted</code>, then <code>Steps</code>, <code>Warnings</code>, <code>Errors</code>), or text with <code class="opt">--text</code> ("Arma Reforger Scan", "Config:", "Bindings Read:" and the list).</li> <li>Exit code <code>0</code>; <code>1</code> when the result has errors, for example <code>No Arma Reforger config file found. Pass the path explicitly.</code>, or <code>Reforger input config not found: <path></code> before the first export.</li> <li>Unknown options fail with <code>Unknown ArmaReforger scan argument(s): ...</code>; MSFS options (<code class="opt">--game-profile</code>, <code class="opt">--include-disconnected</code>, <code class="opt">--include-sim-defaults</code>) are refused.</li> <li>Binds of the vJoy device JoyPro forwards into (<code class="opt">--vjoy-tunnel</code>) are left out.</li> <li>Related: <a href="../cli/reforger.html#reforger-import"><code>engine reforger import</code></a>, <a href="../cli/reforger.html#reforger-paths"><code>engine reforger paths</code></a>, <a href="../cli/reforger.html#reforger-catalog"><code>engine reforger catalog</code></a>; game page <a href="../games/arma-reforger.html">arma-reforger</a>.</li> </ul> </section> </div><p><span class="lbl">What it does</span> 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.</p><div class="table-wrap"><table class="opts"><thead><tr><th>Option</th><th>Values</th><th>Meaning</th></tr></thead><tbody><tr><td><code>--path</code></td><td><code><config-path></code></td><td>Optional explicit path override. Use when you prefer option form over positional path.</td></tr><tr><td><code>--ignore-device</code></td><td><code><name></code></td><td>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'.</td></tr><tr><td><code>--ignore-devices</code></td><td><code><csv></code></td><td>Leave the binds of these devices out (separated by commas, | or ;). Example: --ignore-devices 'vJoy Device,Old Pedals'.</td></tr></tbody></table></div><p><span class="lbl">In the game</span> Reads Arma Reforger's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. <a href="../games/ref/arma-reforger.html">Arma Reforger details</a> · <a href="../flows/export.html#in-the-game">what each mode changes</a></p><p class="lbl">Example</p><pre><code>engine reforger scan --text</code></pre><details><summary>How the options interact</summary><ul> <li>--ignore-device / --ignore-devices leave the binds of those devices out of the scan or import (the result names how many).</li> </ul> </details></article><article class="entry cli level-full" id="reforger-import"><header><h3 class="eh"><a class="anchor" href="#reforger-import">#</a><code>engine reforger import</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine reforger import [<config-path>] [--path <config-path>] [--replace] [--include-keyboard] [--ignore-device <name>] [--ignore-devices <csv>]</code></pre><p>--ignore-device(s): the binds of these devices are left out</p><div class="hand"><section class="layer layer-beginner" data-layer="beginner"><div class="layer-badge">For beginners</div> <p>Reads the helicopter binds of JoyPro's joystick preset for Arma Reforger into your JoyPro profile, with multiplier and invert. Nothing in the game changes. The GUI runs it with <strong>Import</strong> on the Arma Reforger card of the Start page.</p> <pre><code class="language-powershell">engine reforger import --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text </code></pre> </section> <section class="layer layer-advanced" data-layer="advanced"><div class="layer-badge">Advanced</div> <p>It reads <code>%USERPROFILE%\Documents\My Games\ArmaReforger\profile\.save\settings\customInputConfigs\JoyPro.conf</code> and maps the game's <code>joystick0</code> to <code>joystick3</code> back to your devices through the device order rules of the game's engine settings.</p> <ul> <li>Default: adds to the open profile (<code class="opt">--merge</code> means the same); <code class="opt">--replace</code> replaces every relation of the profile by what the preset has.</li> <li>Keyboard binds and modifiers are not read; <code class="opt">--include-keyboard</code> changes nothing.</li> <li>Safety: reads only, not refused while the game runs; the profile is kept as "Before import from Arma Reforger" first.</li> <li><code>--ignore-device <name></code> / <code>--ignore-devices <a;b></code> leave the binds of those devices out (a name without <code>{GUID}</code> means every device of that name); a step line says how many binds were left out.</li> </ul> </section> <section class="layer layer-technical" data-layer="technical"><div class="layer-badge">Technical internals</div> <ul> <li>Output: JSON of the import result or a text report with <code class="opt">--text</code>; exit code <code>1</code> on an error (<code>No Arma Reforger config file found. Pass the path explicitly.</code>).</li> <li>Without a path it reads the file <a href="../cli/reforger.html#reforger-paths"><code>engine reforger paths</code></a> lists first; a fresh install builds the command list from the game's archives first.</li> <li>With <code class="opt">--profile</code> the profile is saved afterwards; a game JoyPro never exported to is watched from now on.</li> <li>Related: <a href="../cli/reforger.html#reforger-scan"><code>engine reforger scan</code></a>, <a href="../cli/reforger.html#reforger-export"><code>engine reforger export</code></a>; game page <a href="../games/arma-reforger.html">arma-reforger</a>.</li> </ul> </section> </div><p><span class="lbl">What it does</span> 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.</p><div class="table-wrap"><table class="opts"><thead><tr><th>Option</th><th>Values</th><th>Meaning</th></tr></thead><tbody><tr><td><code>--path</code></td><td><code><config-path></code></td><td>Optional explicit path override. Use when you prefer option form over positional path.</td></tr><tr><td><code>--replace</code></td><td><span class="muted">switch (no value)</span></td><td>For game import: start from an empty relation list instead of merging into the loaded profile.</td></tr><tr><td><code>--include-keyboard</code></td><td><span class="muted">switch (no value)</span></td><td></td></tr><tr><td><code>--ignore-device</code></td><td><code><name></code></td><td>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'.</td></tr><tr><td><code>--ignore-devices</code></td><td><code><csv></code></td><td>Leave the binds of these devices out (separated by commas, | or ;). Example: --ignore-devices 'vJoy Device,Old Pedals'.</td></tr></tbody></table></div><p><span class="lbl">In the game</span> Reads Arma Reforger'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. <a href="../games/ref/arma-reforger.html">Arma Reforger details</a> · <a href="../flows/export.html#in-the-game">what each mode changes</a></p><p class="lbl">Example</p><pre><code>engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' reforger import --text</code></pre><details><summary>How the options interact</summary><ul> <li>--ignore-device / --ignore-devices leave the binds of those devices out of the scan or import (the result names how many).</li> </ul> </details></article><article class="entry cli level-full" id="reforger-export"><header><h3 class="eh"><a class="anchor" href="#reforger-export">#</a><code>engine reforger export</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine reforger 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>]</code></pre><p>Only aircraft/helicopter actions: clean and nuke release those on the written / unused devices; --ignore-device(s) and --vjoy-tunnel devices are never cleared</p><div class="hand"><section class="layer layer-beginner" data-layer="beginner"><div class="layer-badge">For beginners</div> <p>Writes JoyPro's joystick preset <code>JoyPro.conf</code> for Arma Reforger with your helicopter flight binds, and sorts your devices into the game's four joystick slots. Close the game first; then pick <strong>JoyPro</strong> once under Settings > Controllers > Joystick preset and restart the game. The GUI's <strong>Export now</strong> on the Arma Reforger card runs it.</p> <pre><code class="language-powershell">engine reforger export --mode clean --nuke-untouched-devices --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text </code></pre> </section> <section class="layer layer-advanced" data-layer="advanced"><div class="layer-badge">Advanced</div> <p>Only the flight <code>Action</code> blocks of the preset change; a block left without sources is removed.</p> <div class="table-wrap"><div class="table-wrap"><table> <thead> <tr> <th><code class="opt">--mode</code></th> <th>In <code>JoyPro.conf</code></th> </tr> </thead> <tbody> <tr> <td><code>add</code></td> <td>every source stays; a bind whose joystick input another flight action uses gets a mark "Not written to the game"</td> </tr> <tr> <td><code>merge</code></td> <td>your sources go in; another flight action's source on the same input is removed</td> </tr> <tr> <td><code>merge-overwrite</code> (engine default)</td> <td>as <code>merge</code>, and an action you bind loses its other joystick sources of connected devices</td> </tr> <tr> <td><code>clean</code> (GUI default)</td> <td>the flight sources of the devices you write are replaced by yours</td> </tr> </tbody> </table></div></div> <ul> <li><code class="opt">--nuke-untouched-devices</code>: the same for connected devices without binds in your profile (not with <code>add</code>).</li> <li>Device order: JoyPro edits the <code>JoystickOrderRule</code> entries of <code>ReforgerEngineSettings.conf</code> (slots 0 to 3, a slot you chose with <code>joystickSlot</code> first) in every settings folder it finds; without a saved settings file it warns. More than four devices get a warning.</li> <li>Per bind a multiplier and invert; no dead zones or curves. Game settings you stored (HOTAS collective mode, force feedback intensity) go into <code>ReforgerGameSettings.conf</code>, also from a profile without Reforger binds.</li> <li>Never touched: <code>InputUserSettings.conf</code>, your other presets, infantry, vehicle and menu actions, keyboard, mouse and pad sources, joysticks that are not connected, <code class="opt">--ignore-device(s)</code>, the <code class="opt">--vjoy-tunnel</code> device, other lines of the settings files.</li> <li>Safety: refused while <code>ArmaReforgerSteam</code>, <code>ArmaReforger_BE</code> or <code>ArmaReforger</code> runs; backed up first (undo: <a href="../cli/backups.html#backups-list"><code>engine backups list</code></a>); the profile is kept as "Before export to Arma Reforger". <code class="opt">--dry-run</code> writes nothing.</li> </ul> </section> <section class="layer layer-technical" data-layer="technical"><div class="layer-badge">Technical internals</div> <ul> <li>Output: JSON of the export result or a text report with <code class="opt">--text</code>; exit code <code>1</code> on an error (the game runs, an invalid <code class="opt">--mode</code>, no file found).</li> <li>Without a path it writes the file <a href="../cli/reforger.html#reforger-paths"><code>engine reforger paths</code></a> lists first.</li> <li>After a real run: <code>JoyPro.conf.joypro-meta.json</code>, the watcher's fingerprint, the export marks (<a href="../cli/export-marks.html#export-marks-list"><code>engine export-marks list</code></a>).</li> <li>Related: <a href="../cli/reforger.html#reforger-import"><code>engine reforger import</code></a>, <a href="../cli/ffb.html#ffb-set"><code>engine ffb set</code></a> (<code>joystickSlot</code>, game settings); game page <a href="../games/arma-reforger.html">arma-reforger</a>.</li> </ul> </section> </div><p><span class="lbl">What it does</span> 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.</p><div class="table-wrap"><table class="opts"><thead><tr><th>Option</th><th>Values</th><th>Meaning</th></tr></thead><tbody><tr><td><code>--path</code></td><td><code><config-path></code></td><td>Optional explicit path override. Use when you prefer option form over positional path.</td></tr><tr><td><code>--mode</code></td><td><code>clean</code> <code>add</code> <code>merge</code> <code>merge-overwrite</code></td><td>Export mode for DCS/IL2 export commands: clean, add, merge, merge-overwrite.</td></tr><tr><td><code>--dry-run</code></td><td><span class="muted">switch (no value)</span></td><td>Report what the export would write; the game's files are not changed.</td></tr><tr><td><code>--include-keyboard</code></td><td><span class="muted">switch (no value)</span></td><td></td></tr><tr><td><code>--nuke-untouched-devices</code></td><td><span class="muted">switch (no value)</span></td><td>DCS export only: delete untouched device .diff.lua/.jp files under Config\\Input (true/false).</td></tr><tr><td><code>--ignore-device</code></td><td><code><name></code></td><td>Exclude one device per flag. Example: --ignore-device Keyboard.</td></tr><tr><td><code>--ignore-devices</code></td><td><code><csv></code></td><td>Exclude devices, separated by commas, | or ;. Example: --ignore-devices Keyboard,Mouse.</td></tr></tbody></table></div><details><summary>Every value as a command line</summary><pre><code>engine reforger export --mode clean engine reforger export --mode add engine reforger export --mode merge engine reforger export --mode merge-overwrite</code></pre></details><p><span class="lbl">In the game</span> Writes into Arma Reforger'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: JoyPro's own preset <code>...\customInputConfigs\JoyPro.conf</code> (Enfusion text) + device order in <code>ReforgerEngineSettings.conf</code>. <a href="../games/ref/arma-reforger.html">Arma Reforger details</a> · <a href="../flows/export.html#in-the-game">what each mode changes</a></p><p class="lbl">Example</p><pre><code>engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' reforger export --dry-run --text engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' reforger export --mode merge-overwrite --text</code></pre></article><article class="entry cli level-full" id="reforger-refresh-db"><header><h3 class="eh"><a class="anchor" href="#reforger-refresh-db">#</a><code>engine reforger refresh-db</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine reforger refresh-db [<source-path>] [--path <source-path>] [--dry-run]</code></pre><p>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</p><div class="hand"><section class="layer layer-beginner" data-layer="beginner"><div class="layer-badge">For beginners</div> <p>Builds JoyPro's Arma Reforger command list from the installed game's archives, or adds the actions that are new. Run it after a game update, or when JoyPro says the list is missing. <strong>Refresh DB</strong> in the <strong>Other Games</strong> panel (its <strong>DB Source</strong> box is the path) and the Start page's notice "Command lists to build or update" run it.</p> <pre><code class="language-powershell">engine reforger refresh-db --dry-run --text </code></pre> </section> <section class="layer layer-advanced" data-layer="advanced"><div class="layer-badge">Advanced</div> <ul> <li>Without a path it reads the game folder's <code>.pak</code> archives under <code>addons</code>: <code>Configs/System/chimeraInputCommon.conf</code> (the flight contexts of its action manager), the key binding menu and <code>Language/localization.en_us.conf</code> for the titles.</li> <li>Path: the game folder, one <code>.pak</code> file, a folder with the extracted files, or <code>chimeraInputCommon.conf</code> itself.</li> <li>Then your own input configs (the <code>*.conf</code> presets of <code>customInputConfigs</code> and <code>InputUserSettings.conf</code>) are read for flight actions mods add.</li> <li>Known actions keep their entry.</li> <li><code class="opt">--dry-run</code> reads everything and writes nothing (step "Dry run: nothing was written."). Without it the list is written only when it changed.</li> <li>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.</li> </ul> </section> <section class="layer layer-technical" data-layer="technical"><div class="layer-badge">Technical internals</div> <ul> <li>Output: JSON of the refresh (<code>DryRun</code>, <code>FilesWritten</code>, <code>Steps</code> with <code>Actions: <old> -> <new></code>, <code>Warnings</code>, <code>Errors</code>), or text with <code class="opt">--text</code>.</li> <li>Exit code <code>0</code>; <code>1</code> when nothing could be read: <code>Arma Reforger was not found. Set its folder (engine games install set reforger <folder>) or pass the game folder, a .pak file or the extracted Configs\System\chimeraInputCommon.conf.</code>; the list stays unchanged.</li> <li>Writes <code>%LOCALAPPDATA%\JoyPro2\GameData\DB\ArmaReforger\actions.tsv</code> (with a header line that has the date). After a real run the game's build is recorded for <a href="../cli/db.html#db-check-updates"><code>engine db check-updates</code></a>.</li> <li>Related: <a href="../cli/reforger.html#reforger-catalog"><code>engine reforger catalog</code></a>, <a href="../cli/reforger.html#reforger-scan"><code>engine reforger scan</code></a>, <a href="../cli/db.html#db-check-updates"><code>engine db check-updates</code></a>; game page <a href="../games/arma-reforger.html">arma-reforger</a>.</li> </ul> </section> </div><p><span class="lbl">What it does</span> 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.</p><div class="table-wrap"><table class="opts"><thead><tr><th>Option</th><th>Values</th><th>Meaning</th></tr></thead><tbody><tr><td><code>--path</code></td><td><code><source-path></code></td><td>Same as <source-path>: the game's installation or a file of the game to read the actions from.</td></tr><tr><td><code>--dry-run</code></td><td><span class="muted">switch (no value)</span></td><td>Report what the command would do; nothing is written or changed.</td></tr></tbody></table></div><p class="lbl">Example</p><pre><code>engine reforger refresh-db --text</code></pre></article> </div> <footer class="foot">JoyPro is free software: <a href="https://github.com/Holdi601/JoystickProfiler2/blob/main/LICENSE">GPL-3.0</a> · <a href="https://discord.gg/yK4gQA9xgk">Discord</a> · <a href="https://github.com/Holdi601/JoystickProfiler2">Source</a> · <a href="../project/wiki-status.html">Wiki status</a></footer> </main> </div> <script src="../assets/i18n.js"></script> <script src="../assets/site.js"></script> </body> </html>