JoyPro2 Discord GitHub
Engine (CLI)

engine il2korea (IL-2 Series: Korea)

Show:

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

#engine il2korea paths

written
engine il2korea paths
For beginners

Lists where JoyPro finds the key mapping of IL-2 Korea on this PC. The first one is what engine il2korea scan, engine il2korea import and engine il2korea 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 il2korea paths --text
Advanced
  • <install>\data\input\general.actions first, then the other *.actions files of that folder (newest first). <install> is the installation JoyPro found (data\input or game\data\input below it).
  • A warning says when the folder or the file is missing: start the game, open Settings > Key mapping and press ACCEPT once.
  • 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 il2korea paths --text

#engine il2korea catalog

written
engine il2korea catalog
For beginners

Lists the IL-2 Korea 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 il2korea catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\IL2Korea\actions.tsv (when that folder does not exist, the DB\IL2Korea folder next to the engine).
  • It is built from your general.actions by engine il2korea 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 ("IL-2 Series: Korea Action Catalog", "Source:", "Actions: ", then ` | axis|button | |` per action). </li> <li>Without a list: the warning <code>IL-2 Series: Korea action catalog not found: <path></code> and an empty list, exit code <code>0</code>.</li> <li>Related: <a href="../cli/il2korea.html#il2korea-refresh-db"><code>engine il2korea refresh-db</code></a>, <a href="../cli/il2korea.html#il2korea-export"><code>engine il2korea export</code></a>, <a href="../cli/db.html#db-games"><code>engine db games</code></a>; game page <a href="../games/il2-korea.html">il2-korea</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 il2korea catalog --text</code></pre></article><article class="entry cli level-full" id="il2korea-scan"><header><h3 class="eh"><a class="anchor" href="#il2korea-scan">#</a><code>engine il2korea scan</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine il2korea 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 IL-2 Korea 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 il2korea scan --text </code></pre> </section> <section class="layer layer-advanced" data-layer="advanced"><div class="layer-badge">Advanced</div> <ul> <li>It reads <code>general.actions</code> with <code>known.devices.json</code> (device numbers), <code>general.pitch</code> and <code>shared.responses</code> (curves).</li> <li>Path (positional or <code class="opt">--path</code>): the install folder, the <code>data\input</code> folder, the game's exe or an <code>.actions</code> 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 JoyPro reads in this game are listed too; <a href="../cli/il2korea.html#il2korea-import"><code>engine il2korea import</code></a> takes them only with <code class="opt">--include-keyboard</code>.</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> ("IL-2 Series: Korea 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 IL-2 Series: Korea config file found. Pass the path explicitly.</code></li> <li>Unknown options fail with <code>Unknown IL2Korea 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/il2korea.html#il2korea-import"><code>engine il2korea import</code></a>, <a href="../cli/il2korea.html#il2korea-paths"><code>engine il2korea paths</code></a>, <a href="../cli/il2korea.html#il2korea-catalog"><code>engine il2korea catalog</code></a>; game page <a href="../games/il2-korea.html">il2-korea</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 IL-2 Series: Korea'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/il2-korea.html">IL-2 Series: Korea details</a> · <a href="../flows/export.html#in-the-game">what each mode changes</a></p><p class="lbl">Example</p><pre><code>engine il2korea 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="il2korea-import"><header><h3 class="eh"><a class="anchor" href="#il2korea-import">#</a><code>engine il2korea import</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine il2korea 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 key mapping of IL-2 Series: Korea into your JoyPro profile: every action on a stick, throttle, pedals or panel, with modifiers, the invert of each axis and the values of the curve editor. Nothing in the game changes. The GUI runs it with <strong>Import</strong> on the IL-2 Series: Korea card of the Start page.</p> <pre><code class="language-powershell">engine il2korea import --include-keyboard --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><install>\data\input\general.actions</code> with <code>known.devices.json</code> (device numbers), <code>general.pitch</code> and <code>shared.responses</code> (curves). <code><install></code> is <code>steamapps\common\IL2Series</code>, or the <code>game</code> folder below the standalone launcher. The game writes <code>general.actions</code> when you press <strong>ACCEPT</strong> in Key mapping once.</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 Korea has.</li> <li><code class="opt">--include-keyboard</code> also reads the keyboard keys of the actions.</li> <li>Curves and Relative Control come in as the relation's Korea tuning; JoyPro's names, groups, modifiers and tuning come back from <code>general.actions.joypro-meta.json</code>.</li> <li>Safety: reads only, not refused while the game runs; the profile is kept as "Before import from IL-2 Series: Korea" 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 IL-2 Series: Korea config file found. Pass the path explicitly.</code>).</li> <li>The path may be the install folder, the <code>data\input</code> folder or the file itself. Without a path it reads the first location of <a href="../cli/il2korea.html#il2korea-paths"><code>engine il2korea paths</code></a>; a fresh install builds the command list first.</li> <li>With <code class="opt">--profile</code> the profile is saved afterwards. The imported inputs are recorded as JoyPro's in <code><file>.joypro.json</code>, and a game JoyPro never exported to is watched from now on.</li> <li>Related: <a href="../cli/il2korea.html#il2korea-scan"><code>engine il2korea scan</code></a>, <a href="../cli/il2korea.html#il2korea-export"><code>engine il2korea export</code></a>, <a href="../cli/il2.html#il2-import"><code>engine il2 import</code></a>; game page <a href="../games/il2-korea.html">il2-korea</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 IL-2 Series: Korea'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/il2-korea.html">IL-2 Series: Korea 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' il2korea 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="il2korea-export"><header><h3 class="eh"><a class="anchor" href="#il2korea-export">#</a><code>engine il2korea export</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine il2korea 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>Flight only: clean takes over the devices it writes, nuke clears 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 your binds into the key mapping of IL-2 Series: Korea and gives each device you write a device number, as the game's own dialog does. Close the game first. The GUI's <strong>Export now</strong> on the IL-2 Series: Korea card runs it.</p> <pre><code class="language-powershell">engine il2korea 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>It writes <code>data\input\general.actions</code>, <code>known.devices.json</code>, the curves in <code>general.pitch</code> and <code>shared.responses</code>, and the input settings you stored into <code>data\NSData\UserData\UserSettings.json</code>.</p> <div class="table-wrap"><div class="table-wrap"><table> <thead> <tr> <th><code class="opt">--mode</code></th> <th>In the game</th> </tr> </thead> <tbody> <tr> <td><code>add</code></td> <td>nothing is removed; a bind whose input the game uses for another action is listed, not written</td> </tr> <tr> <td><code>merge</code></td> <td>your binds go in; the game's other inputs stay, except a game bind on an input you give another action</td> </tr> <tr> <td><code>merge-overwrite</code> (engine default)</td> <td>as <code>merge</code>, and every action you bind loses its other joystick inputs (keyboard only with <code class="opt">--include-keyboard</code>)</td> </tr> <tr> <td><code>clean</code> (GUI default)</td> <td>every joystick input of the devices you write is released, then your binds go in</td> </tr> </tbody> </table></div></div> <ul> <li><code class="opt">--nuke-untouched-devices</code>: connected devices without a bind in your profile lose their joystick inputs (not with <code>add</code>).</li> <li><code class="opt">--include-keyboard</code> also writes your keyboard binds; without it keyboard keys never change.</li> <li>A device JoyPro writes keeps its number; a connected device without one gets the lowest free number from 1. A device without a number that is not connected is skipped.</li> <li>Never touched: keyboard keys, mouse inputs, key pairs on axes, devices that are not connected, lines the import cannot read, <code class="opt">--ignore-device(s)</code>, the <code class="opt">--vjoy-tunnel</code> device, <code>current.map</code>.</li> <li>Safety: refused while <code>IL2Series</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 IL-2 Series: Korea". <code class="opt">--dry-run</code> writes nothing. A folder Windows does not let JoyPro write is reported instead of writing half the files.</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 (<code>IL-2 Series: Korea is running (IL2Series). Close the game first; it overwrites its config on exit.</code>, an invalid <code class="opt">--mode</code>, no file found).</li> <li>Without a path it writes the first location of <a href="../cli/il2korea.html#il2korea-paths"><code>engine il2korea paths</code></a>.</li> <li>After a real run: <code><file>.joypro.json</code>, <code>general.actions.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/il2korea.html#il2korea-import"><code>engine il2korea import</code></a>, <a href="../cli/binds.html#binds-tuning-set"><code>engine binds tuning set</code></a>, <a href="../cli/ffb.html#ffb-set"><code>engine ffb set</code></a>; game page <a href="../games/il2-korea.html">il2-korea</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 il2korea export --mode clean engine il2korea export --mode add engine il2korea export --mode merge engine il2korea export --mode merge-overwrite</code></pre></details><p><span class="lbl">In the game</span> Writes into IL-2 Series: Korea'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: <code><install>\data\input\general.actions</code> (JSON) + <code>known.devices.json</code>; curves in <code>general.pitch</code> / <code>shared.responses</code>; settings in <code>data\NSData\UserData\UserSettings.json</code>. <a href="../games/ref/il2-korea.html">IL-2 Series: Korea 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' il2korea export --dry-run --text engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' il2korea export --mode merge-overwrite --text</code></pre></article><article class="entry cli level-full" id="il2korea-refresh-db"><header><h3 class="eh"><a class="anchor" href="#il2korea-refresh-db">#</a><code>engine il2korea refresh-db</code></h3><span class="badge full">written</span></header><pre class="sig"><code>engine il2korea 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 IL-2 Korea command list from your key mapping file, 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 il2korea refresh-db --dry-run --text </code></pre> </section> <section class="layer layer-advanced" data-layer="advanced"><div class="layer-badge">Advanced</div> <ul> <li>It reads every action id of <code>general.actions</code> (or of the install folder, <code>data\input</code> folder or file given as the path); an action whose inputs are axes is an axis.</li> <li>Titles: JoyPro's own action texts, else the known title, else IL-2 Great Battles' description of the same id (from JoyPro's IL-2 list or the installed Great Battles' <code>.actions</code> files), else one made from the id.</li> <li>Known actions stay in the list.</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: the read error of the file (for example when the game has not written <code>general.actions</code> yet); the list stays unchanged.</li> <li>Writes <code>%LOCALAPPDATA%\JoyPro2\GameData\DB\IL2Korea\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/il2korea.html#il2korea-catalog"><code>engine il2korea catalog</code></a>, <a href="../cli/il2korea.html#il2korea-scan"><code>engine il2korea scan</code></a>, <a href="../cli/db.html#db-check-updates"><code>engine db check-updates</code></a>; game page <a href="../games/il2-korea.html">il2-korea</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 il2korea 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>