21 commands of engine vjoy. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.
#engine vjoy status
writtenengine vjoy status
Virtual joystick mode: vJoy and HidHide installed, vJoy devices, HidHide state and JoyPro's session, games native/virtual, the mapping table, what vJoy must offer; read-only
For beginners
Shows the virtual joystick state: vJoy and HidHide installed, the vJoy devices, HidHide's state and JoyPro's session,
each game's mode (native, vJoy, Xbox pad) and the mapping table. Refresh on the Virtual Joystick page's Overview
runs it.
engine vjoy status --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Per game: mode, relations, executables, suggested mode for one-device games, input limits and warnings, functions,
modes.
- Per vJoy device: what the table needs and what it has.
- Read-only and without administrator rights: HidHide's hidden-device list usually cannot be read then and shows as
unknown, never as empty.
What it does Virtual joystick mode (docs/virtual-joystick.md): vJoy and HidHide installed, the vJoy devices (configuration and DirectInput name), HidHide's state, JoyPro's HidHide session (stale when its owner is gone), the games native/virtual, the mapping table and what vJoy must offer. Read-only.
Used by the GUI Virtual Joystick: Stop · Virtual Joystick: Refresh · Virtual Joystick: Set up vJoy for the table · Virtual Joystick: Restore HidHide · Virtual Joystick: Set up vJoy for maximum · Virtual Joystick: Update mapping · Virtual Joystick: Add function · Virtual Joystick: Add mode · Virtual Joystick: Save · Virtual Joystick: Import
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy status --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
engine vjoy mode <game> native|virtual|xbox [--dry-run]
Per game: physical devices, the virtual joystick (vJoy, every used input gets a fixed vJoy slot) or the virtual Xbox 360 pad (ViGEmBus, for XInput-only or one-device games: the game's gamepad layout first, then sticks, triggers, buttons, D-pad); without a choice a game that reads only Xbox controllers (ACE COMBAT 8, Hell Let Loose: Vietnam) is on the Xbox pad by itself
For beginners
Switches one game between your physical devices (native), the virtual joystick (virtual, vJoy) and the virtual Xbox
360 pad (xbox, ViGEmBus). A game's mode buttons on the Virtual Joystick page run it. Export the game again afterwards.
engine vjoy mode DCS virtual --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
<game>: a game id or name JoyPro knows. Mode: native, virtual (also vjoy) or xbox.
virtual: every input the game's relations use (axes, buttons, hats, modifier buttons) gets a fixed place on the
vJoy device in the mapping table (engine vjoy map); export, import and sync of the game then work on the vJoy
inputs.
xbox: for games that read only Xbox controllers or one device. The game's gamepad layout puts actions on their pad
controls first, the rest fills the sticks, triggers, 14 buttons and the D-pad; what does not fit is listed.
native takes the game out of virtual mode; its places stay in the table until engine vjoy map --prune.
- Without a mode chosen, a game that reads only Xbox controllers (ACE COMBAT 8, Hell Let Loose: Vietnam) is on the Xbox
pad by itself (
engine vjoy status AutoMode). An explicit mode wins and is kept.
- Switching between
virtual and xbox gives the game's virtual functions outputs of the new target.
- A one-device game set to another mode than the suggested one gets a warning with the suggested mode.
--dry-run saves nothing. Only the profile changes: vJoy, HidHide and the game's files are untouched until Start
and the next export.
Technical internals
- Output: the plan as for
engine vjoy map, with the message <game> now uses the virtual joystick (vJoy). (or the
Xbox pad, or the physical devices); exit code 0, 1 when the plan has errors (nothing is saved then).
- Failures (exit
1): engine vjoy mode <game> native|virtual|xbox, Unknown game: ..., The mode is native, virtual (vJoy) or xbox (virtual Xbox 360 pad)., Unknown vjoy mode argument(s): ...
- Stored in the profile; one undo step with
--profile. Reference: virtual-joystick. Related:
engine vjoy status, engine vjoy limits.
What it does Switches a game between its physical devices (native), the virtual joystick (virtual, vJoy) and the virtual Xbox 360 pad (xbox, ViGEmBus: for games that only read XInput or one device; the game's gamepad layout pins actions to their controls, the rest fills sticks, triggers, 14 buttons and the D-pad, what does not fit is listed). Virtual gives every input the game's relations use (axes, buttons, hats, modifier buttons) a fixed vJoy slot; export, import and sync of the game then work on the vJoy slots.
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy mode DCS virtual --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy mode DCS native --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy mode HLLVietnam xbox --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
engine vjoy plan [--reset] [--prune]
The mapping table and the vJoy configuration it needs; nothing is saved
For beginners
Shows the mapping table the virtual-mode games need and the vJoy configuration it takes, without saving anything.
engine vjoy plan --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The same plan as
engine vjoy map with --dry-run: --reset plans the table anew, --prune drops places no game
uses any more.
- Per vJoy device: its places and function outputs, the axes, buttons and hats they need, what the device has, and
fits or the vJoyConfig arguments it would need (engine vjoy configure-vjoy).
- Read-only (
--dry-run is accepted and changes nothing).
Technical internals
- Output: as
engine vjoy map with the message Plan (nothing saved).; exit code 0, 1 when the plan has errors
(for example No free vJoy ... left on devices 1-16 for ...) or with Unknown vjoy plan argument(s): ....
- Related:
engine vjoy status, engine vjoy settings (the devices JoyPro may use).
What it does Shows the mapping table and the vJoy configuration it needs without saving anything.
| Option | Values | Meaning |
|---|
--reset | switch (no value) | |
--prune | switch (no value) | |
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy plan --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
engine vjoy map [--reset] [--prune] [--dry-run]
Saves the mapping table in the profile; slots never move unless --reset; --prune drops unused slots
For beginners
Gives every input the virtual-mode games use a fixed place on the vJoy device (or the Xbox pad) and saves this table in
the profile. Update mapping on the Mapping tab runs it, and Start / Test run it first.
engine vjoy map --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Places never move: new inputs get a free place (an axis keeps its own axis where free, buttons and hats the next
number).
--reset plans the table anew; --prune drops places no game uses any more; --dry-run saves nothing.
- Per vJoy device it says what it needs and whether it fits; a device that lacks something needs
engine vjoy configure-vjoy.
- Only the profile changes; the games get the vJoy inputs at their next export.
Technical internals
- Output:
Message, VirtualGames, XboxGames, Slots, Added, Removed, Unused, Devices, Xbox, Errors,
Warnings; exit code 0, 1 when the plan has errors (nothing is saved then).
- One undo step with
--profile. Related: engine vjoy plan (the same, never saved).
What it does Saves the mapping table in the profile: existing slots never move, new inputs get free slots (an axis keeps its own axis where free); --prune drops unused slots, --reset starts over.
| Option | Values | Meaning |
|---|
--reset | switch (no value) | |
--prune | switch (no value) | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Used by the GUI Virtual Joystick: Start · Virtual Joystick: Test · Virtual Joystick: Update mapping
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy map --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy map --prune --dry-run --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy settings
writtenengine vjoy settings [--first-device N] [--last-device N] [--auto-start on|off] [--hide-devices on|off] [--xbox-pad-game <game>|none] [--dry-run]
Which vJoy devices JoyPro may use, GUI auto start, HidHide on/off; several games on the Xbox pad: whose pad table a manual Start uses when none of them runs
For beginners
Sets which vJoy devices JoyPro may use, whether the virtual joystick starts and stops by itself with a game in virtual
mode, and whether HidHide hides the physical devices. The ticks "Hide the real devices from the games set to Virtual
(HidHide)" and "Start and stop by itself when a game set to Virtual starts and ends" on the Virtual Joystick page run
it.
engine vjoy settings --first-device 2 --last-device 3 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--first-device N, --last-device N: 1..16 (default 1 to 16), the last not below the first. The mapping table and
the function outputs use only these devices.
--auto-start on|off (default off), --hide-devices on|off (default on); true/false, yes/no, 1/0 work
too.
--xbox-pad-game <game>|none: several games on the Xbox pad: whose pad table Start and Test use when none of them
runs (the game must be on the pad).
- Without options it prints the current settings.
--dry-run saves nothing.
Technical internals
- Output:
vJoy devices <first>-<last>, auto start on|off, hide physical devices on|off.; JSON also FirstDevice,
LastDevice, AutoStart, HideDevices; exit code 0.
- Failures (exit
1): --first-device takes 1..16., --last-device takes 1..16., --last-device must not be below --first-device., --auto-start takes on or off.
- Stored in the profile; one undo step with
--profile. Related: engine vjoy map, engine vjoy apply-hidhide.
What it does Which vJoy devices JoyPro may use (--first-device/--last-device), the GUI's auto start, and whether HidHide hides the physical devices.
| Option | Values | Meaning |
|---|
--first-device | switch (no value) | |
--last-device | switch (no value) | |
--auto-start | on off | |
--hide-devices | on off | |
--xbox-pad-game | <game> | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Every value as a command line
engine vjoy settings --auto-start on
engine vjoy settings --auto-start off
engine vjoy settings --hide-devices on
engine vjoy settings --hide-devices off
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy settings --first-device 2 --last-device 3 --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
engine vjoy exe <game> [--add <path>] [--remove <path>]
The game executables HidHide blocks in virtual mode: found in the installation + your own
For beginners
Lists the executables of a game that HidHide blocks in virtual mode, so that game sees only the virtual joystick: the
ones found in the game's installation plus your own. Add the game's program when JoyPro does not find it.
engine vjoy exe DCS --add "D:\DCS World\bin-mt\DCS.exe" --text
Advanced
<game> is required. --add <path> (repeatable): an existing file, kept with its full path. --remove <path>
(repeatable): removes one of yours.
- Found by JoyPro: the installation's marker executables and the game's process names found a few folder levels deep
in the installation folder.
- Yours are kept outside the profile and used at the next
engine vjoy apply-hidhide.
Technical internals
- Output: JSON
Game, Exes, Extra (yours), Warnings, or text with (set by you) after your own; exit code 0.
- Failures (exit
1): engine vjoy exe <game> [--add <path>] [--remove <path>], Unknown game: ..., Executable not found: ...
- Your list:
%LOCALAPPDATA%\JoyPro2\VirtualJoystick\game-exes.json. Reference: virtual-joystick.
What it does Lists (and adds/removes) the game executables HidHide blocks in virtual mode: found in the game's installation, plus your own.
| Option | Values | Meaning |
|---|
--add | <path> | |
--remove | <path> | |
Example
engine vjoy exe DCS --text
engine vjoy exe DCS --add 'D:\DCS World\bin-mt\DCS.exe' --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy pad-check
writtenengine vjoy pad-check [--game <game>]
Per game on the virtual Xbox pad, what the profile reaches there with the auto setup: throttle split on both triggers, yaw, chords such as flares, the menu D-pad; a score 0..1; read-only
For beginners
Shows what your profile reaches on the virtual Xbox pad, per game on the pad: the throttle on both triggers, yaw, the
chords such as ACE COMBAT 8's flares, High-G turn and the menu D-pad, with a score from 0 to 1.
engine vjoy pad-check --game AceCombat8 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--game <game>: one game; without it every game on the pad that the profile uses.
- It applies JoyPro's auto setup in memory, as
engine vjoy plan does: the throttle split, yaw from the twist or the
pedals, the flare chord, High-G from a relation named "High-G", the D-pad from the comm switch or AI-menu hat.
- Read-only.
Technical internals
- JSON:
Games[] with Game, OnPad, Score, Notes and Checks[] (Name: throttle-split, yaw,
chord:<name>, hold:<name>, menu-dpad; Applies, Ok, Detail). Text: one line per check, ok or MISS.
- Exit code
0; 1 with Unknown game: .... Reference: virtual-joystick.
What it does Per game on the virtual Xbox pad, what the profile reaches there with the auto setup: throttle split on both triggers, yaw, chords such as flares, the menu D-pad; a score 0..1; read-only.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
Example
engine vjoy pad-check --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy forwarder-config
writtenengine vjoy forwarder-config [--out <file>] [--xbox-game <game>] [--game <game>]
The mapping table for JoyPro.VJoy.exe, the forwarding process; one Xbox game's pad table (default: settings --xbox-pad-game) with the axis curves JoyPro applies on the pad; with --game only that game's virtual functions
For beginners
Writes the table for JoyPro.VJoy.exe, the process that copies your inputs to the virtual joystick: the devices, the
places and the resolved virtual functions. Start and Test on the Virtual Joystick page run it.
engine vjoy forwarder-config --out "C:\Users\Pilot\Documents\JoyPro\forwarder.json" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Only the places a vJoy game uses go into it; devices by DirectInput instance GUID.
--xbox-game <game>: the Xbox pad table of that game (the GUI passes the game that runs); else the game picked with
engine vjoy settings --xbox-pad-game, else the first Xbox game with something to forward. The others keep their
tables (xboxWaiting in the table). Each pad axis carries the relation's curve for that game (curve), because
the pad's games get no export; vJoy places stay 1:1.
--game <game>: only that game's virtual functions (the GUI passes the game that started); else those of every
virtual game.
- Changes nothing in the profile.
Technical internals
- Without
--out the table itself is printed as JSON (also with --text). With --out: Message, Path, counts,
Warnings (function problems).
- Exit code
0, 1 when the plan has errors, the Xbox game does not use the pad or the game is unknown.
- Related:
engine vjoy map, engine vjoy functions list.
What it does Writes the mapping table for JoyPro.VJoy.exe, the process that forwards the physical inputs to vJoy.
| Option | Values | Meaning |
|---|
--out | <file> | Global option: write result output to file path instead of terminal. |
--xbox-game | <game> | |
--game | <game> | Game filter value. Example: DCS or IL2Game. |
Used by the GUI Virtual Joystick: Start · Virtual Joystick: Test
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy forwarder-config --out 'C:\JoyPro\forwarder.json'
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy functions types
writtenengine vjoy functions types
The virtual function types: axis bands, button cycle, toggle, switch pulses, short/long/double press, shift layer, merge, split, curve, axis ends, axes to hat, buttons to axis, encoder, turbo, macro, hat to buttons, buttons to hat, remap, mode switch
For beginners
Lists the kinds of virtual function you can add, each with its inputs, outputs and parameters with their defaults.
engine vjoy functions types --text
Advanced
- Type ids for
--type: bands, cycle, toggle, switch, presses, shift, merge, split, curve,
axis-buttons, axes-hat, buttons-axis, hat-axes, encoder, turbo, macro, hat-buttons, buttons-hat,
remap, mode.
- Per input and output role: its kind, whether it is optional, and
<n> for numbered roles.
- Read-only; no profile needed.
Technical internals
- Output: JSON
Types, or text (<icon> <id> - <name>: <summary> with inputs:, outputs:, params: lines); exit
code 0, 1 with Unknown vjoy functions types argument(s): ...
- Related:
engine vjoy functions add.
What it does Lists the virtual function types (axis bands, button cycle, toggle, switch pulses, short/long/double press, shift layer, merge, split, curve, axes to hat, macros, remaps, mode switch and more).
Example
engine vjoy functions types --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy functions list
writtenengine vjoy functions list [--game <game>]
The virtual functions per game with inputs, outputs (bind device and input), problems, limit warnings and the physical devices for inputs
For beginners
Lists the virtual functions of every game, or of one, with their inputs, outputs, problems and warnings.
engine vjoy functions list --game DCS --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--game <game>: only that game. vjoy functions without an action lists too.
- Each output shows the bind device and input the game gets; problems (an input or output missing) and warnings about
the game's input limits are listed per function.
- JSON also lists the physical devices with their axes, buttons and hats (the editor's pickers) and, with
--game,
the game's input limits (engine vjoy limits).
- Read-only.
Technical internals
- Output: JSON
Game, Functions, InputDevices, Limits, Warnings, or text Virtual functions of <game>: <n>
with in, out, problem and warning lines; exit code 0.
- Failures (exit
1): Unknown game: ..., Unknown vjoy functions list argument(s): ...
- Related:
engine vjoy functions set, engine vjoy forwarder-config.
What it does The virtual functions per game with inputs, outputs (bind device and input), problems, limit warnings and the physical devices for inputs.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
Example
engine vjoy functions list --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy functions add
writtenengine vjoy functions add --game <game> --type <type> [--name <name>] [--input role=<device>|<input>]... [--output role=<target>[@<vJoy device>][:hold|enter|leave|both]]... [--param key=value]... [--edges 0.1,0.9] [--count n] [--tuning <axis tuning>] [--keyboard on|off] [--modes <mode,...>] [--switch-modes <mode,...>] [--spec <json>|@<file>] [--no-auto-outputs] [--dry-run]
Adds a function; an input may read another function's output: --input role=fn:<id>|<output>; loops are refused; outputs left empty get free vJoy buttons/axes/hats (or Xbox pad controls), reserved in the table; --modes: the modes it works in (none: every mode)
For beginners
Adds a virtual function to a game: axis bands, toggles, short/long press, shift layers, macros and more, running
between your devices and the virtual joystick. Add function on the Functions tab runs it with the game and type.
engine vjoy functions add --game DCS --type bands --input "in=VPC Throttle|JOY_Z" --count 3 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--type (engine vjoy functions types) or --spec <json>|@<file> (a whole function); --name.
--input role=<device>|<input> (repeatable; role=fn:<id>|<output> reads another function's output; role=
clears). --output role=<target>[@<vJoy device>][:hold|enter|leave|both].
--param key=value, --edges 0.1,0.9, --count 1..32, --tuning, --keyboard on|off, --modes a,b (none: every
mode), --switch-modes.
- Outputs left empty get free vJoy buttons, axes or hats (or Xbox controls), reserved in the table;
--no-auto-outputs
leaves them empty. Loops between functions are refused. --dry-run saves nothing.
- The function works only while the game is in virtual mode.
Technical internals
- Output:
Message, Item (outputs, problems, warnings), Notes; exit code 0, 1 with the reason (functions add needs --type <type> ... or --spec <json|@file>., Unknown function type: ..., --count takes 1..32., a loop).
- Ids are
f1, f2 ...; stored in the profile. Related: engine vjoy functions set, engine vjoy functions test.
What it does Adds a virtual function to a game: inputs (devices or other functions' outputs), outputs (left empty: free vJoy or Xbox pad controls are reserved), parameters, modes; loops are refused; --dry-run previews.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
--type | <type> | Set relation type via value token (`axis` or `button`). |
--name | <name> | Name value for commands that create/merge entities. Example: --name 'Merged Startup'. |
--input | switch (no value) | Input token. Example: --input JOY_BTN1 or --input joy0_b0. |
--output | switch (no value) | |
--param | switch (no value) | A response model parameter as name=value, repeatable. Example: --param sensitivity=22 --param offset=10. |
--edges | switch (no value) | |
--count | switch (no value) | |
--tuning | <axis tuning> | |
--keyboard | on off | Include keyboard clean-profile checks for supported DB commands. |
--modes | <mode,...> | |
--switch-modes | <mode,...> | |
--spec | <json> | |
--no-auto-outputs | switch (no value) | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Every value as a command line
engine vjoy functions add --keyboard on
engine vjoy functions add --keyboard off
Used by the GUI Virtual Joystick: Add function
Example
engine vjoy functions add --game <game> --type <type> --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy functions set
writtenengine vjoy functions set --game <game> --id <id> [same options as add] [--enabled on|off] [--auto-outputs] [--dry-run]
Changes a function; --spec replaces it
For beginners
Changes a virtual function. Save in the function editor runs it with the whole function (--spec), On / off
with --enabled, and wiring an input to another function in the graph with --input.
engine vjoy functions set --game DCS --id f1 --enabled off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--id required; the same options as engine vjoy functions add; --spec replaces the function, its id stays.
--enabled on|off; --auto-outputs fills empty outputs with free places.
- Loops are refused and nothing is saved. A running virtual joystick takes the change after Stop and Start.
What it does Changes a virtual function (same options as add, --enabled on|off; --spec replaces it); --dry-run previews.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
--id | <id> | Node ID. Example: --id d3007pnilu3007cd16vd1vpnilvu0. |
--enabled | on off | |
--auto-outputs | switch (no value) | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Every value as a command line
engine vjoy functions set --enabled on
engine vjoy functions set --enabled off
Used by the GUI Virtual Joystick: Save
Example
engine vjoy functions set --game <game> --id <id> --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy functions remove
writtenengine vjoy functions remove --game <game> --id <id> [--dry-run]
Removes a function; its outputs are free again, inputs of other functions that read it are cleared
For beginners
Removes a virtual function from a game; its virtual outputs are free again. Remove in the function list runs it
after asking.
engine vjoy functions remove --game DCS --id f1 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--game and --id are required.
- Inputs of other functions that read this function's output are cleared (the message names them).
- Binds in your relations on its outputs stay; remove them there if you no longer need them.
--dry-run saves nothing.
Technical internals
- Output:
Removed the function <id> "<name>" of <game>; its virtual outputs are free again. (JSON Message, Id,
Game); exit code 0.
- Failures (exit
1): --game <game> is needed., functions remove needs --id <function id>., No function ... for ...
- One undo step with
--profile. Related: engine vjoy functions list.
What it does Removes a virtual function; its outputs are free again and inputs of other functions that read it are cleared; --dry-run previews.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
--id | <id> | Node ID. Example: --id d3007pnilu3007cd16vd1vpnilvu0. |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Example
engine vjoy functions remove --game <game> --id <id> --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy functions test
writtenengine vjoy functions test (--game <game> --id <id> | --spec <json>|@<file>) [--stream "<ms>:<role>=<value>; ..."] [--rate Hz] [--duration ms]
Simulates the function with the forwarder's evaluation and lists every output change; nothing goes to vJoy, the pad or the keyboard
For beginners
Simulates a virtual function with the forwarder's own evaluation and lists every change of its outputs over time.
Nothing goes to vJoy, the pad or the keyboard.
engine vjoy functions test --game DCS --id f1 --stream "0:in=0; 500:in=0.5; 1000:in=1" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The function:
--game with --id (from the profile), or --spec <json>|@<file> (a function that is not saved).
--stream: items <ms>:<role>=<value> separated by ; or ,; a button takes 1/0, on, down or press.
Without it a stream that shows the type's behaviour is used (for axis types a sweep up and back down over two
seconds).
--rate 10..2000 Hz (default 240), --duration 1..600000 ms (default: the stream's, 2000 ms for most types).
- Key presses of the function are listed as simulated, not sent. Read-only.
Technical internals
- Output: JSON
Function, Type, Rate, Duration, Stream, Events, Keys, Problems, or text lines <ms> ms <output> (<target>) -> <value>; exit code 0.
- Failures (exit
1): functions test needs --game <game> --id <function id>, or --spec <json|@file>., --rate takes 10..2000 Hz., --duration takes milliseconds (1..600000)., A stream item is <time ms>:<role>=<value>, e.g. 0:in=0.2; got "..."
- Related:
engine vjoy functions add, engine vjoy functions set.
What it does Simulates a function with the forwarder's evaluation and lists every output change; nothing goes to vJoy, the pad or the keyboard.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
--id | <id> | Node ID. Example: --id d3007pnilu3007cd16vd1vpnilvu0. |
--spec | <json> | |
--stream | switch (no value) | |
--rate | switch (no value) | |
--duration | switch (no value) | |
Example
engine vjoy functions test (--game <game> --id <id> --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy modes
writtenengine vjoy modes list|add|set|remove|start --game <game> [--name <mode>] [--parent <mode>] [--rename <name>] [--dry-run]
The game's modes (layers) of its virtual functions: a mode inherits the functions of its parent unless it has its own on that input; start: the mode the forwarder starts in
For beginners
Manages a game's modes (layers) of its virtual functions: list, add, set (rename, parent), remove, and the mode at start.
Add mode, Rename, × and At start on the Functions tab run it.
engine vjoy modes add --game DCS --name Landing --parent Combat --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
list|add|set|remove|start --game <game> (required) and --name <mode>.
add: --parent makes it inherit the parent's functions unless it has its own on that input.
set: --parent (empty: none; loops refused), --rename (renamed everywhere: children, functions, start mode).
remove: children inherit from its parent; functions drop the mode.
start: the mode the forwarder starts in. --dry-run saves nothing.
Technical internals
- Output:
Message, Game, Start, Modes (name, parent, start, lineage, functions); exit code 0, 1 with the
reason (--game <game> is needed., The mode "..." exists already for ..., No mode "..." for ...).
- Stored in the profile.
What it does The modes (layers) of a game's virtual functions: a mode inherits the functions of its parent unless it has its own on that input; start = the mode the forwarder starts in; --dry-run previews.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
--name | <mode> | Name value for commands that create/merge entities. Example: --name 'Merged Startup'. |
--parent | <mode> | |
--rename | <name> | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Used by the GUI Virtual Joystick: Add mode
Example
engine vjoy modes list|add|set|remove|start --game <game> --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy import-gremlin
writtenengine vjoy import-gremlin <profile.xml> --game <game> [--dry-run] [--replace] [--vjoy-device N]
A Joystick Gremlin R13/R14 profile into the game's virtual functions and modes: devices by GUID or name, remaps, curves, keys, macros, mode changes, merged axes, tempo/double tap/chain/smart toggle/hat buttons containers, axis ranges; lists what JoyPro cannot do and what differs; --vjoy-device moves the profile's vJoy device (default: the tunnel device)
For beginners
Turns a Joystick Gremlin profile (.xml, R13 or R14) into virtual functions and modes of one game. Import a Gremlin
profile... on the Functions tab runs it as a dry run for the report, Import runs it for real.
engine vjoy import-gremlin "C:\Users\Pilot\Documents\Gremlin\dcs.xml" --game DCS --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The file: positional or
--file; --game required.
- Devices by GUID or name; remaps, curves, keys, macros, mode changes, merged axes and containers become functions.
The report lists what was imported, what JoyPro cannot do and what differs.
--replace removes the game's functions and modes first; else they are added.
--vjoy-device 1..16: the vJoy device of the outputs (default: the tunnel device, when set).
--dry-run saves nothing.
Technical internals
- Output:
Message, Format, Devices, Modes, StartMode, Functions, NotImported, Notes, Warnings; exit
code 0, 1 with the reason (The Gremlin profile was not found: ..., a loop: ... Nothing was imported.).
- Stored in the profile. Related:
engine vjoy functions list, engine vjoy mode.
What it does Imports a Joystick Gremlin R13/R14 profile into a game's virtual functions and modes and lists what JoyPro cannot do and what differs; --replace starts over, --dry-run previews.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
--replace | switch (no value) | For game import: start from an empty relation list instead of merging into the loaded profile. |
--vjoy-device | switch (no value) | |
Used by the GUI Virtual Joystick: Import
Example
engine vjoy import-gremlin <profile.xml> --game <game> --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy limits
writtenengine vjoy limits [--game <game>]
What each game reads of one joystick: buttons, axes, hats, with confidence and source; vJoy offers 128 buttons, 8 axes, 4 hats
For beginners
Lists what each game reads of one joystick: how many buttons, axes and hats, with confidence and source. vJoy offers
up to 128 buttons, 8 axes and 4 hats per device, on up to 16 devices.
engine vjoy limits --game DCS --text
Advanced
--game <game>: one game; without it every game.
- Per game: buttons, axes, hats (and four-way hats), the interface it reads, the confidence (
unknown when JoyPro
does not know the limits), a note and the source.
- Read-only; no profile needed.
Technical internals
- Output: JSON
VJoyMaximum (Buttons, Axes, Hats, Devices) and Games (Game, Name, Known, Buttons,
Axes, Hats, FourWayHats, Interface, Confidence, Describe, Note, Source), or text; exit code 0.
- Failures (exit
1): Unknown game: ...
- Related:
engine vjoy mode (one-device games), engine vjoy status.
What it does What each game reads of one joystick (buttons, axes, hats) with confidence and source; vJoy offers 128 buttons, 8 axes and 4 hats.
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
Example
engine vjoy limits --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
#engine vjoy configure-vjoy
writtenengine vjoy configure-vjoy [--max [--device N]] [--dry-run]
Runs vJoyConfig for the vJoy devices that lack axes, buttons or hats, or with --max sets 8 axes, 128 buttons, 4 hats; keeps what a device has except axes a virtual-mode game must not see (e.g. Rx/Ry for Battlefield), which are left out unless the table uses them; one administrator prompt, exit code 2 when it is declined; Windows must restart afterwards
For beginners
Sets the vJoy devices up with the axes, buttons and hats the mapping table needs, or with vJoy's maximum (--max).
Set up vJoy for the table and Set up vJoy for maximum (asks first) on the Overview run it. Windows asks once for
administrator rights, and Windows must restart afterwards.
engine vjoy configure-vjoy --max --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- What changes: the vJoy driver's device configuration. It runs vJoy's own
vJoyConfig.exe as vJoyConfig <n> -f -a <axes> -b <buttons> -p <hats> per device that lacks something (--max: 8 axes, 128 buttons, 4 hats for every device
JoyPro uses, or --device N); force feedback is kept.
- Buttons and hats are never reduced. An axis a virtual-mode game must not see (Battlefield's Rx/Ry) is left out
unless the table uses it.
- Rights: one UAC prompt for the whole run (one device: vJoyConfig itself elevated; several: one elevated engine
helper). Declined: nothing changes.
- Windows must restart before the new setup works; JoyPro never restarts Windows. Then export the virtual-mode games
again. There is no undo command.
--dry-run lists the vJoyConfig calls and changes nothing. The profile is not changed.
Technical internals
- Output:
Message, DryRun, Maximum, Cancelled, RestartNeeded, Commands, Warnings.
- Exit codes:
0; 1 (vJoy not installed, plan errors, a device does not read back as wanted); 2 the prompt was
declined (The Windows administrator prompt was declined; vJoy was not changed.).
- Related:
engine vjoy map, engine vjoy status.
What it does Runs vJoyConfig (one administrator prompt) for the vJoy devices that lack axes, buttons or hats for the table, or with --max sets vJoy's maximum. A device keeps what it has, except axes a virtual-mode game must not see (e.g. Battlefield's Rx/Ry), which are left out unless the table uses them.
| Option | Values | Meaning |
|---|
--max | switch (no value) | |
--device | switch (no value) | Include one device per flag. Example: --device LEFT VPC Throttle. |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Used by the GUI Virtual Joystick: Set up vJoy for the table · Virtual Joystick: Set up vJoy for maximum
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy configure-vjoy --dry-run --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
- Changes the PC (one Windows administrator prompt); --dry-run shows the commands and changes nothing. Exit code 2 = the prompt was declined.
#engine vjoy apply-hidhide
writtenengine vjoy apply-hidhide [--dry-run] [--owner-pid N] [--exe <game.exe>]... [--trusted <program.exe>]...
Hides the mapped physical devices from the virtual-mode games only; one administrator prompt, exit code 2 when it is declined; journal first
For beginners
Hides the physical devices of the mapping table from the virtual-mode games only, with HidHide, so those games see just
the virtual joystick. Start on the Virtual Joystick page runs it when "Hide the physical devices" is on. Windows
asks once for administrator rights.
engine vjoy apply-hidhide --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- What changes (HidHide's global configuration): the connected physical devices the table and functions use go on
HidHide's hidden-device list; the virtual-mode games' executables (found in the installation, set with
engine vjoy exe, plus --exe) go on its program list as a block list; device hiding (cloaking) is switched on last.
vJoy devices stay visible; the forwarder and --trusted programs keep seeing the devices.
- An allow list you already use stays one (then only the forwarder and JoyPro are added); your own inactive entries
are parked for the session and put back afterwards.
- Journal first:
%LOCALAPPDATA%\JoyPro2\VirtualJoystick\hidhide-session.txt with the state before, every change and
the owner process (--owner-pid, the GUI's).
- Rights: one UAC prompt; the engine starts itself elevated for the whole step. Declined: nothing changes.
- Refused when no game is in virtual mode, or while an older session waits to be restored (
engine vjoy recover).
--dry-run: the plan without administrator rights (partial when HidHide cannot be read).
- Undo:
engine vjoy restore-hidhide. vJoy's driver configuration is not touched.
Technical internals
- Output: HidHide's result (message, phase, strategy, changes) and warnings (
Not connected, not hidden: ...).
- Exit codes:
0; 1 refused or failed (No game uses virtual mode ...; HidHide was not changed.); 2 the prompt was
declined.
- Reference: virtual-joystick.
What it does Hides the mapped physical devices from the virtual-mode games only (HidHide block list; an existing allow list of the user is kept), never hides vJoy, parks dormant entries. One administrator prompt; the journal is written first.
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
--owner-pid | switch (no value) | |
--exe | <game.exe> | |
--trusted | <program.exe> | |
Used by the GUI Virtual Joystick: Start · Virtual Joystick: Test
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' vjoy apply-hidhide --dry-run --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
- Changes the PC (one Windows administrator prompt); --dry-run shows the commands and changes nothing. Exit code 2 = the prompt was declined.
#engine vjoy restore-hidhide
writtenengine vjoy restore-hidhide [--dry-run] [--force]
Undoes exactly JoyPro's HidHide changes and restores the previous HidHide state, also while the session's owner runs; --force is accepted like for recover and changes nothing here; one administrator prompt, exit code 2 when it is declined
For beginners
Undoes exactly JoyPro's HidHide changes and puts back the setup HidHide had before. Stop and Restore HidHide on
the Virtual Joystick page run it; JoyPro also runs it when the forwarder ends by itself. Windows asks once for
administrator rights.
engine vjoy restore-hidhide --dry-run --text
Advanced
- It reads the journal
%LOCALAPPDATA%\JoyPro2\VirtualJoystick\hidhide-session.txt and takes back only what it lists,
against the configuration found now (entries you added meanwhile stay): cloaking off first (when JoyPro switched it
on), then the hidden devices and programs JoyPro added go, parked entries come back, the inverse mode is set back.
The journal moves to history\.
- No journal: nothing to do (exit
0).
--dry-run: lists from the journal what it would take back, without administrator rights.
--force is accepted as for engine vjoy recover, but changes nothing here: restore-hidhide restores even while the
session's owner (the GUI) runs.
What it does Undoes exactly JoyPro's HidHide changes and gives HidHide its previous state back (one administrator prompt).
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
--force | switch (no value) | Accepted like for vjoy recover; restore-hidhide restores even while the session's owner runs, so it changes nothing here. |
Used by the GUI Virtual Joystick: Stop · Virtual Joystick: Restore HidHide
Example
engine vjoy restore-hidhide --dry-run --text
engine vjoy restore-hidhide --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
- Changes the PC (one Windows administrator prompt); --dry-run shows the commands and changes nothing. Exit code 2 = the prompt was declined.
#engine vjoy recover
writtenengine vjoy recover [--dry-run] [--force]
Restores a session whose owner (the GUI) is gone; --force: also while it runs; one administrator prompt, exit code 2 when it is declined
For beginners
Puts HidHide back as it was when a virtual joystick session did not end cleanly (JoyPro crashed or was closed hard) and
its owner, the GUI, is gone. The GUI runs it at start when it finds such a session. Windows asks once for
administrator rights.
engine vjoy recover --dry-run --text
Advanced
- No session journal: nothing to do (exit
0).
- The owner process named in the journal still runs: nothing changes, the message says so (exit
0); --force
restores anyway.
- Otherwise the same restore as
engine vjoy restore-hidhide: exactly JoyPro's changes are taken back.
--dry-run: lists from the journal what it would take back, without administrator rights.
Technical internals
- Output: HidHide's result and warnings, e.g.
The HidHide session is still in use by process <n>; nothing was changed (use --force to restore anyway).
- Exit codes:
0; 1 failed; 2 the administrator prompt was declined.
- The journal:
%LOCALAPPDATA%\JoyPro2\VirtualJoystick\hidhide-session.txt. Reference: virtual-joystick.
What it does Restores a HidHide session whose owner (the GUI) is gone, e.g. after a crash; --force also while the owner runs.
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
--force | switch (no value) | |
Example
engine vjoy recover --text
How the options interact
- Virtual joystick mode: docs/virtual-joystick.md. JOYPRO_VJOY_FAKE= replaces vJoy and HidHide by files (tests).
- Changes the PC (one Windows administrator prompt); --dry-run shows the commands and changes nothing. Exit code 2 = the prompt was declined.