JoyPro2 Discord GitHub
Engine (CLI)

engine grebels (G-Rebels)

Show:

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

#engine grebels paths

written
engine grebels paths
For beginners

Shows where JoyPro finds G-Rebels' controls on this PC: %LOCALAPPDATA%\G_Rebels\Saved\SaveGames\SaveOptions.sav. Detect in the import wizard's Expert import section runs it.

engine grebels paths --text
Advanced
  • No options. Listed: your own config location of engine games config set first, then SaveOptions.sav when it exists. The button binds are read from EnhancedInputUserSettings.sav in the same folder; that file is not listed.
  • Read-only; also works when the game is not installed or switched off.
Technical internals
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or with --text G-Rebels Config Paths, Paths: <n> and the files. Exit code 0; an unknown option fails with Unknown GRebels paths argument(s): ....
  • Related: engine grebels scan, engine games paths; game page g-rebels.

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

#engine grebels catalog

written
engine grebels catalog
For beginners

Lists the G-Rebels actions JoyPro knows: the six axis roles of a joystick tab (Yaw, Thrust, Roll, Pitch, Side strafe, Up / down) and the button actions JoyPro knows (Primary Fire).

engine grebels catalog --text
Advanced
  • No options; read-only, also when the game is not installed.
  • The list is JoyPro's own table, not read from the game. It is saved on the first scan, import, export or engine grebels refresh-db; before that the command lists no action and warns G-Rebels 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> (categories Axis roles and Buttons). Exit code 0.
  • File: %LOCALAPPDATA%\JoyPro2\GameData\DB\GRebels\actions.tsv (fifth column: the role number, role:0 to role:5, or the game's mapping name of a button).
  • Related: engine grebels refresh-db; game page g-rebels.

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

#engine grebels scan

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

Shows the axis roles and button binds G-Rebels has for your connected devices, without changing your profile or the game. Look first in the import wizard runs it.

engine grebels scan --text
Advanced
  • Reads what engine grebels import reads: the devices switched on in the game with their channels and the axis rows (role, invert) of SaveOptions.sav, and the button binds <ACTION>JST<channel> of EnhancedInputUserSettings.sav in the same folder. A path (positional or --path) names another SaveOptions.sav.
  • A channel belongs to your device through the device's HID path; a channel whose device is not connected is skipped with a warning.
  • --ignore-device <name> / --ignore-devices <a;b> leave the binds of those devices out (a name without {GUID} means every device of that name).
  • Safety: reads only, also while the game runs; a fresh install first saves JoyPro's table of the game. Refused when the game is not installed or switched off in Settings > Games.
Technical internals
  • Output: JSON (Game, Action scan, ConfigPath, BindingsRead, Bindings, Steps, Warnings, Errors), or a text report with --text.
  • Exit code 0; 1 on an error (No G-Rebels config file found. Pass the path explicitly., an unreadable save file). Unknown options fail with Unknown GRebels scan argument(s): ....
  • Related: engine grebels import, engine grebels catalog; game page g-rebels.

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

Example

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

written
engine grebels 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 G-Rebels' controls into your JoyPro profile: the axis role of every axis of each channel (pitch, roll, yaw, thrust, side strafe, up / down) with invert, and the button binds JoyPro knows. Nothing in the game changes. The GUI runs it with Import on the G-Rebels card of the Start page.

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

It reads %LOCALAPPDATA%\G_Rebels\Saved\SaveGames\SaveOptions.sav (devices with their channels, the axis rows) and EnhancedInputUserSettings.sav in the same folder (the button binds).

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the game has.
  • No keyboard or modifier binds; --include-keyboard changes nothing.
  • A channel maps to your device through the device's HID path in the save file.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from G-Rebels" 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 G-Rebels config file found. Pass the path explicitly.).
  • Without a path it reads the file engine grebels paths lists first; the command list is JoyPro's own table of the game's roles and buttons.
  • With --profile the profile is saved afterwards; a game JoyPro never exported to is watched from now on.
  • Related: engine grebels scan, engine grebels export; game page g-rebels.

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

Example

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

written
engine grebels 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

Sets the axis roles and button binds on the channels of your devices in G-Rebels. It never adds a channel or a device: switch each device on once in the game. Close the game first. The GUI's Export now on the G-Rebels card runs it.

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

One role per axis and one key per action and channel; the same rules hold for roles and buttons.

--mode In the save files
add a role goes only onto an axis without one; an axis with another role gets a mark "Not written to the game"
merge the profile's role goes onto its axis (the role there goes); the role stays on its other axes; a button replaces another action's mapping on the key
merge-overwrite (engine default) as merge, and the role's other axes on connected channels get NONE
clean (GUI default) every other role of a written channel becomes NONE
  • --nuke-untouched-devices: the same on the enabled, connected channels JoyPro does not write (not with add).
  • Invert is written with the role; hats, dead zone and sensitivity are not written. Axis rows the game has not saved yet are not added: change one role on the device's JST tab in the game first.
  • A device without a channel is skipped ("switch it on in OPTIONS > INPUT > DEVICES").
  • Never touched: keyboard, gamepad, mouse, the game's other options, channels of devices that are not connected, the game's device list, --ignore-device(s), the --vjoy-tunnel device.
  • Safety: refused while G_Rebels-Win64-Shipping or G_Rebels runs; both save files backed up first (undo: engine backups list); the profile is kept as "Before export to G-Rebels". --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 grebels export --mode clean
engine grebels export --mode add
engine grebels export --mode merge
engine grebels export --mode merge-overwrite

In the game Writes into G-Rebels'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: %LOCALAPPDATA%\G_Rebels\Saved\SaveGames\SaveOptions.sav (GVAS, axis roles in place) + EnhancedInputUserSettings.sav (buttons). G-Rebels details · what each mode changes

Example

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

#engine grebels refresh-db

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

JoyPro's own list of the G-Rebels actions: nothing is read from the game, which need not be installed; writes it only when it changes

For beginners

Writes JoyPro's own G-Rebels table (the six axis roles and the known button actions) as the game's command list. The game's files are not read. Update on the G-Rebels card of the Start page runs it.

engine grebels refresh-db --text
Advanced
  • Rows the list already has stay as they are; only rows of JoyPro's table that are missing are added (a step line counts them: JoyPro's own G-Rebels table: <n> new action(s); the game's input assets are not read.).
  • A path (positional or --path) is accepted and not used.
  • --dry-run writes nothing. Otherwise the list is written only when it changed.
  • Works also when G-Rebels is not installed or switched off in Settings > Games, since nothing of the game is read.
Technical internals
  • Output: JSON of the refresh (DryRun, FilesWritten, Steps with Actions: <old> -> <new>, Warnings, Errors), or a text report with --text; The catalog already has every action the source lists; nothing was written. when nothing changed. Exit code 0.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\GRebels\actions.tsv and records the game's Steam build for engine db check-updates.
  • Related: engine grebels catalog, engine grebels export; game page g-rebels.

What it does JoyPro's own list of the G-Rebels actions: nothing is read from the game, which need not be installed; 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 grebels refresh-db --text