JoyPro2 Discord GitHub
Engine (CLI)

engine starcitizen (Star Citizen)

Show:

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

#engine starcitizen scan

written
engine starcitizen scan [<sc-root-or-profile-path>] [--path <path>] [--source <path>] [--device <name>] [--devices <csv>] [--ignore-device <name>] [--ignore-devices <csv>] [--include-keyboard true|false] [--confirm true|false]
For beginners

Shows what engine starcitizen import would bring from Star Citizen with the same options, without changing the profile or the game. On the Start page Look first in the import wizard and Scan in the expert import run it.

engine starcitizen scan "D:\Games\StarCitizen\LIVE" --include-keyboard false --text
Advanced
  • The path is a Star Citizen installation, branch or profile folder (positional or --path); without one the profile folder (else the installation) is detected. --source <path> names a folder or actionmaps.xml that is read first.
  • --device(s), --ignore-device(s), --include-keyboard and --confirm work as in engine starcitizen import.
  • Reads only. Without JoyPro's Star Citizen command list it is built from the installed game first. Refused when Star Citizen is not installed.
Technical internals
  • Output: JSON of the scan, or a text report with --text. Exit code 0; 1 with starcitizen scan failed: ....
  • Export options (--mode, --keep-keyboard-defaults, --prefer-local-order, --nuke-untouched-devices) and save options are refused here.

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<path>Optional explicit path override. Use when you prefer option form over positional path.
--source<path>
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--devices<csv>Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle.
--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.
--include-keyboardtrue false
--confirmtrue falseControls suggestion confirmation (true) vs auto-accept (false).
Every value as a command line
engine starcitizen scan --include-keyboard true
engine starcitizen scan --include-keyboard false
engine starcitizen scan --confirm true
engine starcitizen scan --confirm false

In the game Reads Star Citizen's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. Star Citizen details · what each mode changes

Used by the GUI Start: Look first · Start: Scan

Example

engine starcitizen scan --text

#engine starcitizen import

written
engine starcitizen import [<sc-root-or-profile-path>] [--path <path>] [--source <path>] [--merge] [--save-profile <path.pr0file>] [--save-last] [--device <name>] [--devices <csv>] [--ignore-device <name>] [--ignore-devices <csv>] [--include-keyboard true|false] [--confirm true|false]
For beginners

Reads your Star Citizen ship binds from actionmaps.xml into your JoyPro profile. Nothing in the game changes. Import now in the Start page's import wizard and Import in the expert import run it.

engine starcitizen import "D:\Games\StarCitizen\LIVE" --merge --include-keyboard false --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced

Reads the profile folder's actionmaps.xml and JoyPro's actionmaps.jp (relation names of an earlier export).

  • The game's default joystick binds that are active on js1 (no rebind of the action) come in as binds of the js1 device, so the profile holds what the game does.
  • Axis settings: each joystick axis rebind gets the values the game uses (its option group on its slot, the device options); different values become the relation's Star Citizen tuning.
  • --merge adds to the open profile; without it the import replaces the profile's relations and binds.
  • --include-keyboard true|false (default false) also reads keyboard binds.
  • --device(s) / --ignore-device(s) limit the devices (the --vjoy-tunnel device is always left out); names are resolved to the closest device, --confirm false takes the suggestion without asking.
  • --source <path> is read before the path.
  • Safety: reads only; refused when Star Citizen is not installed; the profile is kept as the version "Before import from Star Citizen" first. Without a command list JoyPro builds it from the installed game first.
Technical internals

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<path>Optional explicit path override. Use when you prefer option form over positional path.
--source<path>
--mergeswitch (no value)Merge import results into existing in-memory profile.
--save-profile<path.pr0file>After import, save profile to this .pr0file path.
--save-lastswitch (no value)After import, save to last profile path.
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--devices<csv>Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle.
--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.
--include-keyboardtrue false
--confirmtrue falseControls suggestion confirmation (true) vs auto-accept (false).
Every value as a command line
engine starcitizen import --include-keyboard true
engine starcitizen import --include-keyboard false
engine starcitizen import --confirm true
engine starcitizen import --confirm false

In the game Reads Star Citizen'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. Star Citizen details · what each mode changes

Used by the GUI Start: Import now · Start: Import

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' starcitizen import --text

#engine starcitizen export

written
engine starcitizen export [<sc-root-or-profile-path>] [--path <path>] [--source <path>] [--mode clean|add|merge|merge-overwrite] [--keep-keyboard-defaults true|false] [--prefer-local-order true|false] [--include-keyboard true|false] [--nuke-untouched-devices true|false] [--ignore-device <name>] [--ignore-devices <csv>]

--ignore-device(s) and --vjoy-tunnel devices are never cleared; stale duplicate joystick slots of a connected device are removed and their rebinds moved to the slot it keeps; add never changes a game bind and skips a bind whose input another ship action uses; merge and merge-overwrite put the profile's input into the action's slot and release the game's bind on an input the profile gives another ship action; clean releases the ship binds of the written devices, nuke those of the connected devices the profile does not use; both switch off the game's default joystick binds on js1 when js1 is written (clean) or unused (nuke) and its device is connected

For beginners

Writes your profile's ship binds into Star Citizen. Use it after you changed binds in JoyPro; close the game first. The Export page's Export now on the Star Citizen card runs it.

engine starcitizen export "C:\Program Files\Roberts Space Industries\StarCitizen\LIVE" --mode clean --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

Writes the ship actions into actionmaps.xml of the branch (LIVE, PTU ...) with JoyPro's actionmaps.jp.

  • --mode: add never changes a game bind and skips a bind whose input another ship action uses; merge and merge-overwrite put the profile's input into the action's slot and release the game's bind on an input the profile gives another ship action; clean releases the ship binds of the written devices.
  • --nuke-untouched-devices true releases those of the connected devices the profile does not use.
  • Clean and nuke release only cataloged ship actions, and switch off the game's own joystick defaults on js1 when js1 is written (clean) or unused (nuke) and connected.
  • Stale duplicate joystick slots of a connected device are removed and their binds moved to the slot it keeps.
  • Never touched: on-foot, vehicle and menu binds stay byte for byte; devices passed with --ignore-device(s) and the --vjoy-tunnel device are never cleared.
  • Safety: refused while Star Citizen runs; backed up first; the profile is kept as the version "Before export to Star Citizen".
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<path>Optional explicit path override. Use when you prefer option form over positional path.
--source<path>
--modeclean add merge merge-overwriteExport mode for DCS/IL2 export commands: clean, add, merge, merge-overwrite.
--keep-keyboard-defaultstrue falseDCS export only: keep existing keyboard defaults/keyboard diff files untouched (true/false).
--prefer-local-ordertrue false
--include-keyboardtrue false
--nuke-untouched-devicestrue falseDCS 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 starcitizen export --mode clean
engine starcitizen export --mode add
engine starcitizen export --mode merge
engine starcitizen export --mode merge-overwrite
engine starcitizen export --keep-keyboard-defaults true
engine starcitizen export --keep-keyboard-defaults false
engine starcitizen export --prefer-local-order true
engine starcitizen export --prefer-local-order false
engine starcitizen export --include-keyboard true
engine starcitizen export --include-keyboard false
engine starcitizen export --nuke-untouched-devices true
engine starcitizen export --nuke-untouched-devices false

In the game Writes into Star Citizen's control files while the game is closed (refused while it runs), after a backup. Space sims: clean and nuke touch only the cataloged ship actions, on-foot and vehicle binds stay. Bind file: LIVE\user\client\0\Profiles\default\actionmaps.xml + attributes.xml (XML). Star Citizen details · what each mode changes

Used by the GUI Start: Export · Export: Preview · Export: Export now · Export: Export Star Citizen

Example

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

#engine starcitizen list-devices

written
engine starcitizen list-devices [<sc-root-or-profile-path>] [--path <path>] [--source <path>]

Aliases: devices, list

For beginners

Lists the devices Star Citizen's actionmaps.xml has joystick slots for, plus the keyboard and the gamepad. The GUI's Refresh Star Citizen in the Start page's expert import runs it to fill the device choices.

engine starcitizen list-devices "D:\Games\StarCitizen\LIVE" --text
Advanced
  • Path, --path and --source as in engine starcitizen scan; aliases starcitizen devices and starcitizen list.
  • Each slot's product name is resolved to the device name JoyPro uses; Keyboard is always listed, the gamepad as its product or Controller (Gamepad).
  • Read-only; works also when Star Citizen is not detected as installed. Device filters are refused here.
Technical internals

What it does Aliases: devices, list.

OptionValuesMeaning
--path<path>Optional explicit path override. Use when you prefer option form over positional path.
--source<path>

Used by the GUI Start: Refresh Star Citizen

Example

engine starcitizen list-devices --text

#engine starcitizen labels

written
engine starcitizen labels [--path <install>] [--dry-run]

The game's names of the controls, from global.ini in Data.p4k

For beginners

Reads Star Citizen's own names of its controls ("Pitch" for v_pitch) from the installed game, so JoyPro shows them instead of a readable form of the id. engine db refresh-starcitizen runs it after each refresh. Close the game first.

engine starcitizen labels --text
Advanced
  • It takes the text keys JoyPro's Star Citizen command list names (AllBinds.xml) and their English texts from Data\Localization\english\global.ini inside the game's Data.p4k. Only those keys are kept, in one line each, without the game's colour markup.
  • --path <install>: the game folder (Data.p4k there, in LIVE, in StarCitizen\LIVE or in another subfolder); without it the detected installation is used.
  • --dry-run reads everything and writes nothing.
  • Safety: reads the game's files only, and only while Star Citizen is closed.
Technical internals
  • Output: JSON (Archive, File, Keys, Labels, Warnings, Error), or with --text one line Star Citizen labels: <n> of <m> text keys named (<archive>) -> <file>.
  • Exit code 0; 1 with JoyPro has no Star Citizen command list yet (engine db refresh-starcitizen)., Data.p4k of Star Citizen was not found ..., Star Citizen is running (...): close it first; JoyPro reads its files only while it is closed., global.ini could not be read from ..., or the usage line for another argument.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\StarCitizen\labels.tsv (key<TAB>text, with a header line that has the date); reading the archive uses %LOCALAPPDATA%\JoyPro2\Cache\StarCitizen.
  • Related: engine db refresh-starcitizen, engine starcitizen scan, engine starcitizen import; game page starcitizen.

What it does The game's own names of the controls, read from global.ini in Data.p4k; --dry-run reads and reports only.

OptionValuesMeaning
--path<install>Optional explicit path override. Use when you prefer option form over positional path.
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.

Example

engine starcitizen labels --text