JoyPro2 Discord GitHub
Engine (CLI)

engine arrange

Show:

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

#engine arrange ask

written
engine arrange ask "<your preferences in words>" [--llm auto|on|off] [--games <g1,g2>] [--add-missing] [--forget-saved] [--proposal <file>] [--role ...] [--grip ...] [--add-device ...]
For beginners

Lay out with AI, step one: you say in words how you like your controls ("throttle and left-hand stick, trim on the hat, curves softer for helis") and JoyPro prepares every change to binds, axis curves, force feedback and the virtual joystick as a preview file. Phrase rules read the words; the optional local AI model only helps with sentences they do not understand. Binds > Lay out with AI... > Preview runs it. It changes nothing.

engine arrange ask "throttle and left-hand stick, trim on the hat, curves softer for helis" --llm off --proposal "C:\Users\Pilot\Documents\JoyPro\layout.json" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • The words: every argument that is not an option. Without words the preferences kept in the profile are used.
  • --llm auto (default) or on: the local model rewrites the clauses the rules did not understand into phrases they know (only when there are such clauses); off: never.
  • --games <g1,g2>: default the games of your relations that have a function catalog.
  • --add-missing also makes relations for functions you do not have yet; --forget-saved ignores the kept preferences.
  • --proposal <file>: where the preview is written (default %TEMP%\JoyPro2\layout-ai\proposal.json).
  • The device options of engine setup devices: --role, --grip, --add-device.
  • Only relations a preference concerns, relations on a device whose role changed, and unbound relations move; the rules of Auto Assign hold.
Technical internals
  • Output: the preview as JSON (understood preferences, not understood clauses, the changes with their ids and before / after values, warnings), or --text; the same preview goes to the proposal file. The profile is not saved.
  • Exit code 1 with arrange ask needs your preferences in words, ... (no words and no kept preferences), Invalid --llm value: ... or a device option message.
  • Reference: layout-with-ai. Related: engine arrange apply, engine arrange prefs.

What it does Lay out with AI: turns your preferences in words into the preferences JoyPro understood and every change of binds, axis curves, force feedback and the virtual joystick, as a preview (nothing is saved).

OptionValuesMeaning
--llmauto on off
--games<g1,g2>Game filter values as CSV. Example: DCS,IL2Game,StarCitizen.
--add-missingswitch (no value)
--forget-savedswitch (no value)
--proposal<file>
--roleswitch (no value)
--gripswitch (no value)
--add-deviceswitch (no value)
Every value as a command line
engine arrange ask --llm auto
engine arrange ask --llm on
engine arrange ask --llm off

Used by the GUI Binds: Preview

Example

engine arrange ask "<your preferences in words>" --text

#engine arrange apply

written
engine arrange apply --proposal <file> [--skip <change id>]... [--dry-run]

Applies the preview in one history version; keeps the preferences in the profile

For beginners

Lay out with AI, step two: applies the preview file of arrange ask in one step and keeps your preferences in the profile for next time. Binds > Lay out with AI... > Apply runs it with the changes you unticked as --skip; Undo takes it back.

engine arrange apply --proposal "C:\Users\Pilot\Documents\JoyPro\layout.json" --skip "vjoy:StarCitizen" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • --proposal <file> (needed): the file engine arrange ask wrote.
  • --skip <change id> (repeatable): bind:<relation>, split:<relation>, tuning:<relation>|<scope>, ffb:<device>|<scope>, vjoy:<game>. Skipping a split also skips the new relation's bind.
  • Refused when the layout puts functions of the same aircraft on one input.
  • --dry-run counts without a change. Otherwise one profile version "Lay out with AI: N binds, ..." (one undo step).
Technical internals
  • Output: JSON of the result, or --text (Binds Set:, Relations Created:, Relations Split:, Axis Curves Set:, Force Feedback Set:, Virtual Joystick Set:, skipped items and warnings). The profile is saved with --profile unless --dry-run.
  • Exit code 1 with arrange apply needs --proposal <proposal.json> (from engine arrange ask)., The preview could not be read: ..., That file is no preview of engine arrange ask. or The layout puts functions of the same aircraft on one input: ....
  • Related: engine arrange prefs, engine profile history restore.

What it does Applies the preview in one history version; keeps the preferences in the profile.

OptionValuesMeaning
--proposal<file>
--skip<change id>
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.

Used by the GUI Binds: Apply

Example

engine arrange apply --proposal <file> --text

#engine arrange prefs

written
engine arrange prefs [show | clear | remove <key>]

The layout preferences kept in the profile

For beginners

Shows the layout preferences Lay out with AI keeps in the profile, or forgets one or all of them. When the Lay out with AI panel opens, the GUI reads them; the cross on a preference and Forget all run remove and clear.

engine arrange prefs show --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • show (default): the kept preferences with their keys.
  • remove <key>: forgets one; clear: forgets all. Each is one profile version (one undo step).
  • Forgetting changes no bind; the next engine arrange ask simply does not use it.
Technical internals
  • Output: JSON (the preferences), or --text (Saved preferences: <n> and - <description> | <key> lines). The profile is saved with --profile after remove or clear.
  • Exit code 1 with arrange prefs remove <key>, No saved preference with the key ... or arrange prefs [show | clear | remove <key>].

What it does The layout preferences kept in the profile.

Used by the GUI Binds: Lay out with AI... · Binds: Forget all · Binds: Forget

Example

engine arrange prefs [show --text