JoyPro2 Discord GitHub
Engine (CLI)

engine vtolvr-native (VTOL VR (native: rudder and brakes))

Show:

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

#engine vtolvr-native paths

written
engine vtolvr-native paths
For beginners

Lists where JoyPro finds the input bindings file of VTOL VR (native rudder and brakes) on this PC. The first one is what engine vtolvr-native scan, engine vtolvr-native import and engine vtolvr-native 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 vtolvr-native paths --text
Advanced
  • %APPDATA%\Boundless Dynamics, LLC\VTOLVR\SaveData\inputbindings.cfg, listed when the file exists.
  • 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 ("VTOL VR (native rudder and brakes) Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine vtolvr-native without an action runs paths.
  • Related: engine vtolvr-native scan, engine games paths, engine games install set; game page vtol-vr.

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 vtolvr-native paths --text

#engine vtolvr-native catalog

written
engine vtolvr-native catalog
For beginners

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

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 vtolvr-native catalog --text

#engine vtolvr-native scan

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

Shows the joystick binds VTOL VR (native rudder and brakes) 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 vtolvr-native scan --text
Advanced
  • It reads the Rewired joystick maps of inputbindings.cfg (rudder, toe brakes and the other actions the game binds itself), with invert and, for the toe brakes, the axis range.
  • Path (positional or --path): another inputbindings.cfg.
  • --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 ("VTOL VR (native rudder and brakes) Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No VTOL VR (native rudder and brakes) config file found. Pass the path explicitly.
  • Unknown options fail with Unknown VTOLVRNative 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 vtolvr-native import, engine vtolvr-native paths, engine vtolvr-native catalog; game page vtol-vr.

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 VTOL VR (native: rudder and brakes)'s files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. VTOL VR (native: rudder and brakes) details · what each mode changes

Example

engine vtolvr-native 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 vtolvr-native import

written
engine vtolvr-native 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 VTOL VR's own binds into your JoyPro profile: Rudder, Wheel Brake L and Wheel Brake R on your pedals, the only actions the game itself binds to a joystick. Nothing in the game changes. The GUI runs it with Import on the card of VTOL VR's native part.

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

It reads the Rewired joystick maps in %APPDATA%\Boundless Dynamics, LLC\VTOLVR\SaveData\inputbindings.cfg.

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the file has.
  • No keyboard or modifier binds in this part; --include-keyboard changes nothing.
  • Invert and, for the toe brakes, the axis range come in.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from VTOL VR (native rudder and brakes)" 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 VTOL VR (native rudder and brakes) config file found. Pass the path explicitly.).
  • Without a path it reads the file engine vtolvr-native paths lists first; a fresh install builds the command list from the game's level0 first.
  • With --profile the profile is saved afterwards; a game JoyPro never exported to is watched from now on.
  • Related: engine vtolvr-native scan, engine vtolvr-native export, engine vtolvr import; game page vtol-vr.

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 VTOL VR (native: rudder and brakes)'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. VTOL VR (native: rudder and brakes) details · what each mode changes

Example

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

written
engine vtolvr-native 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>]

Flight only: clean takes over the devices it writes, nuke clears unused devices; --ignore-device(s) and --vjoy-tunnel devices are never cleared

For beginners

Writes your rudder and toe brake binds into VTOL VR's own inputbindings.cfg, and the control settings you stored into gameSettings.cfg. Close VTOL VR first. The GUI's Export now on the native VTOL VR card runs it.

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

It writes the joystick maps of %APPDATA%\Boundless Dynamics, LLC\VTOLVR\SaveData\inputbindings.cfg atomically (temporary file, then replace).

--mode In inputbindings.cfg
add free axes only; a taken axis is listed, not written
merge the action on your axis is replaced; everything else stays
merge-overwrite (engine default) as merge, and your actions leave their other axes on connected devices
clean (GUI default) the other actions of the written devices are cleared
  • --nuke-untouched-devices: connected devices without binds are cleared (not with add).
  • Only devices the game has listed are written. Invert, and the axis range (Full or Positive) of the toe brakes; no dead zones or curves.
  • Control settings you stored (Hardware Control Rudder, VR dead zones, haptics) go into gameSettings.cfg, also from a profile without native binds; JoyPro never creates that file.
  • Never touched: button, keyboard and mouse maps, input behaviours, calibration maps, controller assignments, devices that are not connected, --ignore-device(s), the --vjoy-tunnel device, the legacy <install>\SaveData\inputbindings.cfg.
  • Safety: refused while VTOLVR runs; backed up first (undo: engine backups list); the profile is kept as "Before export to VTOL VR (native rudder and brakes)". --dry-run writes nothing.
Technical internals

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

In the game Writes into VTOL VR (native: rudder and brakes)'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: %APPDATA%\Boundless Dynamics, LLC\VTOLVR\SaveData\inputbindings.cfg (ConfigNode + Rewired XML) + gameSettings.cfg. VTOL VR (native: rudder and brakes) details · what each mode changes

Example

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

#engine vtolvr-native refresh-db

written
engine vtolvr-native 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 VTOL VR (native rudder and brakes) command list from the installed game's Rewired action list, 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 vtolvr-native refresh-db --dry-run --text
Advanced
  • It reads VTOLVR_Data\level0 of the installation (path: the game folder, its VTOLVR_Data folder or the file): every user-assignable Rewired action that is not in the list comes in, with the game's descriptive name, axis or button and its Rewired id.
  • A known action the game no longer has stays, with a warning.
  • --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: VTOL VR's VTOLVR_Data\level0 was not found. Pass --path with the game folder, its VTOLVR_Data folder or the file. or the read error of the file; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\VTOLVRNative\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 vtolvr-native catalog, engine vtolvr-native scan, engine db check-updates; game page vtol-vr.

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 vtolvr-native refresh-db --text