JoyPro2 Discord GitHub
Engine (CLI)

engine vtolvr (VTOL VR (BYOJoystick mod))

Show:

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

#engine vtolvr paths

written
engine vtolvr paths
For beginners

Lists where JoyPro finds the seat files folder of VTOL VR (BYOJoystick mod) on this PC. The first one is what engine vtolvr scan, engine vtolvr import and engine vtolvr 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 paths --text
Advanced
  • <Steam library>\steamapps\common\VTOL VR\SaveData of every Steam library that has VTOL VR. With a folder set by engine games install set only that folder's SaveData.
  • 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 (BYOJoystick mod) Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine vtolvr without an action runs paths.
  • The entry is a folder: the mod keeps one BYOJ_<seat>.xml per vehicle seat there.
  • Related: engine vtolvr 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 paths --text

#engine vtolvr catalog

written
engine vtolvr catalog
For beginners

Lists the VTOL VR (BYOJoystick mod) 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 catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\VTOLVR\actions.tsv (when that folder does not exist, the DB\VTOLVR folder next to the engine).
  • It is built from the installed BYOJoystick mod and your seat files by engine vtolvr refresh-db (engine vtolvr mod installs the mod).
  • 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 (BYOJoystick mod) Action Catalog", "Source:", "Actions: ", then <id> | axis|button | <category> | <title> per action).
  • Without a list: the warning VTOL VR (BYOJoystick mod) action catalog not found: <path> and an empty list, exit code 0.
  • Related: engine vtolvr refresh-db, engine vtolvr 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 catalog --text

#engine vtolvr scan

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

Shows the joystick binds VTOL VR (BYOJoystick mod) 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 scan --text
Advanced
  • It reads the seat files BYOJ_<seat>.xml (AV42C, FA26B, F45A, AH94Front, AH94Rear, T55Front, T55Rear, EF24GFront, EF24GRear); devices are matched by the DirectInput instance GUID, invert and the mod's Deadzone come per bind.
  • Path (positional or --path): another SaveData folder.
  • --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 JoyPro reads in this game are listed too; engine vtolvr import takes them only with --include-keyboard.
  • 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 mod and your seat files; without the mod a warning names engine vtolvr refresh-db and the binds cannot be matched.
Technical internals
  • Output: JSON (ConfigPath, BindingsRead, Bindings with ActionId, Device, Input, IsAxis, Reformers, Inverted, then Steps, Warnings, Errors), or text with --text ("VTOL VR (BYOJoystick mod) Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No VTOL VR (BYOJoystick mod) config file found. Pass the path explicitly.
  • Unknown options fail with Unknown VTOLVR 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 import, engine vtolvr paths, engine vtolvr 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 (BYOJoystick mod)'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 (BYOJoystick mod) details · what each mode changes

Example

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

written
engine vtolvr 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 BYOJoystick mod's binds of VTOL VR into your JoyPro profile: every target per vehicle seat, from your sticks, throttles and (on request) the keyboard. Nothing in the game changes. The GUI runs it with Import on the VTOL VR card of the Start page.

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

It reads the seat files <install>\SaveData\BYOJ_<seat>.xml (AV42C, FA26B, F45A, AH94Front, AH94Rear, T55Front, T55Rear, EF24GFront, EF24GRear). The command list exists only with the mod installed (engine vtolvr mod).

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the seat files have.
  • --include-keyboard also reads the keyboard binds (with their one modifier key).
  • Devices are matched by the DirectInput instance GUID; invert and the mod's Deadzone number come in per bind.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from VTOL VR (BYOJoystick mod)" 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 (BYOJoystick mod) config file found. Pass the path explicitly.).
  • Without a path it reads the location engine vtolvr paths lists first.
  • With --profile the profile is saved afterwards. The imported inputs are recorded as JoyPro's, and a game JoyPro never exported to is watched from now on.
  • Related: engine vtolvr scan, engine vtolvr export, engine vtolvr-native 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 (BYOJoystick mod)'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 (BYOJoystick mod) details · what each mode changes

Example

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

written
engine vtolvr 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 binds into the BYOJoystick mod's seat files of VTOL VR; a relation goes into every seat whose vehicle has that target. Close VTOL VR first. The GUI's Export now on the VTOL VR card runs it.

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

It writes <install>\SaveData\BYOJ_<seat>.xml, one file per vehicle seat, atomically (a temporary file, then replace).

--mode Per seat file
add a bind on an input another target uses (with the same modifier state) is listed, not written
merge the other target on your input loses it; a moved target keeps its old input
merge-overwrite (engine default) as merge, and your targets leave their other inputs on connected devices (keys only with --include-keyboard)
clean (GUI default) the devices JoyPro writes keep only your binds
  • --nuke-untouched-devices: connected devices without binds are cleared (not with add). VTOL VR counts as a flight-only game.
  • --include-keyboard writes your keyboard binds; without it the keyboard stays.
  • Per bind: invert and the mod's one Deadzone number. Hat diagonals, a button on an axis target and an axis on a button target are skipped with a warning.
  • Never touched: devices that are not connected, --ignore-device(s), the --vjoy-tunnel device, inputs JoyPro cannot read, the seat's modifier button unless your profile brings its own, gameSettings.cfg.
  • Safety: refused while VTOLVR runs; backed up first (undo: engine backups list); the profile is kept as "Before export to VTOL VR (BYOJoystick mod)". --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 export --mode clean
engine vtolvr export --mode add
engine vtolvr export --mode merge
engine vtolvr export --mode merge-overwrite

In the game Writes into VTOL VR (BYOJoystick mod)'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: <install>\SaveData\BYOJ_<seat>.xml (XmlSerializer). VTOL VR (BYOJoystick mod) details · what each mode changes

Example

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

#engine vtolvr refresh-db

written
engine vtolvr 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 command list from the installed BYOJoystick mod and your own BYOJ_<seat>.xml files. Check again in the VTOL VR panel of the Start page runs it once the mod is installed, and Update on the VTOL VR card runs it too.

engine vtolvr refresh-db --dry-run
Advanced
  • Reads the mod's BYOJoystick.dll read only (the DLL is not loaded or run): each seat's targets with category and input type. New targets come in; known ones keep their title and category and gain the seats they lack.
  • Then the files BYOJ_<seat>.xml of the game's SaveData folder are read on top; files of unknown seats are skipped with a warning.
  • Path (positional or --path): BYOJoystick.dll or its folder, the SaveData folder, a file in it or the VTOL VR folder.
  • --dry-run writes nothing. The list is written only when it changed.
  • Refused when VTOL VR is not installed.
Technical internals

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.

Used by the GUI Start: Check again

Example

engine vtolvr refresh-db --text

#engine vtolvr mod

written
engine vtolvr mod status|prepare [--accept-license]

The BYOJoystick mod on this PC: Mod Loader, Workshop item, BYOJoystick.dll with SHA-256 and the targets JoyPro reads; prepare backs up the BYOJ_<seat>.xml files and returns the Steam pages to open (Mod Loader, Workshop item 3276352374); Steam downloads and installs the mod, JoyPro ships none of it; refresh-db then reads the targets from the installed mod

For beginners

Shows whether the BYOJoystick mod for VTOL VR is on this PC (status), or prepares its install from the Steam Workshop (prepare). In the VTOL VR panel of the Start page, Install BYOJoystick runs prepare after your tick and Check again runs status. JoyPro ships no part of the mod; Steam downloads it.

engine vtolvr mod status --text
Advanced
  • status (default): Mod Loader installed, mod installed, its folder, BYOJoystick.dll with SHA-256, size and file version, and how many targets JoyPro reads from it.
  • prepare --accept-license: the flag is the GUI's tick. It backs up your SaveData\BYOJ_*.xml files into the game backup store (engine backups list --game VTOLVR) and returns the Steam addresses to open: the Mod Loader when it is missing, the Workshop item 3276352374 when the mod is missing. JoyPro writes no mod file.
  • Not refused when VTOL VR is not detected.
Technical internals
  • Output: JSON (ModLoaderInstalled, ModInstalled, ModFolder, DllPath, DllSha256, DllSize, DllVersion, Targets, the Workshop and source pages, OpenUrls and BackedUp after prepare), or text with --text.
  • Exit code 0; 1 for an unknown verb or prepare without --accept-license (the reason in the JSON Errors).
  • Related: engine vtolvr refresh-db, engine vtolvr export.

What it does The BYOJoystick mod on this PC: Mod Loader, Workshop item, BYOJoystick.dll with SHA-256 and the targets JoyPro reads; prepare backs up the BYOJ_<seat>.xml files and returns the Steam pages to open (Mod Loader, Workshop item 3276352374); Steam downloads and installs the mod, JoyPro ships none of it; refresh-db then reads the targets from the installed mod.

OptionValuesMeaning
--accept-licenseswitch (no value)

Used by the GUI Start: Install BYOJoystick · Start: Check again · Start: Install BYOJoystick

Example

engine vtolvr mod status|prepare --text