JoyPro2 Discord GitHub
Engine (CLI)

engine nuclearoption (Nuclear Option)

Show:

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

#engine nuclearoption paths

written
engine nuclearoption paths
For beginners

Shows where JoyPro finds Nuclear Option's binds on this PC: the game's registry key HKCU\Software\Shockfront\NuclearOption, which exists once you started the game. Scan, import and export use it when you give no path; Detect next to File / Folder in the import wizard's Expert import section runs it.

engine nuclearoption paths --text
Advanced
  • No options. Listed: your own config location of engine games config set first, then the registry key when it exists. An empty list means the game has not saved any settings yet: start it once.
  • Read-only; also works when the game is not installed or switched off in Settings > Games.
Technical internals
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or with --text the lines Nuclear Option Config Paths, Paths: <n> and one line per location. Exit code 0, also when nothing is found; an unknown option fails with Unknown NuclearOption paths argument(s): ....
  • Related: engine nuclearoption scan, engine games paths; game page nuclear-option.

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

#engine nuclearoption catalog

written
engine nuclearoption catalog
For beginners

Lists the Nuclear Option actions JoyPro knows, with axis or button and category: the actions the relation editor offers for the game and the ones import and export match.

engine nuclearoption catalog --text
Advanced
  • No options; read-only, also when the game is not installed.
  • The list comes from the game's own action list (engine nuclearoption refresh-db); every category is in it (Flight Controls, Camera Controls, Gameplay, Chat ...), although export only releases Flight Controls actions. Each axis action also has the two button rows <action>.Positive and <action>.Negative.
  • A fresh install has no list yet; the first scan, import, export or refresh builds it. Until then the command lists no action and warns Nuclear Option action catalog not found: <path>.
Technical internals
  • Output: JSON (Game, Source, Actions with Id, Title, IsAxis, Category, Warnings), or with --text one line per action: <id> | axis|button | <category> | <title>. Exit code 0.
  • File: %LOCALAPPDATA%\JoyPro2\GameData\DB\NuclearOption\actions.tsv (fifth column: the game's numeric action id, which the binds in the registry use).
  • Related: engine nuclearoption refresh-db, engine relations search; game page nuclear-option.

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

#engine nuclearoption scan

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

Shows the joystick binds Nuclear Option has for your connected devices, without changing your profile or the game. Use it to look before an import; Look first in the import wizard runs it.

engine nuclearoption scan --text
Advanced
  • Reads what engine nuclearoption import reads: Player0's ControllerMap values under HKCU\Software\Shockfront\NuclearOption. A path (positional or --path) may name that key; without one the key of engine nuclearoption paths is used.
  • --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 counts them.
  • Not read, with a warning each: hats, half-axis binds, maps of two devices of one model, devices that are not connected. No keyboard binds.
  • Safety: reads the game only, also while it runs. On a fresh install it first builds JoyPro's command list from the game and saves it (the only file a scan writes). Refused when the game is not installed or switched off in Settings > Games.
Technical internals
  • Output: JSON (Game, Action scan, ConfigPath, BindingsRead, Bindings with ActionId, Device, Input, IsAxis, Reformers, Inverted, then Steps, Warnings, Errors), or with --text a report with one line <action> <- <device> <input> per bind.
  • Exit code 0; 1 on an error: No Nuclear Option config file found. Pass the path explicitly., Nuclear Option has no settings yet (HKCU\Software\Shockfront\NuclearOption is missing): start the game once., or The Nuclear Option catalog has no Rewired action ids. Run 'engine nuclearoption refresh-db' .... Unknown options fail with Unknown NuclearOption scan argument(s): ....
  • Related: engine nuclearoption import, engine nuclearoption catalog; game page nuclear-option.

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

Example

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

written
engine nuclearoption 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 joystick maps of your connected devices from Nuclear Option into your JoyPro profile: axes with their invert, buttons, and buttons on an axis. Nothing in the game changes. Start the game once before, so its settings exist. The GUI runs it with Import on the Nuclear Option card of the Start page.

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

It reads the game's settings in the registry, HKCU\Software\Shockfront\NuclearOption: one ControllerMap value per device for the player Player0 (Rewired XML).

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the game has.
  • Keyboard binds and modifiers are not read; --include-keyboard changes nothing. Hats are not read yet.
  • Two or more devices of one model cannot be told apart and are left out (warning). A device without a saved map uses the game's default map, which JoyPro cannot read.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from Nuclear Option" 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 Nuclear Option config file found. Pass the path explicitly.).
  • The path may be the registry key itself. Without one it reads the key engine nuclearoption paths lists; a fresh install builds the command list from NuclearOption_Data\resources.assets first.
  • JoyPro's names, groups and tuning come back from %LOCALAPPDATA%\JoyPro2\GameMetadata\HKCU_Software_Shockfront_NuclearOption.joypro-meta.json.
  • Related: engine nuclearoption scan, engine nuclearoption export; game page nuclear-option.

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

Example

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

written
engine nuclearoption 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 Flight Controls binds into the joystick map of each device in Nuclear Option's settings; a device without a saved map gets a new one. Close the game first. The GUI's Export now on the Nuclear Option card runs it.

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

It edits Player0's ControllerMap values under HKCU\Software\Shockfront\NuclearOption, only the element maps it changes; a new map gets its list of known action ids, so the game adds no default binds to it.

--mode In the maps of your devices
add nothing of the game changes; a bind whose button or axis drives another action (or the other pole of an axis) is listed
merge a Flight Controls action on an input you give another action loses it; the action keeps its other inputs
merge-overwrite (engine default) as merge, and every action (or pole) you bind leaves its other inputs on every connected device JoyPro can read
clean (GUI default) every other Flight Controls action of the written devices is released
  • --nuke-untouched-devices: the Flight Controls actions of the other saved maps of connected devices are released; devices without a saved map keep the game's default map (not with add).
  • No curves, keyboard binds, modifiers or hats are written; sliders are written with a warning.
  • Never touched: actions outside Flight Controls (camera, gameplay, chat, debug, mission editor), keyboard and mouse maps, calibration maps, every game setting (ThrottleUseNegative too), devices that are not connected, two devices of one model, --ignore-device(s), the --vjoy-tunnel device.
  • Safety: refused while NuclearOption runs; Player0's controller-map values go into the backup store first (undo writes them back and removes values JoyPro added: engine backups list); the profile is kept as "Before export to Nuclear Option". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error (Nuclear Option is running (NuclearOption). Close the game first; it overwrites its config on exit., an invalid --mode, no key found).
  • Without a path it writes the key engine nuclearoption paths lists. A throttle axis bind with the game's negative throttle region off gets a warning.
  • After a real run: the .joypro-meta.json in %LOCALAPPDATA%\JoyPro2\GameMetadata, the watcher's fingerprint, the export marks (engine export-marks list).
  • The help note says "only aircraft/helicopter actions"; here that is the Flight Controls category.
  • Related: engine nuclearoption import, engine tinycombatarena export; game page nuclear-option.

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

In the game Writes into Nuclear Option'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: registry HKCU\Software\Shockfront\NuclearOption (Rewired XML in REG_BINARY values). Nuclear Option details · what each mode changes

Example

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

#engine nuclearoption refresh-db

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

Rebuilds the catalog from the installed game or <source-path>: actions the game no longer has are dropped; writes it only when it changes

For beginners

Builds JoyPro's Nuclear Option command list from the installed game: every action of the game's input list with name, axis or button and category. Run it after a game update; Update on the Nuclear Option card of the Start page runs it.

engine nuclearoption refresh-db --dry-run --text
Advanced
  • Reads the game's action list from NuclearOption_Data\resources.assets of the detected installation. A path (positional or --path) may be the game folder, its data folder or the .assets file; Refresh DB in the import wizard's Expert import section passes its DB Source box this way.
  • The list is rebuilt from the game: new actions come in, and an action the game no longer has drops out with a warning ('<id>' is no longer in the game's action list.).
  • --dry-run reads and reports, writes nothing. Otherwise the list is written only when it changed.
  • Refused when Nuclear Option is not installed or switched off in Settings > Games; the game may run.
Technical internals
  • Output: JSON of the refresh (Action refresh-db, DryRun, FilesWritten, Steps such as Read <n> Rewired action(s) from <file>. and Actions: <old> -> <new>, Warnings, Errors), or a text report with --text.
  • Exit code 0; 1 when nothing could be read (Nuclear Option's Rewired InputManager was not found. Pass --path with the game folder, its data folder or the .assets file.); the list then stays as it was.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\NuclearOption\actions.tsv and records the game's Steam build in source-version.txt next to it for engine db check-updates.
  • Related: engine nuclearoption catalog, engine tinycombatarena refresh-db; game page nuclear-option.

What it does Rebuilds the catalog from the installed game or <source-path>: actions the game no longer has are dropped; 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 nuclearoption refresh-db --text