60 commands of engine relations. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.
#engine relations list
writtenengine relations list [filter] [--titles]
--titles: each relation with the titles of its actions
For beginners
Lists the relations of the profile, one line each with its type, bind, modifiers, games, aircraft count and groups.
Add a word to show only the relations that contain it. The GUI's Relations page loads its list with it, and Refresh
relations there reads it again. It changes nothing.
engine relations list Gear --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
[filter]: all words after list form one text. A relation is listed when the text is part of (case ignored) its
name, a group, its bind (device, input, device::input, alias, modifiers) or one of its actions (game, id or
aircraft).
--titles adds to each relation the titles of its actions (JSON field; the GUI uses it for the relation search and
runs relations list --titles).
- The relations come sorted by name. Read-only: neither the profile nor a game changes.
Technical internals
- Output: JSON (the relations document with every relation, its actions, aircraft and bind), or
--text: Relations: <n> and one line per relation name | type=axis|button | bind=<device>::<input> | mods=<n> | games=... | planes=<n> | groups=.... --out <file> writes it to a file.
- Exit code
0; the filter never fails, it only lists fewer relations.
- Related:
engine relations show (one relation in detail), engine relations search (actions of the games, not of the
profile), engine relations group list.
What it does Lists relations (logical actions) in the profile.
| Option | Values | Meaning |
|---|
--titles | switch (no value) | |
Used by the GUI Relations: AddTickedMissingReviewCommand · Profile bar: Reload · Profile bar: Merge · Profile bar: Take them out · Relations: Run Mass Operation · Relations: Add · Relations: Remove Selected · Relations: Remove All · Relations: Rename · Relations: Refresh relations · Relations: Merge Profile · Relations: Apply selected
Example
engine relations list 'Gear' --text
#engine relations show
writtenengine relations show <relation-name>
For beginners
Shows one relation in detail: type, groups, games, its bind with modifiers and axis settings, and every action with its
aircraft. Show selected in output on the Relations page prints it into the Output panel, and the GUI reads it
whenever it opens a relation. It changes nothing.
engine relations show "Gear Toggle" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The name may be the exact name (case ignored) or a part of it that only one relation has. Several matches are
refused with the list of names.
- The actions carry the titles the profile stored for them (per aircraft).
- Read-only.
Technical internals
- Output: JSON of the relation, or
--text (Relation:, Type:, Groups:, Games:, Planes Covered:, Bind:,
Bind Reformers:, inversion, slider, curve, dead zone and saturation, then Nodes: <n> with each action).
- Exit code
1 with relations show requires a relation name., No relation matched query: ... or Ambiguous relation query '...'. Matches: ....
- The commands that change one relation (
engine relations group add, engine relations item remove,
engine relations item move) answer with this same view of the changed relation.
What it does Shows one relation in detail.
Used by the GUI Profile bar: Take them out · Relations: Show selected in output · Relations: OnlyWhereSameMeaningCommand · Relations: Switch them all off · Relations: OpenAircraftCheckRelationCommand · Relations: PasteRelationNodesCommand · Relations: Remove · Relations: Move to the top · Relations: Move to the bottom · Relations: RemoveNodeCommand · Relations: Apply · Relations: OpenOtherRelationsTagCommand
Example
engine relations show 'Gear Toggle' --text
#engine relations add
writtenengine relations add <name> [--axis|--button|--type axis|button] [--node game:id[:plane1|plane2]] [--from relation] [--group g] [--device d --input i --modifier m]
For beginners
Creates a new relation: one button or axis of yours with the actions it shall do in your games. The Relations page
uses it when you create a relation.
engine relations add "Gear" --button --node "DCS:gear_up_down:F-16C_50|FA-18C_hornet" --group "Systems" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
--node Game:Id:Plane1|Plane2 per action (DCS: the aircraft; other games: the game id once); --id with --game
and --planes is the same for one action.
--from <relation> takes the actions of an existing relation.
--axis, --button or --type axis|button sets the kind; without them it comes from --from or the actions.
Axes and buttons in one relation are refused.
--group <g> puts it into a group; --device, --input and --modifier bind it right away.
- One undo step.
What it does Creates a relation with node targets and optional bind/group data.
| Option | Values | Meaning |
|---|
--axis | switch (no value) | Set relation type to axis (explicit override). |
--button | switch (no value) | Set relation type to button (explicit override). |
--type | axis button | Set relation type via value token (`axis` or `button`). |
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--from | switch (no value) | Copy structure from existing relation(s). |
--group | switch (no value) | Attach relation group tag. Example: --group Startup. |
--device | switch (no value) | Include one device per flag. Example: --device LEFT VPC Throttle. |
--input | switch (no value) | Input token. Example: --input JOY_BTN1 or --input joy0_b0. |
--modifier | switch (no value) | Modifier key token. Example: --modifier LShift. |
Every value as a command line
engine relations add --type axis
engine relations add --type button
Used by the GUI Relations: AddCheckedCatalogCommand · Relations: AddCheckedBuilderResultsCommand
Example
engine relations add 'Gear Toggle' --node DCS:d3007pnilu3007cd16vd1vpnilvu0 --group 'Startup' --text
engine relations add 'Pitch Axis' --type axis --node IL2Game:mc_pitch --text
How the options interact
- You need at least one source: --node, --id/--game, or --from.
- Type is inferred from source relation (--from) or node IDs when possible.
- Use --axis / --button / --type only when you want an explicit override.
#engine relations group list
writtenengine relations group list [relation-name]
For beginners
Lists the groups of one relation, or every group of the profile with the relations that use it. Groups only sort and
filter your relations in JoyPro; no game sees them. On the Relations page, List Groups (Selected or All) under
Groups prints it into the Output panel.
engine relations group list --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- With a relation name (exact, or a part only one relation has): that relation's groups, sorted, each once.
- Without: every group (case ignored) with its relations and their count.
- More than one name is refused. Read-only.
What it does Lists groups on one relation, or all groups across all relations.
Used by the GUI Relations: List Groups (Selected or All)
Example
engine relations group list --text
engine relations group list 'Gear Toggle' --text
How the options interact
- Without a relation name, lists all groups and where they are used.
#engine relations group add
writtenengine relations group add <relation-name> <group1> [group2] [...]
For beginners
Adds one or more groups to a relation, for example "Startup" or "Carrier". Use it to sort and filter relations; nothing
changes in any game. On the Relations page, type the groups (comma-separated) under Groups and press Add.
engine relations group add "Gear Toggle" Startup Carrier --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
- Each word after the relation name is a group; a word may also hold several groups separated by
, or ;.
- A group the relation has already (case ignored) is not added twice.
- Options starting with
-- are refused here. One profile version (one undo step).
What it does Adds group tags to a relation.
Used by the GUI Relations: Add
Example
engine relations group add 'Gear Toggle' 'Startup' 'Common' --text
#engine relations group remove
writtenengine relations group remove <relation-name> <group1> [group2] [...] [--all]
For beginners
Takes groups off a relation, or all of them with --all. The relation, its actions and its bind stay. On the
Relations page, Remove Selected under Groups removes the picked groups and Remove All every group of the open
relation.
engine relations group remove "Gear Toggle" Startup --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
- Groups are matched with case ignored;
, and ; separate several in one word.
--all clears every group of the relation.
- A group the relation does not have is ignored. One profile version (one undo step).
What it does Removes group tags from a relation.
| Option | Values | Meaning |
|---|
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Used by the GUI Relations: Remove Selected · Relations: Remove All
Example
engine relations group remove 'Gear Toggle' 'Startup' --text
engine relations group remove 'Gear Toggle' --all --text
How the options interact
- Use --all to clear all values instead of specifying individual names.
#engine relations group rename
writtenengine relations group rename <old-group> <new-group>
For beginners
Renames a group in every relation that has it, for example "Startup" to "Cold Start". On the Relations page, Rename
under Groups runs it with the old and the new name.
engine relations group rename Startup "Cold Start" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Exactly two names: the old group (case ignored) and the new one. Both must be non-empty and differ.
- A relation that has the new group already keeps it once.
- One profile version (one undo step) for all relations.
Technical internals
- Output: JSON (
OldName, NewName, UpdatedRelations, UpdatedCount), or --text; the profile is saved with
--profile.
- Exit code
1 with relations group rename requires: <old-group> <new-group>., relations group rename requires different old/new names. or Group not found: <name>.
- Related:
engine relations group list.
What it does Renames a group across all relations that currently use it.
Used by the GUI Relations: Rename
Example
engine relations group rename 'Startup' 'Core Startup' --text
How the options interact
- Renames group usage across all relations that contain the old name.
#engine relations item add
writtenengine relations item add <relation-name> --node game:id[:plane1|plane2] [--node ...] [--force] (or --id/--game/--planes; an action its game's list does not have, or an axis in a button relation or the other way round, is refused unless --force)
For beginners
Puts one or more game actions into an existing relation, so they go on the relation's button or axis with the next
export. Use it to give a bind more games or aircraft, for example the F-16's gear handle next to the F/A-18's.
engine relations item add "Gear Toggle" --node "DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id[:plane1|plane2], repeatable: the game (empty = DCS), the action id and the aircraft (|, , or ;
between them). An action the relation has already gets the named aircraft switched on.
--id <id> with --game <game> (default DCS) and --planes <list> is the same as one --node.
- DCS without aircraft: the aircraft where the id has its most common meaning are switched on; aircraft where the same
id means something else are left out (a note on the error stream says how many). Other games without aircraft: the
action is for the whole game (
Default stands for the game too).
- MSFS 2024: an action the command list has only for some aircraft (an add-on's own) comes in for those aircraft
alone unless the node names aircraft.
- The action must fit: an id its game's command list does not have (checked when JoyPro has that list) and an axis in
a button relation or a button in an axis relation are refused, nothing is added.
--force adds it anyway (the
suggestions then flag it under "Looks wrong").
- One profile version (one undo step). The game files change only with the next export.
Technical internals
- Output: the changed relation as
engine relations show prints it; the profile is saved with --profile.
- Exit code
1 with relations item add requires at least one target via --node or --id., Invalid --node value '...'. Use --node <game:id[:plane1|plane2]>., Unknown relations item argument(s): ..., <game>:<id> is not an action of <game>'s command list ..., <game>:<id> is a button; '<relation>' is an axis relation. (or the other way
round; both end with Nothing was added (--force adds it anyway).), No relation items were changed. or the name
messages.
- Related:
engine relations item remove, engine relations item enable, engine relations suggest apply (adds with a
kind check), engine relations search (find the id).
What it does Adds actions (node targets) to an existing relation. An action its game's list does not have, or an axis in a button relation (or the other way round), is refused unless --force.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--force | switch (no value) | Add the actions even when their game's list does not have them or they are of the other kind (axis / button) than the relation. |
--id | switch (no value) | Node ID. Example: --id d3007pnilu3007cd16vd1vpnilvu0. |
--game | switch (no value) | Game filter value. Example: DCS or IL2Game. |
--planes | switch (no value) | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
Example
engine relations item add 'Gear Toggle' --id d3007pnilu3007cd16vd1vpnilvu0 --game DCS --planes F-16C_50 --text
How the options interact
- At least one target (--node or --id) is required.
#engine relations item remove
writtenengine relations item remove <relation-name> --node game:id[:plane1|plane2] [--node ...] [--all]
For beginners
Takes an action out of a relation, or only some of its aircraft. Use it when an action does not belong to the
relation's button. Remove from the relation on an action card of the Relations page runs it (with the card's
switched-on aircraft). In the game: after the next export the action is no longer written on that relation's button.
engine relations item remove "Gear Toggle" --node "DCS:d68pnilunilcdnilvdnilvpnilvunil:F-16C_50" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
--node game:id[:plane1|plane2], repeatable. Without aircraft the whole action leaves the relation; with aircraft
only those leave it, and the action goes once no aircraft is left.
--id <id> with --game <game> (default DCS) and --planes <list> is the same as one --node.
--all takes every action out; the relation stays, empty, with its bind.
- An old game id of a game split into versions (MSFS, X-Plane) matches the actions of every version.
- One profile version (one undo step).
What it does Removes node targets from an existing relation.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Used by the GUI Relations: Remove · Relations: RemoveNodeCommand
Example
engine relations item remove 'Gear Toggle' --id d3007pnilu3007cd16vd1vpnilvu0 --game DCS --text
How the options interact
- Use target selectors or --all.
#engine relations item enable
writtenengine relations item enable <relation-name> --node game:id[:plane1|plane2] [--node ...]
For beginners
Switches aircraft of an action in a relation on again. The action stays in the relation either way; switched-off
aircraft simply do not get it on the relation's button at the next export.
engine relations item enable "Gear Toggle" --node "DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id[:plane1|plane2] (repeatable) or --id <id> --game <game> --planes <list>; at least one is needed.
- With aircraft: exactly those are switched on, also aircraft the action did not list yet. Without aircraft: every
aircraft the action lists.
- Games without aircraft keep the action under the game's name;
Default in the spec means the same.
- An old game id of a game split into versions (MSFS, X-Plane) matches the actions of every version.
- One profile version (one undo step). Nothing changes in the game until the next export.
What it does Enables selected node targets on a relation.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
Example
engine relations item enable 'Gear Toggle' --node DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50 --text
How the options interact
- At least one target (--node or --id) is required.
#engine relations item disable
writtenengine relations item disable <relation-name> --node game:id[:plane1|plane2] [--node ...]
For beginners
Switches aircraft of an action in a relation off without removing it, for example where the same DCS id does
something else. The aircraft stay listed, so suggestions do not bring them back.
engine relations item disable "Gear Toggle" --node "DCS:d3007pnilu3007cd16vd1vpnilvu0:Mi-24P" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id[:plane1|plane2] (repeatable) or --id <id> --game <game> --planes <list>; at least one is needed.
- With aircraft: those are switched off (an aircraft the action did not list is added as off). Without aircraft:
every aircraft of the action, so the action no longer reaches any game.
- One profile version (one undo step). In the game: at the next export the switched-off aircraft do not get this
action on the relation's input.
What it does Disables selected node targets on a relation.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
Example
engine relations item disable 'Gear Toggle' --node DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50 --text
How the options interact
- At least one target (--node or --id) is required.
#engine relations item move
writtenengine relations item move <relation-name> --node game:id (--to <position> | --up | --down) (the order of its actions)
For beginners
Changes the order of the actions inside a relation. The order decides which action a game gets first when two actions
of one game share the bind. Move up (Alt+Up), Move down (Alt+Down), Move to the top and Move to the
bottom in an action card's menu on the Relations page run it.
engine relations item move "Gear Toggle" --node "DCS:d68pnilunilcdnilvdnilvpnilvunil" --to 1 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
--node game:id names the action (aircraft in the spec are ignored; the first matching action moves).
- Exactly one of
--to <position> (1 = first, as engine relations show numbers them; a larger number means last),
--up or --down.
- An action already in place changes nothing and writes no profile version. Otherwise one version (one undo step).
Technical internals
- Output: the relation as
engine relations show prints it; the profile is saved with --profile when the order
changed.
- Exit code
1 with relations item move needs one of --to <position>, --up and --down., Not in '<relation>': game:id or --to takes a position from 1 (the first action) to <n>.
What it does Moves one action of a relation to another place in its list (--to <position> from 1, --up or --down).
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--to | <position> | The target: the new position (relations item move), the file or folder to write (telemetry export), the folder to unpack into (support unpack). Example: C:\Cases\case1. |
--up | switch (no value) | |
--down | switch (no value) | |
Used by the GUI Relations: Move up · Relations: Move down · Relations: Move to the top · Relations: Move to the bottom
Example
engine relations item move <relation-name> --node game:id (--to <position> --text
#engine relations item move-to-input
writtenengine relations item move-to-input <relation-name> --node game:id[:plane1|plane2] --device <device> --input <input> [--modifier <name>]... [--keep-modifiers] [--name <new relation>] [--if-taken ask|swap|replace|keep-both] [--dry-run] (one action to another button: joins the relation on that input, else a new one; --if-taken: when the aircraft has another action there)
For beginners
Moves one action to another button or axis while the rest of the relation stays where it is. JoyPro puts it into the
relation that already uses the new input, or makes a new relation there named after the action. Move to another
button... on an action card or a bind opens the GUI's panel; its preview and Move run this command.
engine relations item move-to-input "Master Caution" --node "DCS:d3001pnilu3001cd12vd1vpnilvu0:F-16C_50" --device "Throttle - HOTAS Warthog" --input JOY_BTN22 --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id[:planes] (exactly one): the action. DCS: only the named aircraft move (all switched-on aircraft
without a list); other games: the whole action.
--device and --input (both needed): the new place. The device is written the way the profile spells it.
--modifier <name> (repeatable) puts it behind modifiers; --keep-modifiers keeps the modifiers of the old bind.
--name <relation>: the name of a new relation (default: the action's title; (2), (3) ... when taken).
--if-taken: what happens when a relation on that input already has another action of the game for these aircraft
(one aircraft has one action per relation):
| Value |
Result |
ask (default) |
nothing changes; the command fails with the choices (with --dry-run it reports them) |
swap |
the action that is there goes to the old relation of the moved one |
replace |
the action that is there leaves the input and is not bound any more |
keep-both |
the moved action gets a relation of its own on the same input; both fire together |
- A new relation copies the old bind's settings (an axis keeps its tuning) and groups. A relation left without actions
is removed with its bind.
--dry-run only reports where it would go. Otherwise one profile version (one undo step).
Technical internals
- Output: JSON (
Action, From, To, Joined, Created, FromRemoved, Taken, TakenRelation, Displaced,
BothFire, Message ...), or --text (the message, From:, To: ... (joined|new)).
- Exit code
1 with relations item move-to-input needs exactly one --node ..., ... needs --device <device> and --input <button or axis>., --if-taken takes ask, swap, replace or keep-both., Relation '...' does not hold game:id., '...' is on <device> <input> already. or the taken-input message of ask.
- Related:
engine relations item remove, engine relations show.
What it does Moves one action to another button: it joins the relation on that input, else a new relation; --if-taken decides when the aircraft has another action there; --dry-run previews.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--device | <device> | Include one device per flag. Example: --device LEFT VPC Throttle. |
--input | <input> | Input token. Example: --input JOY_BTN1 or --input joy0_b0. |
--modifier | <name> | Modifier key token. Example: --modifier LShift. |
--keep-modifiers | switch (no value) | |
--name | <new relation> | Name value for commands that create/merge entities. Example: --name 'Merged Startup'. |
--if-taken | ask swap replace keep-both | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Every value as a command line
engine relations item move-to-input --if-taken ask
engine relations item move-to-input --if-taken swap
engine relations item move-to-input --if-taken replace
engine relations item move-to-input --if-taken keep-both
Used by the GUI Dialogs and notices: Move
Example
engine relations item move-to-input <relation-name> --node game:id --device <device> --input <input> --text
#engine relations item copy-to
writtenengine relations item copy-to <relation-name> (--node game:id [--node ...] | --all) --to <relation> [--force]
Copies the actions with their aircraft (switched-off ones too) into another relation of the same kind; an action it already has gains the missing aircraft; --force: a relation of the other kind (axis/button); one undo step
For beginners
Copies actions of one relation into another relation of the same kind (axis or button), with their aircraft. The first
relation keeps them. The relation editor's Copy and Paste (several actions selected) run this command.
engine relations item copy-to "Weapon Release" --node "DCS:d3001pnilu3001cd2vd1vpnilvunil" --node "WarThunder:ID_BOMBS" --to "Pickle" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id (repeatable) names the actions; --all takes every action of the relation. Aircraft in a spec are
ignored: the whole action goes, with its switched-off aircraft still off.
--to <relation>: the target (a name or a query that names one relation). An action the target already has gains the
aircraft it lacked; when the target has another action of the same game for an aircraft, both stay and a warning says
so (one aircraft should have one action per relation: the Check page lists it).
- The target must be of the same kind;
--force copies into a relation of the other kind anyway. The relation itself
as target is refused.
- One profile version (one undo step), never merged with the edit just before it.
Technical internals
- Output: JSON (
Action, From, To, Created, Actions, Moved, DeletedRelations, Warnings), or --text
("Copied action(s) from '' to ''.", one line per action, Warning: lines).
- Exit code
1 with relations item copy-to needs --all or at least one --node <game:id>., relations item copy-to needs --to <relation>., Relation '...' does not hold game:id., '<b>' is an axis relation; the actions are button actions (--force adds them anyway). or '<a>' is the relation the actions are in: pick another one.
- Related:
engine relations item move-to, engine relations item add.
What it does Copies the actions with their aircraft (switched-off ones too) into another relation of the same kind; an action it already has gains the missing aircraft; --force: a relation of the other kind (axis/button); one undo step.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
--to | <relation> | The target: the new position (relations item move), the file or folder to write (telemetry export), the folder to unpack into (support unpack). Example: C:\Cases\case1. |
--force | switch (no value) | |
Used by the GUI Relations: PasteRelationNodesCommand
Example
engine relations item copy-to <relation-name> (--node game:id --text
#engine relations item move-to
writtenengine relations item move-to <relation-name> (--node game:id [--node ...] | --all) (--to <relation> | --new <name>) [--delete-empty] [--force]
Moves the actions to another relation of the same kind, or to a new relation of this kind without a bind; --delete-empty deletes the source when no action is left; one undo step
For beginners
Moves actions of one relation to another relation of the same kind, or to a new relation. The relation editor's Move
to... (several actions selected, or Move to another relation... on an action) runs this command.
engine relations item move-to "Weapon Release" --node "DCS:d3001pnilu3001cd2vd1vpnilvunil" --new "Pickle" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id (repeatable) or --all: the actions, each with all its aircraft (switched-off ones stay off).
- Exactly one of
--to <relation> (an existing relation of the same kind; --force for the other kind) and
--new <name> (a new relation of the source's kind, without a bind and groups; a taken name is refused).
--delete-empty: the source is deleted with its bind when no action is left (without it an empty relation stays).
- One profile version (one undo step), never merged with the edit just before it.
What it does Moves the actions to another relation of the same kind, or to a new relation of this kind without a bind; --delete-empty deletes the source when no action is left; one undo step.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
--to | <relation> | The target: the new position (relations item move), the file or folder to write (telemetry export), the folder to unpack into (support unpack). Example: C:\Cases\case1. |
--new | <name> | Target device name for devices exchange. Example: --new 'RIGHT VPC Throttle'. |
--delete-empty | switch (no value) | |
--force | switch (no value) | |
Used by the GUI Dialogs and notices: Move
Example
engine relations item move-to <relation-name> (--node game:id --text
#engine relations mass delete
writtenengine relations mass delete [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Deletes many relations at once, picked by name, by a search text or all of them. Each relation leaves the profile
with its bind. The Relations page's Delete (one open relation, or several ticked ones, after a question) and the
bulk operation delete run it.
engine relations mass delete --query Temporary --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Selection (combined):
--relation <name> (repeatable), --relations <list> (,, | or ; between names), each
name exact or a part only one relation has; --query <text> (the same match as engine relations list); --all.
- Nothing selected is refused. The game files do not change until the next export.
- One profile version (one undo step):
engine profile history undo (engine profile history restore) or Ctrl+Z in
the GUI brings them back.
What it does Deletes many relations in one command using explicit names, query filter, or --all.
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Used by the GUI Relations: Delete · Relations: Delete · Relations: DeleteSelectedRelationCommand
Example
engine relations mass delete --query 'Temporary' --text
engine relations mass delete --all --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
#engine relations mass duplicate
writtenengine relations mass duplicate [--relation <name>] [--relations <csv>] [--query <text>] [--all] [--no-bind]
For beginners
Copies relations: each copy has the same actions and, unless you say --no-bind, the same bind. Use it to put a
variant on another button. The Relations page's Duplicate and Duplicate without bind run it for the open
relation.
engine relations mass duplicate --relation "Trim Pitch" --no-bind --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Selection as in
engine relations mass delete: --relation, --relations, --query, --all.
- Names:
<name> (copy), then <name> (copy 2) ..., never an existing name.
--no-bind: the copy has no input and no modifiers.
- The copy has the same actions switched on, so
engine relations duplicates (the Check) lists them as on in two
relations until one side changes.
- One profile version (one undo step).
Technical internals
- Output: JSON (
Action, SelectedRelations, CreatedRelations), or --text; the profile is saved with
--profile.
- Exit code
1 with No relations were duplicated. or the selection messages of engine relations mass delete.
What it does Duplicates many relations in one command.
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
--no-bind | switch (no value) | |
Used by the GUI Relations: Duplicate · Relations: Duplicate without bind · Relations: Duplicate · Relations: Duplicate without bind
Example
engine relations mass duplicate --relations 'Trim Pitch,Trim Roll' --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
#engine relations mass merge
writtenengine relations mass merge <name> [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Joins several relations into one new relation with all their actions, for example "Trim Pitch" and "Trim Roll" into
"Trim". The old relations are removed. On the Relations page, Bulk changes with merge (the new name in
Value) and Run Mass Operation run it.
engine relations mass merge "Trim" --relations "Trim Pitch,Trim Roll" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The new name: the first word after
merge or --name <name>; a name that exists already gets __1, __2 ...
- Selection as in
engine relations mass delete: --relation (repeatable), --relations <list>, --query <text>,
--all.
- All selected relations must be of one kind (all axes or all buttons).
- The actions are copied with their aircraft; an action in several of them becomes one with the switched-on aircraft of
all.
- The bind: kept when every selected relation had the same input with the same modifiers; otherwise the new relation
has no bind. The groups of the old relations are not carried over.
- One profile version (one undo step). The game files change only with the next export.
Technical internals
- Output: JSON (
Action merge, SelectedRelations, SelectedCount, DeletedRelations, CreatedRelations), or
--text (Relation Mass Operation with the lists); the profile is saved with --profile.
- Exit code
1 with relations mass merge requires a target name via positional <name> or --name., relations mass merge requires selected relations to be either all axis or all button., Unknown relations mass merge argument(s): ... or the selection messages of engine relations mass delete.
- Related:
engine relations mass split, engine relations merge-copies (joins copies of one relation).
What it does Merges selected relations into one new relation name.
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Example
engine relations mass merge 'Merged Trim' --relations 'Trim Pitch,Trim Roll' --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
- Selected relations must all be axis or all button.
#engine relations mass split
writtenengine relations mass split <postfix> [--plane <game:plane|plane>] [--planes <csv>] [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Moves some aircraft out of relations into new relations of their own, for example the carrier aircraft into
"Startup_Carrier". Use it when those aircraft should get the function on another input. On the Relations page,
Bulk changes with split (the postfix in Value, the aircraft in Planes) runs it.
engine relations mass split Carrier --plane "DCS:FA-18C_hornet" --query Startup --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The postfix: the first word after
split or --postfix <text>; each new relation is named <old name>_<postfix>
(__1, __2 ... when taken).
--plane <aircraft> (repeatable) or --planes <list>: the aircraft that move; game:aircraft works too (the part
after the colon counts). At least one is needed.
- Selection as in
engine relations mass delete; all selected relations must be of one kind.
- Per selected relation one new relation with a copy of every action: the given aircraft are switched on in the copy
and off in the original; all other aircraft are off in the copy. A relation without those aircraft still gets a new
relation, with every action switched off.
- The new relations keep the groups and have no bind yet. One profile version (one undo step).
Technical internals
- Output: JSON (
Action split, SelectedRelations, SelectedCount, CreatedRelations), or --text; the profile
is saved with --profile.
- Exit code
1 with relations mass split requires a postfix via positional <postfix> or --postfix., relations mass split requires at least one plane via --plane or --planes., relations mass split requires selected relations to be either all axis or all button., No split relations were created. or the selection messages.
- Related:
engine relations mass merge, engine binds set (bind the new relations), engine relations aircraft set.
What it does Splits selected planes out of selected relations into new postfix relations.
| Option | Values | Meaning |
|---|
--plane | <game:plane|plane> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Example
engine relations mass split 'Carrier' --plane 'DCS:F/A-18C_hornet' --query 'Startup' --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
- Selected relations must all be axis or all button.
- Planes can be passed as PlaneName or Game:PlaneName.
#engine relations mass add-prefix
writtenengine relations mass add-prefix <value> [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Puts the same text in front of the names of many relations, for example A10_. On the Relations page, Bulk
changes with add-prefix (the text in Value) and Run Mass Operation run it.
engine relations mass add-prefix "A10_" --query "A-10" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The text is the first word after
add-prefix (or --value <text>); prefix works as the action name too. Spaces at
its ends are dropped.
- Selection as in
engine relations mass delete: --relation, --relations, --query, --all.
- A new name that exists already gets
__1, __2 ... The bind and the dismissed suggestions go with the name.
- One profile version (one undo step). No game sees relation names, so nothing changes in the games.
What it does Adds a prefix to many relation names at once.
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Example
engine relations mass add-prefix 'A10_' --query 'A-10' --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
#engine relations mass add-postfix
writtenengine relations mass add-postfix <value> [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Appends the same text to the names of many relations, for example _ALT. The Relations page's bulk operation
add-postfix (Run Mass Operation, text in Value) runs it.
engine relations mass add-postfix " (Carrier)" --query Hook --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Technical internals
- Output: JSON (
Action add-postfix, RenamedRelations with OldName / NewName), or --text; the profile is
saved with --profile.
- Exit code
1 with relations mass add-postfix requires a value via positional <value> or --value., No relation names were changed. or the selection messages.
What it does Adds a postfix to many relation names at once.
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Example
engine relations mass add-postfix '_ALT' --relations 'Trim Pitch,Trim Roll' --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
#engine relations mass remove-part
writtenengine relations mass remove-part <value> [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Removes a piece of text from the names of many relations, for example a TEMP_ you added before. On the Relations
page, Bulk changes with remove-part (the text in Value) runs it.
engine relations mass remove-part "TEMP_" --query "TEMP_" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The text is the first word after
remove-part (or --value <text>); remove-name-part works as the action name
too. Every place the text occurs (case matters) is removed.
- A name that would be empty keeps its old name; a new name that exists already gets
__1, __2 ...
- Selection as in
engine relations mass delete. The bind and the dismissed suggestions go with the name.
- One profile version (one undo step).
Technical internals
- Output: JSON (
Action remove-part, RenamedRelations), or --text; the profile is saved with --profile.
- Exit code
1 with relations mass remove-part requires a value via positional <value> or --value., No relation names were changed. or the selection messages.
- Related:
engine relations mass add-prefix, engine relations mass add-postfix.
What it does Removes a substring from many relation names at once.
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Example
engine relations mass remove-part 'TEMP_' --query 'TEMP_' --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
#engine relations mass move-actions
writtenengine relations mass move-actions (--to <relation> | --new <name>) [--relation <name>] [--relations <csv>] [--query <text>] [--all] [--delete-empty] [--force]
Every action of the selected relations goes to one relation; the relations must be of one kind (axis or button) as the target, --force moves them anyway; --delete-empty deletes the emptied relations with their binds; one undo step
For beginners
Moves every action of several relations into one relation: an existing one or a new one. The Relations list's Move
actions to... (several relations selected) runs it with --delete-empty, so the emptied relations go.
engine relations mass move-actions --relations "TMS Up,TMS Down" --to "TMS" --delete-empty --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The relations:
--relation <name> / --relations <csv>, --query <text> or --all, as the other mass commands.
- Exactly one of
--to <relation> and --new <name> (the selected relations' kind, no bind). The selected relations
must be all axis or all button, like the target; --force moves them anyway. A target that is also selected keeps its
actions.
- Each action keeps its aircraft (switched-off ones stay off); an action the target has gains the aircraft it lacked.
--delete-empty: the emptied relations are deleted with their binds (without it they stay, without actions).
- One profile version (one undo step).
Technical internals
- Output: as
engine relations item copy-to (Action = move-actions, From = the relations whose actions moved), or
--text.
- Exit code
1 with relations mass move-actions needs either --to <relation> or --new <name>., relations mass move-actions needs relations of one kind: all axis or all button (--force moves them anyway). or the selection
errors of the mass commands.
- Related:
engine relations mass merge (several relations into one new relation, binds merged only when equal),
engine relations item move-to.
What it does Every action of the selected relations goes to one relation; the relations must be of one kind (axis or button) as the target, --force moves them anyway; --delete-empty deletes the emptied relations with their binds; one undo step.
| Option | Values | Meaning |
|---|
--to | <relation> | The target: the new position (relations item move), the file or folder to write (telemetry export), the folder to unpack into (support unpack). Example: C:\Cases\case1. |
--new | <name> | Target device name for devices exchange. Example: --new 'RIGHT VPC Throttle'. |
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
--delete-empty | switch (no value) | |
--force | switch (no value) | |
Used by the GUI Relations: Run Mass Operation · Dialogs and notices: Move
Example
engine relations mass move-actions (--to <relation> --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
#engine relations mass export
writtenengine relations mass export <path.rl|path.json> [--format rl|json] [--relation <name>] [--relations <csv>] [--query <text>] [--all]
For beginners
Saves some relations (with their binds) to a file, to keep them or to give them to someone. On the Relations page,
Bulk changes with export (the file in Value) runs it. The profile does not change.
engine relations mass export "C:\Users\Pilot\Documents\JoyPro\startup.json" --query Startup --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The file: the first word after
export (or --path <file>); a missing folder is created and an existing file is
overwritten.
- Format: JSON when the file ends in
.json or with --format json; otherwise the older binary relation format .rl
(--format rl).
- Selection as in
engine relations mass delete.
- The JSON file is the relations document of
engine relations export, with only the selected relations. Note that
engine relations import replaces all relations of a profile with the file's: it refuses such a partial file unless
--replace is given, and then only the file's relations are left.
- Read-only for the profile.
Technical internals
- Output: JSON (
Action export, SelectedRelations, SelectedCount, OutputPath, ExportFormat), or --text
(Output Path:, Export Format:).
- Exit code
1 with relations mass export requires a target path (.rl or .json)., Invalid --format value: ... Use rl or json., relations mass export failed: ... or the selection messages.
- Related:
engine relations export (every relation), engine relations list.
What it does Exports selected relations in legacy .rl or JSON format.
| Option | Values | Meaning |
|---|
--format | rl json | Format selector. Example values: dcs/il2 for binds unbind, rl/json for relations mass export. |
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--relations | <csv> | Select relations as CSV for mass operations. Example: --relations 'Trim Pitch,Trim Roll'. |
--query | <text> | Select relations by substring query for mass operations. Example: --query Startup. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
Every value as a command line
engine relations mass export --format rl
engine relations mass export --format json
Example
engine relations mass export 'C:\\JoyPro\\exports\\selection.rl' --query 'Startup' --text
engine relations mass export 'C:\\JoyPro\\exports\\selection.json' --all --format json --text
How the options interact
- Selection supports explicit --relation/--relations, filter --query, and --all.
- Default format is .rl unless extension is .json or --format json is set.
#engine relations export
writtenengine relations export <path.json> [filter]
Every relation with its bind as JSON, a missing folder is created; a filter word writes only the matching relations; with --text the file is the readable view, which relations import cannot read
For beginners
Saves all relations of the profile with their binds to one JSON file, as a backup or to edit them outside JoyPro. On
the Relations page, More > Export Relations JSON... runs it. The profile does not change.
engine relations export "C:\Users\Pilot\Documents\JoyPro\relations.json" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
- The file is the first word after
export; without it the global --out <file> is used. An existing file is
overwritten; a missing folder is created.
- Words after the file filter the relations as in
engine relations list (only those are written). Such a partial file
needs --replace on engine relations import, which then removes every relation the file does not have.
- Leave out
--text: with it the file gets the readable text view instead of JSON, and engine relations import
refuses it ("is not a JSON file ... for reading only").
- Read-only for the profile.
Technical internals
- Output:
Wrote file: <path>. The file: the relations document (FormatVersion, GeneratedUtc, Relations with
name, kind, groups, function, actions with aircraft, and the bind with modifiers and axis settings).
- Exit code
1 with relations export requires a target file path.; a file that cannot be written ends with
engine error: <file> could not be written: ... (no crash report).
- Related:
engine relations import, engine relations edit (the same document in an editor),
engine relations mass export (some relations), engine binds export.
What it does Writes every relation with its bind to a JSON file (a missing folder is created); a filter word writes only the matching relations. With --text the file is the readable view, which relations import cannot read.
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations export 'C:\JoyPro\exports\relations.json'
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations export 'C:\JoyPro\exports\gear.json' Gear
How the options interact
- A filter word makes a partial file: importing it with --replace removes everything the file does not have.
#engine relations import
writtenengine relations import <path.json> [--replace]
The file's relations and binds replace all of the profile's; a file without some of the profile's relations (a filtered or mass export) is refused unless --replace, which removes them; profile history undo brings them back
For beginners
Reads a relations JSON file (from engine relations export) into the profile. The file's relations and binds replace
the profile's. On the Relations page, More > Import Relations JSON... runs it after asking first ("Replace all
relations and binds?").
engine relations import "C:\Users\Pilot\Documents\JoyPro\relations.json" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
- The file's relations become all relations of the profile: a relation that is not in the file is gone. A file that
lacks some of the profile's relations (a filtered
engine relations export, engine relations mass export) is refused
and the refusal names them; --replace imports it anyway and lists what it removed (Removed (not in the file): ...).
The GUI asks first and then passes --replace.
- Other options are refused (
relations import takes the file and --replace).
- The binds come from the file; the profile's modifier list and groups are rebuilt from them. A name that is twice in
the file gets a
1 appended.
- The titles the profile stored for an action are taken over when the action is in the file too.
- Old game ids of games split into versions (MSFS, X-Plane) are taken over as the new ones.
- One profile version (one undo step):
engine profile history undo (engine profile history restore) brings the
old relations back. The games change only with the next export.
Technical internals
- Output:
Imported relations from: <file> and relations=<n>, binds=<n>, modifiers=<n>; the profile is saved with
--profile.
- Exit code
1 with relations import requires a source file path., File not found: <file>, <file> is not a JSON file. ... (a --text export), <file> is not a relations file of engine relations export ... (another JSON file,
for example a binds export) or the refusal of a partial file; the profile stays as it was in each case.
- Related:
engine relations export, engine relations edit, engine binds import, engine profile merge (adds another
profile instead of replacing).
What it does Reads a relations JSON file (from relations export): its relations and binds replace all of the profile's. A file that lacks some of the profile's relations (a filtered export, relations mass export) is refused unless --replace, which removes them; profile history undo brings them back. A file that is not a relations document ends with a clear error.
| Option | Values | Meaning |
|---|
--replace | switch (no value) | Import also when the file lacks some of the profile's relations: they are removed (the file's relations replace all of the profile's). Without it such a file is refused. |
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations import 'C:\JoyPro\exports\relations.json'
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations import 'C:\JoyPro\exports\gear.json' --replace
How the options interact
- The import replaces everything of its kind in the profile; a partial file (a filtered export, relations mass export) needs --replace. profile merge adds relations instead.
- The GUI asks before it imports and then passes --replace.
#engine relations edit
writtenengine relations edit
No args; exports temp relations JSON, opens editor, re-imports on close; uses --editor or notepad
For beginners
Opens all relations of the profile as one JSON file in a text editor and reads the file back when the editor closes.
It is for experts who want to change many things by hand. The Advanced page's Relations Edit runs it.
engine --editor "code --wait {file}" relations edit --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
- The editor: the global option
--editor ({file} stands for the file; without it the file is added at the end),
run through cmd /c; without --editor, Notepad. The engine waits until that process ends, so an editor command
that returns at once reads the file back unchanged.
- On return the file replaces the profile's relations and their binds (a relation removed from the file is gone);
the titles the profile stored for the actions are taken over.
- Nothing changes in the games until the next export. One profile version (one undo step).
What it does Opens relations JSON in an external editor for round-trip editing.
Used by the GUI Advanced: Relations Edit
Example
engine --editor 'code --wait {file}' relations edit
#engine relations suggest
writtenengine relations suggest <relation>|--relation <relation> [--min high|medium|low] [--limit N] [--game g1|g2] | --all [--missing [--per-relation N] [--game g1|g2]] [--min ...]
For beginners
Suggests what else belongs into a relation, without AI: the same function in your other games and aircraft. The
Relations page's suggestions use it.
engine relations suggest "Gear" --min medium --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
Sources: the function catalog, your own style (habits from at least two of your own decisions), the same DCS id where
it means the same, and similar titles in any game. Scores: high from 85, medium from 55.
--min high|medium|low, --limit N, --game g1|g2 filter one relation's suggestions.
--all suggests for every relation; --all --missing lists per relation the free actions of games and aircraft it
lacks, --per-relation N caps each (default 25, 0 = all).
- To act on them:
engine relations suggest apply (--add adds, --take moves from another relation, --never
dismisses for good, --remove restores a dismissed one).
What it does Proposes what a relation is still missing, each with the reason: the functions of its commands, your style, the function map, the same DCS command id in more aircraft, similar titles in any game. Also lists what you dismissed. --all lists every relation with suggestions; --all --missing per relation the free actions of games and aircraft it lacks.
| Option | Values | Meaning |
|---|
--relation | <relation> | The relation to get suggestions for (instead of the positional name). |
--min | high medium low | |
--limit | switch (no value) | |
--game | g1 g2 | Game filter value. Example: DCS or IL2Game. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
--missing | switch (no value) | For db list, show only missing entries. |
--per-relation | switch (no value) | |
Every value as a command line
engine relations suggest --min high
engine relations suggest --min medium
engine relations suggest --min low
engine relations suggest --game g1
engine relations suggest --game g2
Example
engine relations suggest <relation>|--relation <relation> --text
#engine relations suggest apply
writtenengine relations suggest apply <relation> [--add game:id:plane1|plane2]... [--never game:id:plane1|plane2]... [--remove game:id:planes]... [--move game:id:planes=>relation]... [--take game:id:planes]...
For beginners
Carries out your decisions on the suggestions for one relation: add an action, take it from another relation, dismiss
it for good, or take it out again. On the Relations page the add, add-all, move-here and dismiss buttons of the
suggestions, Restore of a dismissed one, and the review of Suggest missing for every relation run it.
engine relations suggest apply "Speed Brake Retract" --add "DCS:d3031pnilunilcd16vd1vpnilvunil:F-16C_50" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
The relation is given by its exact name (or --relation <name>). Each option is repeatable and takes
game:id:plane1|plane2:
| Option |
Effect |
--add |
the action is added switched on for these aircraft |
--take |
it is switched off in every other relation that has it, then added here |
--never |
it is kept in the relation switched off, so it is never suggested again |
--remove |
it leaves the relation, or a dismissed suggestion is restored |
--move <spec>=>Relation |
it leaves this relation and goes into that existing relation |
- An action of the other kind (a button into an axis relation) is refused with a message; the others are still applied.
- One profile version (one undo step) for all decisions.
Technical internals
- Output: JSON (
Relation, Added, Rejected, Removed, Moved, Taken, TakenFrom, Errors), or --text
(Added:, Never:, Removed:, Moved:, Taken: and Error: lines). The profile is saved with --profile.
- Exit code
1 only when nothing could be applied (Relation not found: ..., Not a node (game:id:plane1|plane2): ..., Move needs game:id:planes=>existing relation: ...); partial errors are listed with exit code 0.
- Related:
engine relations suggest (what is suggested), engine relations search.
What it does Carries out decisions on a relation's suggestions: --add adds commands, --never dismisses them (added switched off, never proposed again; --remove restores), --take moves a command another relation uses into this one, --remove / --move fix entries that look wrong.
| Option | Values | Meaning |
|---|
--add | switch (no value) | |
--never | switch (no value) | |
--remove | switch (no value) | |
--move | switch (no value) | |
--take | switch (no value) | |
Used by the GUI Relations: AddCheckedCatalogCommand · Relations: Check again · Relations: AddTickedMissingReviewCommand · Profile bar: Take them out · Relations: Next relation with suggestions · Relations: OnlyWhereSameMeaningCommand · Relations: Switch them all off · Relations: OpenAircraftCheckRelationCommand · Relations: None: each aircraft uses it for its own function · Relations: Automatic: from its name and its actions · Relations: SetBuilderFunctionCommand · Relations: SuggestMissingCommand
Example
engine relations suggest apply <relation> --text
#engine relations search
writtenengine relations search "<words>" [--game g1|g2] [--plane p1|p2] [--category <name>] [--axis|--button] [--limit N] [--per-game N] [--batch <file>]
For beginners
Finds an action in every game's command list by words, the way you would say it ("gear", "speed brake", "fire
missile"). It changes nothing. The Relations page's search uses it.
engine relations search "landing gear" --button --game DCS --plane "F-16C_50" --text
Advanced
Searches titles, the function catalog's functions, synonyms and game terms, with typo help (DidYouMean). Results are
grouped by game, each game's main control first, each row with how it was found (exact, function, synonym,
described, words) and, for DCS, the aircraft where the id has that meaning.
--game g1|g2, --plane p1|p2, --category <name>, --axis or --button (not both) narrow the results.
--limit N and --per-game N cap the rows.
--batch <file> runs one search per line of the file (# lines skipped) and returns them together.
--profile only marks which relations already use a row.
What it does Finds actions of every game and aircraft through the function map: names, synonyms and game terms, what a query describes, a direction, typos and plain title words; grouped by game and function. --category alone lists a whole category of a game's list; --batch runs one query per line.
| Option | Values | Meaning |
|---|
--game | g1 g2 | Game filter value. Example: DCS or IL2Game. |
--plane | p1 p2 | Include one plane/module per flag. Example: --plane A-10C_2. |
--category | <name> | |
--axis | switch (no value) | Only axis actions. |
--button | switch (no value) | Only button actions. |
--limit | switch (no value) | |
--per-game | switch (no value) | |
--batch | <file> | |
Every value as a command line
engine relations search --game g1
engine relations search --game g2
engine relations search --plane p1
engine relations search --plane p2
Used by the GUI Relations: AddBuilderSearchPlaneCommand · Relations: RemoveBuilderSearchPlaneCommand · Relations: Show all games · Relations: Expand all · Relations: ToggleBuilderGameExpandedCommand
Example
engine relations search "<words>" --text
#engine relations browse
writtenengine relations browse [--game <game> [--plane p1|p2]] [--axis|--button]
Alias: relations catalog
For beginners
The catalog of every game's actions: without options the list of games with their action and aircraft counts, with
--game the whole action list of that game (DCS: of one aircraft) by its categories. The Relations page's Open
catalog shows it. It changes nothing.
engine relations browse --game DCS --plane F-16C_50 --button --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--game <game> and --plane <aircraft> (several with | or ,) pick the list; --axis or --button keep only
that kind (not both).
- With
--profile each action says which of your relations use it (the GUI's Only free filter).
relations catalog is the same command. Extra words are refused.
Technical internals
- Output: JSON (
Games with Actions and Planes, or Game, Planes, Total, Categories with Count and
InRelations, Results), or --text (Games: <n> or Catalog: <game> | <n> actions with [category] blocks).
- Exit code
1 with Use --axis or --button, not both. or an error of the game lists.
- Related:
engine relations search (find by words), engine relations suggest apply.
What it does What exists: every game with its aircraft; with --game (DCS: and --plane) every action of the game's list by its categories, with the relations that use each.
| Option | Values | Meaning |
|---|
--game | <game> | The game whose list is shown by its categories. Example: DCS. |
--plane | p1 p2 | DCS: the aircraft (p1|p2) whose actions are shown. Example: F-16C_50. |
--axis | switch (no value) | Only axis actions. |
--button | switch (no value) | Only button actions. |
Every value as a command line
engine relations browse --plane p1
engine relations browse --plane p2
Used by the GUI Relations: Catalog
Example
engine relations browse --text
#engine relations pair
writtenengine relations pair "<title A>" "<title B>" [--game <game>]
Twin, opposite or different, for the recommended-action hints
For beginners
Tells how two action titles of one game relate: twin (the same thing), opposite (two directions of one control,
such as up and down) or different. JoyPro uses this judgement for its recommended-action hints; the command shows it
for two titles you give. It changes nothing.
engine relations pair "Landing Gear Up" "Landing Gear Down" --game DCS --text
Advanced
- Exactly two titles;
--game <id> lets the game's own prefixes and tags be cleaned from the titles first.
opposite: each title names one direction of the same pair of direction words. twin: the same words once filler
words are gone and the directions do not oppose. Everything else is different.
- Read-only; no profile is needed.
What it does Whether two action titles are twins, opposites or different (for the recommended-action hints).
| Option | Values | Meaning |
|---|
--game | <game> | Game filter value. Example: DCS or IL2Game. |
Example
engine relations pair "<title A>" "<title B>" --text
#engine relations resolve
writtenengine relations resolve "<query>" [--game g1|g2] [--plane p1|p2] [--axis|--button] [--per-game N]
For beginners
Turns words into functions and the matching actions of every game, for example "cut the throttle" or "pitch". It shows
which function JoyPro understood and which action of each game does it. It changes nothing.
engine relations resolve "pitch" --game DCS --plane F-16C_50 --axis --text
Advanced
--game g1|g2 and --plane p1|p2 (also with ,, repeatable): only these games and aircraft. --axis or
--button keep only that kind (not both).
--per-game N: at most N actions per game (default 25, 0 = all).
- A direction in the words ("up", "down" ...) keeps only buttons of that direction (toggles stay). A function's main
axis comes first when the words name one function.
- DCS: one row per id and meaning; an aircraft whose title of the id means something else is a row of its own, with
the variants listed.
- Read-only; no profile is needed.
Technical internals
- Output: JSON (
Query, Functions with id, direction, term, score, related or described, DidYouMean, Extra,
Games with Actions: id, title, aircraft, function, weight, source, why, meaning variants; Total), or --text
(Query:, Functions:, Actions: <n> in <n> games and one line per action).
- Exit code
1 with --per-game takes a number (0 = all)., Use --axis or --button, not both., Unknown relations resolve argument(s): ... or the usage line without words. Words that resolve to nothing give Functions: (none)
with exit code 0.
- Related:
engine relations search (the add-actions search), engine relations functions.
What it does Reads a query as function ids (with direction) and lists the matching actions of every game, grouped by game.
| Option | Values | Meaning |
|---|
--game | g1 g2 | Game filter value. Example: DCS or IL2Game. |
--plane | p1 p2 | Include one plane/module per flag. Example: --plane A-10C_2. |
--axis | switch (no value) | Only axis actions. |
--button | switch (no value) | Only button actions. |
--per-game | switch (no value) | |
Every value as a command line
engine relations resolve --game g1
engine relations resolve --game g2
engine relations resolve --plane p1
engine relations resolve --plane p2
Example
engine relations resolve "<query>" --text
#engine relations functions
writtenengine relations functions [--category <id>] [--query "<words>"] [--coverage] [--dump <file.tsv>]
For beginners
Lists the functions of JoyPro's function map ("Gear Up", "Pitch", "CMS Forward" ...) with their synonyms and how many
actions of the games on this PC each one covers. It is what the search, the suggestions and the AI layer use to
understand words. It changes nothing.
engine relations functions --query "speed brake" --text
Advanced
--category <id>: only the functions of that category. --query "<words>": only the functions the words resolve to
(as the search reads them).
--coverage: per game how many actions are mapped to a function (by the function catalog or by the map's rules),
how many functions and aircraft, and up to 25 unmapped titles.
--dump <file.tsv>: writes one line per action (game, aircraft, id, axis/button, title, category, class, functions
with direction, weight and source); a missing folder is created.
- Read-only for the profile.
Technical internals
- Output: JSON (
Version, Source, Totals, Categories, Functions with name, kind, synonyms, game terms,
directions, slots, related functions, action counts per game, Coverage, timings, FromCache, Warnings), or
--text (a totals line, the functions by category, Coverage:).
- Exit code
1 when the map is empty (The function map is empty. or the reading problem) or with an unknown
argument.
- Files:
DB\Functions\function-map.json; the mapped index is cached in %LOCALAPPDATA%\JoyPro2\Cache\function-map.bin
until the game lists change.
- Related:
engine relations resolve, engine relations function (one relation's function).
What it does Lists the function map: ids, names, synonyms, game terms, slots and how many actions of each game are each function; --coverage per game, --dump writes every action with its functions to a file.
| Option | Values | Meaning |
|---|
--category | <id> | |
--query | switch (no value) | Select relations by substring query for mass operations. Example: --query Startup. |
--coverage | switch (no value) | |
--dump | <file.tsv> | |
Example
engine relations functions --text
#engine relations chat
writtenengine relations chat <relation>|--relation <relation> "<message>" [--llm off|auto|on] [--show-prompt] [--apply]
For beginners
Changes one relation from a sentence: "add flare release for all jets", "remove the helicopters", "also War Thunder",
"only DCS". It shows what it would add and remove; --apply carries it out. It works without AI; with the optional
local model switched on, the model picks from the same lists.
engine relations chat "Flare Release" "add flare release for all jets" --llm off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The relation: the first word (exact name, or a part only one relation has) or
--relation <name>; the rest is the
message.
- What it reads: remove ("remove", "delete", "drop" ...), keep only ("only", "just") or add (otherwise), with the
functions and aircraft the message names. The candidates come from the offline rules of Group by description, the
relation's own suggestions and a word search over every game.
--llm off: offline rules only; auto: the local model only when the rules found nothing or did not understand
words; on: always the model (fails when it is not usable). Without --llm: on when the local AI is switched on
in Settings, else off.
- The model may only pick numbered lines of these lists; every other id is rejected and listed. A failed model answer
falls back to the offline rules with a warning.
--show-prompt adds what the model would get (messages and grammar) to the output.
- Without
--apply nothing changes. With --apply the adds and removes run as one profile version (one undo step).
Technical internals
- Output: JSON (relation, message, intent,
Add and Remove with spec, title and other relations that have it,
Rejected, Applied, Added, Removed, the model's data, warnings, errors), or --text (Understood:,
Method:, Add: <n> with + game:id:planes | title lines, Remove: <n>, Applied: ...).
- With
--apply and --profile the profile is saved.
- Exit code
1 with relations chat <relation> "<message>" [--llm off|auto|on] [--show-prompt] [--apply], Invalid --llm value: ..., Unknown relations chat argument(s): ..., Say what to change, ..., the model's problem with
--llm on, or the name messages.
- Related:
engine relations assistant (any relation), engine relations suggest apply (what --apply uses),
engine llm.
What it does Changes one relation from a sentence: offline rules and the relation's suggestions give numbered candidates, the optional local model picks from them, JoyPro checks every id and prints the proposed adds and removes; --apply applies them.
| Option | Values | Meaning |
|---|
--relation | <relation> | The relation to change (instead of the positional name). |
--llm | off auto on | |
--show-prompt | switch (no value) | |
--apply | switch (no value) | |
Every value as a command line
engine relations chat --llm off
engine relations chat --llm auto
engine relations chat --llm on
Example
engine relations chat <relation>|--relation <relation> "<message>" --text
#engine relations assistant
writtenengine relations assistant "<message>" [--relation <name>] [--llm auto|on|off] [--max-steps N] [--show-prompt]
For beginners
The JoyPro assistant of the Relations page: you type a sentence and it changes relations at once, for example
"Throttle ALL: all throttle axes" or "add the collectives to Throttle". It works without AI for simple sentences; with
the optional local AI model it understands more. The JoyPro assistant box on the Relations page runs it.
engine relations assistant "add the collectives to Throttle" --llm off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--llm auto (default): the local model when it is switched on and ready (Settings > Local AI), else the offline
rules; on: the model or an error; off: offline rules only.
- Offline it understands ": " (create and fill), "add [to ]", "remove [from
]" and "rename to "; anything else says that it needs the model.
- With the model, the model calls JoyPro's own tools (list, show, search, suggest, create, rename, add, remove) one
JSON call at a time; JoyPro checks every id, skips actions of the wrong kind and never deletes a relation.
- A question is answered from JoyPro's knowledge of the games and changes nothing.
--relation <name>: the open relation, used when the sentence names none. --max-steps <n> (default 16, at
most 40) limits the model's tool calls. --show-prompt prints what the model would get and changes nothing.
- A turn that changes something is one profile version (the GUI's Undo this).
Technical internals
- Output: JSON (method, reply, changes, the model's process and notes), or
--text. The profile is saved with
--profile only when something changed.
- Exit code
1 with --max-steps takes a number from 1., Invalid --llm value: ..., Unknown relations assistant argument(s): ..., or when the turn failed without a change (with --llm on and no usable model: the model's
problem, for example The local AI model is off ...).
- The model runs in its own
llama-server process for the turn (engine llm, engine llm start).
- Related:
engine relations chat (one relation), engine relations from-text.
What it does The JoyPro assistant: creates, fills, renames and trims relations from a sentence and applies it at once; with the local AI model through checked tools, without it simple commands.
| Option | Values | Meaning |
|---|
--relation | <name> | The relation the message is about (focus): the assistant works on it when the message names none. Example: --relation 'Throttle ALL'. |
--llm | auto on off | |
--max-steps | switch (no value) | |
--show-prompt | switch (no value) | |
Every value as a command line
engine relations assistant --llm auto
engine relations assistant --llm on
engine relations assistant --llm off
Used by the GUI Relations: Send
Example
engine relations assistant "<message>" --text
#engine relations plan ask
writtenengine relations plan ask "<request>" [--relation <name>] [--llm auto|on|off]
Manage / Edit with AI: the request as a plan of relation steps (create, delete, rename, add, remove, aircraft, groups, tuning, fill, check), each checked against the profile and the catalog; offline rules first, the local model when they do not cover it; a question gets an answer and no steps; nothing changes
For beginners
Turns a request in your words into a plan of relation steps, for example "fill the F-4E Phantom II into my relations"
or "append _sc to every relation that contains Star Citizen". Nothing changes yet: you see every step and pick the ones
to run with engine relations plan apply. The Relations page's Manage with AI and Edit with AI (one relation) run it.
engine relations plan ask "fill the F-4E Phantom II into my relations" --llm off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Steps: create, delete, rename, add, remove, aircraft, groups, tuning, fill (a preview of what fits) and check
(unticks aircraft where an action does something else). JoyPro checks every step against the profile and the
command lists.
--llm auto (default): JoyPro's offline rules when one fits the request exactly, else the local model; off: the
offline rules only (a request they do not cover fails with a hint); on: always the model.
--relation <name>: the plan is for that relation (Edit with AI); an unknown name fails.
- A question ("what does Landing gear down do in X-Plane 12") gets JoyPro's answer and no steps.
- Changes nothing, also with
--profile.
Technical internals
- Output: JSON (
Request, Scope, Method, Reply, Ops, Steps, Llm, Warnings, Errors), or --text. The
Ops are what engine relations plan apply takes.
- Exit code
1 with Relation not found: ..., Invalid --llm value: ..., Unknown relations plan ask argument(s): ..., or when the plan has errors and no step (Say what to do, ..., no offline rule and no usable model).
- Reference: ai-plans. Related:
engine relations assistant, engine llm.
What it does Manage / Edit with AI: turns a request into a plan of relation steps (create, delete, rename, add, remove, aircraft, groups, tuning, fill, check), each checked against the profile and the catalog. Offline rules first, the local model when they do not cover the request (--llm). A question gets JoyPro's answer and no steps. Nothing changes.
| Option | Values | Meaning |
|---|
--relation | <name> | Plan only for this relation (Edit with AI on one relation). |
--llm | auto on off | auto (default): offline rules, the local model when they do not cover the request; on: always ask the model; off: offline rules only. |
Every value as a command line
engine relations plan ask --llm auto
engine relations plan ask --llm on
engine relations plan ask --llm off
Used by the GUI Relations: Make a plan
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations plan ask 'fill the F-4E Phantom II into my relations' --llm off --text
#engine relations plan apply
writtenengine relations plan apply (--file <plan.json> | <json>) [--relation <name>] [--only 0,2,3] [--dry-run]
Runs the plan's steps, or only the numbered ones (from 0), in one history step; --relation limits it to that relation; --dry-run reports without changing the profile
For beginners
Runs the steps of a plan from engine relations plan ask: all of them, or only the ones you ticked. They run together
as one version of the profile, so one undo takes them back. The Relations page runs it when you apply a Manage with AI
or Edit with AI plan.
engine relations plan apply --file "C:\Users\Pilot\Documents\JoyPro\plan.json" --only 0,2 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The plan:
--file <plan.json>, or the JSON as text after apply.
--only 0,2,3: only these steps, numbered from 0 as in the plan.
--relation <name>: the relation an Edit with AI plan was made for; a step that would change another relation gets
an error instead.
--dry-run: reports what the steps would do; the profile is not saved.
- A step that fails is reported with its error; the other steps still run. Steps left out by
--only are listed as
skipped.
Technical internals
- Output: JSON of the result (what each step did,
DryRun, warnings, errors), or --text. With --profile the profile
is saved unless --dry-run.
- Exit code
1 with The plan has no steps., --only takes step numbers from 0, e.g. --only 0,2., a parse error of
the plan, Relation not found: ... or Unknown relations plan apply argument(s): ....
- Related:
engine relations plan ask, engine profile history (undo).
What it does Runs a plan's steps (from relations plan ask, as a file or JSON text), or only the numbered ones with --only, in one history step; --dry-run reports without changing the profile.
| Option | Values | Meaning |
|---|
--file | <plan.json> | The plan as a JSON file (from relations plan ask); else the JSON is given as text. |
--relation | <name> | The relation the plan was made for (Edit with AI); a step that would change another relation gets an error. |
--only | switch (no value) | Run only these steps, numbered from 0. Example: --only 0,2. |
--dry-run | switch (no value) | Report what the steps would do; the profile is not changed. |
Used by the GUI Relations: Apply selected
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations plan apply --file 'C:\JoyPro\plan.json' --only 0,2 --dry-run --text
#engine relations ai-matrix
writtenengine relations ai-matrix [--games g1|g2] [--paths p1|p2] [--examples N]
Test of every AI path of the Relations page with typical requests per game, on the loaded profile in memory; each answer is judged (right game only, readable, an answer at all); nothing is saved; --examples N shows the answers cut to N characters
For beginners
A test for maintainers: asks every AI path of the Relations page (the JoyPro assistant, Manage and Edit with AI, Expand
with AI, Group by description, the relation chat and what the local model is shown) typical requests for every game
JoyPro knows, and judges each answer. Nothing is saved.
engine relations ai-matrix --games "DCS|XPlane12" --examples 80 --text
Advanced
- Each answer is judged: only actions of the game the request names, readable (no raw ids), an answer at all; a game
without that function must not get another game's actions. The function map decides which game has a function.
--games g1|g2: only these games; --paths p1|p2: only these paths (for example assistant, plan, describe,
chat, llm); --examples N: show each answer cut to N characters (0 = none).
- Works on the loaded profile in memory; every cell is taken back at once, nothing is saved.
What it does Test of every AI path of the Relations page (assistant, Manage / Edit with AI, fill, by description, chat) with typical requests for every game, on the loaded profile in memory; each answer is judged (actions of the named game only, readable, an answer at all). Nothing is saved.
| Option | Values | Meaning |
|---|
--games | g1 g2 | Only these games (g1|g2); default: every game. |
--paths | p1 p2 | Only these AI paths (p1|p2); default: all. |
--examples | switch (no value) | Show each answer cut to N characters (0 = no answers). |
Every value as a command line
engine relations ai-matrix --games g1
engine relations ai-matrix --games g2
engine relations ai-matrix --paths p1
engine relations ai-matrix --paths p2
Example
engine relations ai-matrix --text
#engine relations phrase-check
writtenengine relations phrase-check --file <phrases.json> [--entries search|catalog|assistant|plan|describe] [--functions id1|id2] [--kinds phrases|descriptions|de] [--failures N]
Offline test: does every phrase of the file find its function on each entry point; nothing changes; lists up to N failures (default 40); exit 1 on errors
For beginners
A test for maintainers: checks that what players type (names, synonyms, slang, everyday sentences, German) finds the
right function on every entry point, offline and without the AI model. The phrases come from a JSON file, one set per
function.
engine relations phrase-check --file engine\tests\fixtures\phrases\phrases.json --entries search --text
Advanced
- Entry points:
search (the add-actions search), catalog (the filter of one game's list), assistant (the JoyPro
assistant's lookup), plan (Manage with AI "make a relation for ..."), describe (Group by description);
--entries picks some.
--functions id1|id2: only these functions; --kinds phrases|descriptions|de: only these phrase kinds;
--failures N: how many failures are listed (default 40).
- Nothing changes: the profile is not touched, plan and describe run as dry runs.
Technical internals
- Output: JSON (per entry point the counts and failures, the games per function, warnings, errors), or
--text.
- Exit code
0; 1 when the run has errors, without --file, with an unknown entry point (Unknown entry point(s): ...) or --failures takes a number.
- Related:
engine relations search, engine relations ai-matrix.
What it does Offline test of the phrases in a JSON file (names, synonyms, slang, sentences, German): does each one find its function on every entry point (search, catalog, assistant, plan, describe)? Nothing changes; exit 1 when the run has errors.
| Option | Values | Meaning |
|---|
--file | <phrases.json> | The phrase file (JSON), e.g. engine\tests\fixtures\phrases\phrases.json. |
--entries | search catalog assistant plan describe | Only these entry points: search, catalog, assistant, plan, describe. |
--functions | id1 id2 | Only these function ids (id1|id2). |
--kinds | phrases descriptions de | Only these phrase kinds: phrases, descriptions, de. |
--failures | switch (no value) | How many failures are listed (default 40). |
Every value as a command line
engine relations phrase-check --entries search
engine relations phrase-check --entries catalog
engine relations phrase-check --entries assistant
engine relations phrase-check --entries plan
engine relations phrase-check --entries describe
engine relations phrase-check --functions id1
engine relations phrase-check --functions id2
engine relations phrase-check --kinds phrases
engine relations phrase-check --kinds descriptions
engine relations phrase-check --kinds de
Example
engine relations phrase-check --file <phrases.json> --text
#engine relations rename
writtenengine relations rename <relation> <new name>
For beginners
Gives one relation a new name; its bind and actions stay. On the Relations page, typing a new name into the open
relation's name box and pressing Enter (or leaving the box) runs it.
engine relations rename "Gear Toggle" "Landing Gear" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Technical internals
- Output: JSON (
Relation, Name), or --text (Renamed: <old> -> <new>); the profile is saved with --profile.
- Exit code
1 with relations rename <relation> <new name> (not two words, or an empty name), A relation named '...' exists already., Could not rename '...'. or the name messages.
What it does Gives one relation a new name; its bind and actions stay.
Example
engine relations rename <relation> <new name> --text
#engine relations function
writtenengine relations function <relation> [--set <function>|--none|--auto]
For beginners
Shows or sets the function a relation stands for, for example "Gear Up" or "CMS Forward". The function steers the
suggestions, Suggest missing and Auto Assign. The function chip on the Relations page shows it, and picking a function
there runs --set.
engine relations function "Left Hat Up" --set target_management_system_up --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Without an option: the function and how JoyPro knows it: set by you, cleared by you, named after it, covered (at
least 80 % of its known actions are that function), mixed (a button position with a different function per
aircraft) or unknown.
--set <function>: a catalog function by id or name; an axis function only on an axis relation and a button one
only on a button relation.
--none: no function (a button position: each aircraft its own; no function-based suggestions).
--auto: back to automatic. Use one of the three at a time; setting what is already set writes no version.
relations function --list [--axis|--button] [--query <text>] lists the catalog functions --set can pick (the
GUI's picker), sorted by name: --axis / --button keep only axis or button functions, --query only those whose
name or id contains every word.
Technical internals
- Output: JSON of the relation's function result (or of the choices with
--list), or --text (--list: one line
id<TAB>name per function, (axis) for axes). The profile is saved with --profile after a change.
- Exit code
1 with Use one of --set, --none and --auto., Unknown function: ... (relations function --list shows them)., the axis/button mismatch message or the name messages.
- Data:
DB\Functions\slots.json. Related: engine relations suggest, engine relations auto-assign.
What it does The function a relation stands for (set, named, covered, mixed or unknown) and how sure JoyPro is; --set picks a catalog function, --none says it has none, --auto goes back to automatic. With --list: the catalog functions to pick from (id and name), filtered by --axis / --button and --query.
| Option | Values | Meaning |
|---|
--set | <function> | |
--none | switch (no value) | |
--auto | switch (no value) | |
Used by the GUI Relations: The function this relation stands for in every aircraft and game. Suggestions, AI fill and Auto Assign use it. · Relations: None: each aircraft uses it for its own function · Relations: Automatic: from its name and its actions · Relations: SetBuilderFunctionCommand
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations function 'Gear Toggle' --text
engine relations function --list --button --query gear --text
#engine relations function
writtenengine relations function --list [--axis|--button] [--query text]
Lists the catalog functions --set can pick, id and name sorted by name; --axis / --button only axis / button functions; --query only those whose name or id contains every word
For beginners
Shows or sets the function a relation stands for, for example "Gear Up" or "CMS Forward". The function steers the
suggestions, Suggest missing and Auto Assign. The function chip on the Relations page shows it, and picking a function
there runs --set.
engine relations function "Left Hat Up" --set target_management_system_up --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Without an option: the function and how JoyPro knows it: set by you, cleared by you, named after it, covered (at
least 80 % of its known actions are that function), mixed (a button position with a different function per
aircraft) or unknown.
--set <function>: a catalog function by id or name; an axis function only on an axis relation and a button one
only on a button relation.
--none: no function (a button position: each aircraft its own; no function-based suggestions).
--auto: back to automatic. Use one of the three at a time; setting what is already set writes no version.
relations function --list [--axis|--button] [--query <text>] lists the catalog functions --set can pick (the
GUI's picker), sorted by name: --axis / --button keep only axis or button functions, --query only those whose
name or id contains every word.
Technical internals
- Output: JSON of the relation's function result (or of the choices with
--list), or --text (--list: one line
id<TAB>name per function, (axis) for axes). The profile is saved with --profile after a change.
- Exit code
1 with Use one of --set, --none and --auto., Unknown function: ... (relations function --list shows them)., the axis/button mismatch message or the name messages.
- Data:
DB\Functions\slots.json. Related: engine relations suggest, engine relations auto-assign.
What it does The function a relation stands for (set, named, covered, mixed or unknown) and how sure JoyPro is; --set picks a catalog function, --none says it has none, --auto goes back to automatic. With --list: the catalog functions to pick from (id and name), filtered by --axis / --button and --query.
| Option | Values | Meaning |
|---|
--list | switch (no value) | List the catalog functions --set can pick (id and name, sorted by name) instead of showing a relation's function. |
--axis | switch (no value) | With --list: only axis functions. |
--button | switch (no value) | With --list: only button functions. |
--query | switch (no value) | With --list: only functions whose name or id contains every word. Example: --query gear. |
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations function 'Gear Toggle' --text
engine relations function --list --button --query gear --text
#engine relations aircraft
writtenengine relations aircraft <relation> [--node game:id[:aircraft]]
For beginners
Shows, for each action of a relation, every aircraft that has its id: switched on, off or not in the action, with the
title it has there and whether that is the same function. Use it to see where a DCS id does something else. The
Relations page reads it for the aircraft list under each action and for the titles of other games' actions. It changes
nothing.
engine relations aircraft "Rudder" --node "DCS:a2003cdnil" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- The relation: exact name or a part only one relation has (also
--relation <name>). --node game:id: only that
action; an aircraft part (game:id:F-16C_50 or game:id:a|b) is read like every other --node and only names the
action, the report still lists every aircraft.
- Per aircraft the match to the action's meaning (the most common meaning of its switched-on aircraft):
same,
near (the same words in another order, another category or one extra word), differs, differs (same function) when the function map reads it as the same function anyway, or unknown (the id is not in that
aircraft's list any more).
- Games with one list (IL-2, Star Citizen, X-Plane ...): one line for the game. MSFS 2020 and 2024: every aircraft of
JoyPro's aircraft list, all ticked when the action is for all aircraft.
- Read-only.
--on, --off and --only change something only with engine relations aircraft set.
Technical internals
- Output: JSON (
Relation, Nodes with game, id, title, category, explanation, Badge such as 3 of 12 aircraft,
counts of switched-on aircraft that differ or are near, Aircraft with plane, title, state on / off / absent,
match and note), or --text (one line per action, then [x] on, [-] off, [ ] absent per aircraft, and MIXED:
when switched-on aircraft mean something else).
- Exit code
1 with the usage line (no relation), --node needs game:id. or the name messages.
- Related:
engine relations check-aircraft (all relations), engine relations meanings.
What it does Every action of the relation with every aircraft that has its id: on, off or not in it, each aircraft's own title and category of the id and whether it means the same as the action. --node game:id[:aircraft] shows one action (an aircraft part only names the node).
| Option | Values | Meaning |
|---|
--node | switch (no value) | Only this action: game:id; an aircraft part (game:id:F-16C_50 or game:id:a|b) only names the node, the report lists every aircraft. Example: --node DCS:d3001pnilunilcdnilvdnilvpnilvunil. |
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' relations aircraft 'Gear Toggle' --node DCS:d3001pnilunilcdnilvdnilvpnilvunil:F-16C_50 --text
#engine relations aircraft set
writtenengine relations aircraft set <relation> --node game:id [--on p1|p2] [--off p3|p4] [--only p1|p2]
For beginners
Ticks or unticks aircraft of one action in a relation, in one step. Use it when a DCS command should not apply in
some aircraft. On the Relations page, Apply under an action's aircraft list runs it, and so do Only where it is
'...' of the aircraft check and the MSFS 2024 "only in some aircraft" fix.
engine relations aircraft set "Rudder" --node "DCS:a2003cdnil" --off "AH-64D_BLK_II|Mi-24P" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--node game:id (needed): the action in the relation.
--on p1|p2: switched on, also aircraft the action did not list yet. --off p3|p4: switched off and kept listed,
so suggestions do not bring them back. --only p1|p2: exactly these on, every other aircraft of the action (and of
the game's aircraft list) off.
- Games with one aircraft list per game (MSFS): all ticked means all aircraft; none ticked switches the action off.
- In the game: unticked aircraft do not get this action on the relation's button at the next export.
- One profile version (one undo step).
Technical internals
- Output: JSON (
Relation, Changed, Nodes with every aircraft: on / off, its title and whether the id means
the same there), or --text (Changed: <n> and one [x] / [-] line per aircraft).
- Exit code
1 with relations aircraft set needs --node game:id., relations aircraft set needs --on, --off or --only., game:id is not in '<relation>'. or the name messages.
- Related:
engine relations aircraft (the same report without a change), engine relations check-aircraft.
What it does One action's aircraft selection in one step (one undo step): --on switches aircraft on (adds them), --off switches them off, --only ticks exactly these.
| Option | Values | Meaning |
|---|
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--on | p1 p2 | |
--off | p3 p4 | |
--only | p1 p2 | |
Every value as a command line
engine relations aircraft set --on p1
engine relations aircraft set --on p2
engine relations aircraft set --off p3
engine relations aircraft set --off p4
engine relations aircraft set --only p1
engine relations aircraft set --only p2
Used by the GUI Start: Import · Relations: Show selected in output · Relations: OnlyWhereSameMeaningCommand · Relations: Switch them all off · Relations: PasteRelationNodesCommand · Relations: Remove · Relations: Apply · Relations: OpenRelationFromSearchCommand · Binds: Move an action to another button... · Binds: Show selected in output · Dialogs and notices: Move · Dialogs and notices: Move
Example
engine relations aircraft set <relation> --node game:id --text
#engine relations check-aircraft
writtenengine relations check-aircraft [--relation <name>] [--apply] [--include-same-function]
For beginners
Finds DCS actions that are switched on for aircraft where the same command id means something else (the "Rudder" id
that is nosewheel steering in another module). --apply switches those aircraft off. The Relations page shows the
open relation's findings as a question above its actions; Check all relations lists all, and Switch them all
off runs --apply.
engine relations check-aircraft --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Only DCS actions are checked; an action of the other kind (a button in an axis relation) is counted, not listed.
--relation <name> (or the name as words) checks one relation.
- Aircraft where the function map reads the other meaning as the same function are listed but not proposed;
--include-same-function proposes them too.
--apply switches the proposed aircraft off (one profile version, one undo step); one tick in the action's aircraft
list brings one back.
Technical internals
- Output: JSON (
Relations, Nodes, Found with relation, action, meanings and Drop, AircraftToDrop,
AircraftSameFunction, Dropped), or --text. The profile is saved with --profile after --apply.
- Exit code
0; 1 only for an unknown relation name.
- Related:
engine relations aircraft set, engine relations aircraft.
What it does Actions with switched-on aircraft where the same id means something else than in the others; --apply switches those aircraft off (they stay listed).
| Option | Values | Meaning |
|---|
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--apply | switch (no value) | |
--include-same-function | switch (no value) | |
Used by the GUI Profile bar: Take them out · Relations: OnlyWhereSameMeaningCommand · Relations: ToggleProfileCheckCommand · Relations: Switch them all off · Relations: Apply
Example
engine relations check-aircraft --text
#engine relations duplicates
writtenengine relations duplicates [--keys "game|id|aircraft;..." | --node game:id --plane p1|p2] [--keep <relation> | --off | --ignore]
For beginners
Lists actions that are switched on in more than one relation for the same aircraft, so the game gets the same command
on two inputs, each with a suggestion where to keep it and how sure JoyPro is. Its options fix one card, many cards by
a rule, or many by a sentence. The Check's cards "on in several relations" come from it, and their fixes, Fix all
with a rule and Fix with AI run it.
engine relations duplicates --rule suggested --min-confidence 80 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
The actions a fix is about: --keys "game|id|aircraft;..." or --node game:id --plane p1|p2.
| Option |
Effect |
--keep <relation> |
stays on only in this relation, off in the others |
--off |
off in every relation |
--ignore |
all stay; recorded as intended and not listed again until one more relation gets the action (then it is listed with ShownAgain and NowAlsoIn); --keep-both is the old name |
--forget-kept |
the ignored ones of --keys are listed again; without keys every ignored warning (also the conflicts') |
--list-kept |
lists only the ignored ones (the app's "Ignored warnings") |
--rule <rule> |
a preview of one rule for all cards; --apply applies it |
--instruction "<words>" |
a preview from a sentence; --apply applies it |
--apply-suggested |
--rule suggested --apply |
--changes "key=>relation;key=>-" |
the ticked lines of a preview exactly as shown (- = off in all) |
- Rules:
suggested (JoyPro's suggestion, from --min-confidence 0-100), name (the one relation whose function or
name fits), first (the relation that had it first in the profile history), device:<stick|throttle|panel|pedals| collective>, relation:<words> (the one relation whose name has these words).
--instruction reads simple sentences with JoyPro's phrase rules; --llm auto (default) or on asks the local
model only for the parts the rules did not understand, off never.
- The suggestion comes from the profile history first, else from each relation's function and name.
--include-kept lists the ignored ones too (Kept). An ignored one stays hidden while these relations or fewer of
them have the action. Each fix is one profile version (one undo step); a fix also forgets ignored ones whose action
is on in one relation only now.
Technical internals
- Output: JSON (
Count, Duplicates, Groups, Changes, Understood, NotUnderstood, SwitchedOff, Resolved,
Warnings), or --text. The profile is saved with --profile only after a fix.
- Exit code
1 with relations duplicates: --keep, --off and --ignore exclude each other., relations duplicates: --rule and --instruction exclude each other., Unknown rule '...', --min-confidence needs a number from 0 to 100., ... needs the actions: --keys ... or Those actions are on in one relation only (nothing to resolve).
- Related:
engine relations conflicts, engine profile validate, engine relations merge-copies.
What it does Actions of an aircraft that more than one relation has switched on, as cards per relation pair with a suggestion and its confidence; --keep, --off or --ignore decide one, --rule or --instruction many (preview first, --apply as one undo step); --list-kept lists the ignored warnings, --forget-kept [--keys] shows them again. An ignored warning comes back when one more relation gets the action (ShownAgain, NowAlsoIn).
| Option | Values | Meaning |
|---|
--keys | switch (no value) | |
--node | switch (no value) | Node token format: game:id[:plane1|plane2]. Example: DCS:d3007pnilu3007cd16vd1vpnilvu0:F-16C_50|FA-18C_hornet. |
--plane | p1 p2 | Include one plane/module per flag. Example: --plane A-10C_2. |
--keep | <relation> | |
--off | switch (no value) | |
--ignore | switch (no value) | |
Every value as a command line
engine relations duplicates --plane p1
engine relations duplicates --plane p2
Used by the GUI Check: Show all again · Check: PreviewSureDuplicatesCommand · Check: Preview · Check: Preview · Check: Apply the ticked ones · Start: Import now · Start: Import · Start: Import · Start: Import · Start: Import · Relations: Review them · Relations: ReturnToCheckCommand
Example
engine relations duplicates [--keys "game|id|aircraft;" --text
#engine relations duplicates
writtenengine relations duplicates --list-kept | --forget-kept [--keys "game|id|aircraft;..."]
For beginners
Lists actions that are switched on in more than one relation for the same aircraft, so the game gets the same command
on two inputs, each with a suggestion where to keep it and how sure JoyPro is. Its options fix one card, many cards by
a rule, or many by a sentence. The Check's cards "on in several relations" come from it, and their fixes, Fix all
with a rule and Fix with AI run it.
engine relations duplicates --rule suggested --min-confidence 80 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
The actions a fix is about: --keys "game|id|aircraft;..." or --node game:id --plane p1|p2.
| Option |
Effect |
--keep <relation> |
stays on only in this relation, off in the others |
--off |
off in every relation |
--ignore |
all stay; recorded as intended and not listed again until one more relation gets the action (then it is listed with ShownAgain and NowAlsoIn); --keep-both is the old name |
--forget-kept |
the ignored ones of --keys are listed again; without keys every ignored warning (also the conflicts') |
--list-kept |
lists only the ignored ones (the app's "Ignored warnings") |
--rule <rule> |
a preview of one rule for all cards; --apply applies it |
--instruction "<words>" |
a preview from a sentence; --apply applies it |
--apply-suggested |
--rule suggested --apply |
--changes "key=>relation;key=>-" |
the ticked lines of a preview exactly as shown (- = off in all) |
- Rules:
suggested (JoyPro's suggestion, from --min-confidence 0-100), name (the one relation whose function or
name fits), first (the relation that had it first in the profile history), device:<stick|throttle|panel|pedals| collective>, relation:<words> (the one relation whose name has these words).
--instruction reads simple sentences with JoyPro's phrase rules; --llm auto (default) or on asks the local
model only for the parts the rules did not understand, off never.
- The suggestion comes from the profile history first, else from each relation's function and name.
--include-kept lists the ignored ones too (Kept). An ignored one stays hidden while these relations or fewer of
them have the action. Each fix is one profile version (one undo step); a fix also forgets ignored ones whose action
is on in one relation only now.
Technical internals
- Output: JSON (
Count, Duplicates, Groups, Changes, Understood, NotUnderstood, SwitchedOff, Resolved,
Warnings), or --text. The profile is saved with --profile only after a fix.
- Exit code
1 with relations duplicates: --keep, --off and --ignore exclude each other., relations duplicates: --rule and --instruction exclude each other., Unknown rule '...', --min-confidence needs a number from 0 to 100., ... needs the actions: --keys ... or Those actions are on in one relation only (nothing to resolve).
- Related:
engine relations conflicts, engine profile validate, engine relations merge-copies.
What it does Actions of an aircraft that more than one relation has switched on, as cards per relation pair with a suggestion and its confidence; --keep, --off or --ignore decide one, --rule or --instruction many (preview first, --apply as one undo step); --list-kept lists the ignored warnings, --forget-kept [--keys] shows them again. An ignored warning comes back when one more relation gets the action (ShownAgain, NowAlsoIn).
| Option | Values | Meaning |
|---|
--list-kept | switch (no value) | |
--forget-kept | switch (no value) | |
--keys | switch (no value) | |
Example
engine relations duplicates --list-kept --text
#engine relations duplicates
writtenengine relations duplicates --rule suggested|name|first|device:<kind>|relation:<words> [--min-confidence N] [--apply]
For beginners
Lists actions that are switched on in more than one relation for the same aircraft, so the game gets the same command
on two inputs, each with a suggestion where to keep it and how sure JoyPro is. Its options fix one card, many cards by
a rule, or many by a sentence. The Check's cards "on in several relations" come from it, and their fixes, Fix all
with a rule and Fix with AI run it.
engine relations duplicates --rule suggested --min-confidence 80 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
The actions a fix is about: --keys "game|id|aircraft;..." or --node game:id --plane p1|p2.
| Option |
Effect |
--keep <relation> |
stays on only in this relation, off in the others |
--off |
off in every relation |
--ignore |
all stay; recorded as intended and not listed again until one more relation gets the action (then it is listed with ShownAgain and NowAlsoIn); --keep-both is the old name |
--forget-kept |
the ignored ones of --keys are listed again; without keys every ignored warning (also the conflicts') |
--list-kept |
lists only the ignored ones (the app's "Ignored warnings") |
--rule <rule> |
a preview of one rule for all cards; --apply applies it |
--instruction "<words>" |
a preview from a sentence; --apply applies it |
--apply-suggested |
--rule suggested --apply |
--changes "key=>relation;key=>-" |
the ticked lines of a preview exactly as shown (- = off in all) |
- Rules:
suggested (JoyPro's suggestion, from --min-confidence 0-100), name (the one relation whose function or
name fits), first (the relation that had it first in the profile history), device:<stick|throttle|panel|pedals| collective>, relation:<words> (the one relation whose name has these words).
--instruction reads simple sentences with JoyPro's phrase rules; --llm auto (default) or on asks the local
model only for the parts the rules did not understand, off never.
- The suggestion comes from the profile history first, else from each relation's function and name.
--include-kept lists the ignored ones too (Kept). An ignored one stays hidden while these relations or fewer of
them have the action. Each fix is one profile version (one undo step); a fix also forgets ignored ones whose action
is on in one relation only now.
Technical internals
- Output: JSON (
Count, Duplicates, Groups, Changes, Understood, NotUnderstood, SwitchedOff, Resolved,
Warnings), or --text. The profile is saved with --profile only after a fix.
- Exit code
1 with relations duplicates: --keep, --off and --ignore exclude each other., relations duplicates: --rule and --instruction exclude each other., Unknown rule '...', --min-confidence needs a number from 0 to 100., ... needs the actions: --keys ... or Those actions are on in one relation only (nothing to resolve).
- Related:
engine relations conflicts, engine profile validate, engine relations merge-copies.
What it does Actions of an aircraft that more than one relation has switched on, as cards per relation pair with a suggestion and its confidence; --keep, --off or --ignore decide one, --rule or --instruction many (preview first, --apply as one undo step); --list-kept lists the ignored warnings, --forget-kept [--keys] shows them again. An ignored warning comes back when one more relation gets the action (ShownAgain, NowAlsoIn).
| Option | Values | Meaning |
|---|
--rule | suggested name first device | |
--min-confidence | switch (no value) | |
--apply | switch (no value) | |
Every value as a command line
engine relations duplicates --rule suggested
engine relations duplicates --rule name
engine relations duplicates --rule first
engine relations duplicates --rule device
Example
engine relations duplicates --rule suggested|name|first|device:<kind>|relation:<words> --text
#engine relations duplicates
writtenengine relations duplicates --instruction "keep trim in the Trim relations, everything else in ..." [--llm off|auto|on] [--apply]
For beginners
Lists actions that are switched on in more than one relation for the same aircraft, so the game gets the same command
on two inputs, each with a suggestion where to keep it and how sure JoyPro is. Its options fix one card, many cards by
a rule, or many by a sentence. The Check's cards "on in several relations" come from it, and their fixes, Fix all
with a rule and Fix with AI run it.
engine relations duplicates --rule suggested --min-confidence 80 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
The actions a fix is about: --keys "game|id|aircraft;..." or --node game:id --plane p1|p2.
| Option |
Effect |
--keep <relation> |
stays on only in this relation, off in the others |
--off |
off in every relation |
--ignore |
all stay; recorded as intended and not listed again until one more relation gets the action (then it is listed with ShownAgain and NowAlsoIn); --keep-both is the old name |
--forget-kept |
the ignored ones of --keys are listed again; without keys every ignored warning (also the conflicts') |
--list-kept |
lists only the ignored ones (the app's "Ignored warnings") |
--rule <rule> |
a preview of one rule for all cards; --apply applies it |
--instruction "<words>" |
a preview from a sentence; --apply applies it |
--apply-suggested |
--rule suggested --apply |
--changes "key=>relation;key=>-" |
the ticked lines of a preview exactly as shown (- = off in all) |
- Rules:
suggested (JoyPro's suggestion, from --min-confidence 0-100), name (the one relation whose function or
name fits), first (the relation that had it first in the profile history), device:<stick|throttle|panel|pedals| collective>, relation:<words> (the one relation whose name has these words).
--instruction reads simple sentences with JoyPro's phrase rules; --llm auto (default) or on asks the local
model only for the parts the rules did not understand, off never.
- The suggestion comes from the profile history first, else from each relation's function and name.
--include-kept lists the ignored ones too (Kept). An ignored one stays hidden while these relations or fewer of
them have the action. Each fix is one profile version (one undo step); a fix also forgets ignored ones whose action
is on in one relation only now.
Technical internals
- Output: JSON (
Count, Duplicates, Groups, Changes, Understood, NotUnderstood, SwitchedOff, Resolved,
Warnings), or --text. The profile is saved with --profile only after a fix.
- Exit code
1 with relations duplicates: --keep, --off and --ignore exclude each other., relations duplicates: --rule and --instruction exclude each other., Unknown rule '...', --min-confidence needs a number from 0 to 100., ... needs the actions: --keys ... or Those actions are on in one relation only (nothing to resolve).
- Related:
engine relations conflicts, engine profile validate, engine relations merge-copies.
What it does Actions of an aircraft that more than one relation has switched on, as cards per relation pair with a suggestion and its confidence; --keep, --off or --ignore decide one, --rule or --instruction many (preview first, --apply as one undo step); --list-kept lists the ignored warnings, --forget-kept [--keys] shows them again. An ignored warning comes back when one more relation gets the action (ShownAgain, NowAlsoIn).
| Option | Values | Meaning |
|---|
--instruction | switch (no value) | |
--llm | off auto on | |
--apply | switch (no value) | |
Every value as a command line
engine relations duplicates --llm off
engine relations duplicates --llm auto
engine relations duplicates --llm on
Example
engine relations duplicates --instruction "keep trim in the Trim relations, everything else in " --text
#engine relations conflicts
writtenengine relations conflicts [--keys "k;k"] [--keep <relation> | --keep-action <id> | --off | --ignore | --remove-actions | --forget-kept] [--include-kept | --list-kept]
For beginners
Lists the Check's two errors in detail and fixes them: one button that does two things in the same aircraft, or one
relation with two actions of one aircraft. The Check's fix buttons run it.
engine relations conflicts --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
InputConflicts: one input, several relations, same aircraft. ActionConflicts: one relation, two actions of one
aircraft.
- A fix names its conflicts with
--keys "k;k" (the Key of each; for --remove-actions game|id|aircraft) and
takes exactly one of:
--keep <relation>: the input stays only in that relation, the aircraft is switched off in the others;
--keep-action <id>: keeps one action of the relation;
--off: switches all of them off;
--ignore (formerly --keep-both): records it as intended (KeptDuplicates); not listed again until one more
relation joins the input (one more action the relation), then it is listed with ShownAgain and NowAlsoIn;
--remove-actions: takes unknown actions out.
--include-kept also lists the ignored ones (Kept), --list-kept only them; --forget-kept [--keys] lists them
again (without keys every ignored conflict). A fix also forgets ignored conflicts that are gone.
- Each fix is one profile version (one undo step).
What it does The check's errors in detail: an input bound in several relations that have an action of the same aircraft on, and a relation with two actions of one aircraft on; --keep, --keep-action, --off, --ignore or --remove-actions fix them (one undo step each); --list-kept lists the ignored ones, --forget-kept [--keys] shows them again. An ignored one comes back when one more relation or action joins.
| Option | Values | Meaning |
|---|
--keys | switch (no value) | |
--keep | <relation> | |
--keep-action | <id> | |
--off | switch (no value) | |
--ignore | switch (no value) | |
--remove-actions | switch (no value) | |
--forget-kept | switch (no value) | |
--include-kept | switch (no value) | |
--list-kept | switch (no value) | |
Used by the GUI Relations: Review them · Relations: ReturnToCheckCommand · Check: Check now · Export: Validate Profile
Example
engine relations conflicts [--keep <relation> --text
#engine relations merge-copies
writtenengine relations merge-copies [--dry-run] [--name <relation>]
For beginners
Merges relations an import copied ("Gear", "Gear__1", "Gear__2" ...) that have the same bind back into one relation.
Such copies came from devices Windows gave new IDs over time. The Check's cards for copied relations offer Merge into
one and Merge all copied relations; the Check finds them with --dry-run.
engine relations merge-copies --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- A copy family is
<name> and <name>__N with the same device, input, kind and modifiers. The same device under
another Windows ID counts as the same device unless two of those IDs are connected at once.
- The merged relation gets every action and aircraft of the copies and their groups; each copy's axis tuning becomes
the tuning of its aircraft. The copies are removed.
--name <relation> merges only the family of that name (or of one of its copies). --dry-run only lists.
- One profile version (one undo step); nothing to merge writes no version.
Technical internals
- Output: JSON (
Count, CopiesRemoved, relations and binds before and after, Families with the relation, copies,
device, input and aircraft), or --text. The profile is saved with --profile after a merge.
- Exit code
0; 1 for an unknown argument.
- Related:
engine relations duplicates.
What it does Merges relations an import copied ('<name>__N' with the same device, input and modifiers as '<name>') back into one: aircraft, groups and per-aircraft tuning; one undo step. --dry-run lists them only.
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
--name | <relation> | Name value for commands that create/merge entities. Example: --name 'Merged Startup'. |
Used by the GUI Relations: Review them · Relations: ReturnToCheckCommand · Check: Check now · Export: Validate Profile
Example
engine relations merge-copies --text
#engine relations join-inputs
writtenengine relations join-inputs [--game <id>] [--relation <name>] [--apply]
--apply not with --multi-bind off: relations that do the same (the same actions with the same aircraft on) on other inputs become one relation with several inputs; without --apply a preview; an import names them when the setting is on
For beginners
Relations that do exactly the same (the same actions with the same aircraft on) on other inputs become one relation
with several inputs. An import names them ("keep each as one relation with several inputs?").
engine relations join-inputs --game DCS --apply --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Without
--apply a preview. The relation kept is one without a copy suffix, else the shortest name; the others'
inputs become its extra inputs, their groups join it, and they are removed (one undo step).
What it does --apply not with --multi-bind off: relations that do the same (the same actions with the same aircraft on) on other inputs become one relation with several inputs; without --apply a preview; an import names them when the setting is on.
| Option | Values | Meaning |
|---|
--game | <id> | Game filter value. Example: DCS or IL2Game. |
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--apply | switch (no value) | |
Example
engine relations join-inputs --text
#engine relations meanings
writtenengine relations meanings [--game g] [--top N]
For beginners
A statistic of the game lists: per game, how many command ids several aircraft share and how many of those mean
something else in some aircraft, with the ids that have the most meanings. It explains why JoyPro checks the meaning
of an id per aircraft. It changes nothing.
engine relations meanings --game DCS --top 10 --text
Advanced
--game <id>: one game. --top N: the number of example ids (default 20).
- Each example lists up to 6 meanings (title and category) with up to 6 aircraft each; the first is the most common
meaning.
- The rule for same, near and different is the one of
engine relations aircraft. Read-only; no profile is needed.
Technical internals
- Output: JSON (
Games with lists, ids, shared ids, ids with other meanings, aircraft entries left out, ids with near
variants; Examples), or --text (one line per game, then <game>:<id> (<n> meanings) with the titles and
aircraft).
- Exit code
1 with --top needs a number. or Unknown relations meanings argument(s): ....
- Related:
engine relations check-aircraft, engine relations aircraft.
What it does Per game: ids shared by several aircraft lists and how many of them mean something else in some aircraft.
| Option | Values | Meaning |
|---|
--game | switch (no value) | Game filter value. Example: DCS or IL2Game. |
--top | switch (no value) | |
Example
engine relations meanings --text
#engine relations action-info
writtenengine relations action-info --coverage [--game g] [--all-examples]
For beginners
A report for maintainers: per game, how many actions have a readable name, how many have an explanation and how many
functions have a clear recommended action. It shows where names and texts are still missing. It changes nothing.
engine relations action-info --coverage --game DCS --text
Advanced
--coverage is needed (it is the only report). --game <id>: one game.
- Readable: the game's own name, or one JoyPro makes from an id or event name. Explained: by the cockpit guide, the
game's own description, JoyPro's text or the general text of the function.
- Up to 6 examples per game of unexplained abbreviations and up to 4 of "word plus axis" names;
--all-examples lists
all of them.
- Read-only; no profile is needed.
Technical internals
- Output: JSON (
Games with the counts and examples, Warnings), or --text (one line per game with percentages,
then abbreviation: and word+axis: examples).
- Exit code
1 with the usage line relations action-info --coverage [--game g] [--all-examples] without
--coverage or with another argument.
- Related:
engine relations functions, engine relations pair.
What it does Per game: actions with a readable name, titles with unexplained abbreviations, explanations and functions with a recommended action.
| Option | Values | Meaning |
|---|
--coverage | switch (no value) | |
--game | switch (no value) | Game filter value. Example: DCS or IL2Game. |
--all-examples | switch (no value) | |
Example
engine relations action-info --coverage --text
#engine relations auto-group
writtenengine relations auto-group [--preset all|wing|era|purist] [--no-substitutes] [--planes p1|p2|Game] [--replace] [--dry-run] [--no-map]
--replace first removes the relations tagged AutoGroup (an earlier Auto Group) with their binds; your other relations stay
For beginners
Puts the same function of every DCS aircraft and every other supported game into one relation, so one button does it
everywhere (for example "CMS forward" of the F-16, the Hornet, BMS and Star Citizen). It uses JoyPro's function catalog
and your own habits, without AI. Relations > Auto-build relations from all my actions... > By function (Auto
Group): Preview runs it with --dry-run, Apply without.
engine relations auto-group --preset all --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--preset |
Relations |
all (default) |
one relation per function for all aircraft |
wing |
split into fixed wing and helicopters |
era |
split by wing type and era; spaceships form their own group |
purist |
only the basic flight controls shared; every other function one relation per aircraft |
--no-substitutes: an aircraft without the function stays without it (default: the slot takes your habit from at
least two own decisions, else the catalog's substitute at the same position).
--planes p1|p2|Game: only these aircraft or games (a game id like StarCitizen counts).
--no-map: only the catalog, not the function map's actions it does not list.
--replace: removes the relations of earlier runs (group AutoGroup, with their binds) first; your own relations
are never removed.
- Existing relations of a function keep their binds and only get missing aircraft. A command you use in another
relation stays there ("Kept"); commands you switched off stay off; an aircraft never gets two actions on in relations
on the same input.
- New relations get the group
AutoGroup. One profile version (one undo step); --dry-run changes nothing.
Technical internals
- Output: JSON (counts of created, extended and removed relations, actions added, the kept ones by reason, aircraft and
commands missing in the database,
Relations), or --text. The profile is saved with --profile unless
--dry-run.
- Exit code
1 with Invalid --preset value: ..., Unknown relations auto-group argument(s): ... or Function catalog file missing: ... (update JoyPro).
- Data:
DB\Functions (slots.json, aircraft.json, <Game>.tsv). Reference: auto-group. Related:
engine relations from-text (only what a sentence names), engine relations auto-assign (put them on buttons).
What it does Groups the same function of all DCS aircraft and the other games into relations (function catalog DB/Functions plus the function map). Existing relations of the same name get the missing aircraft, commands already used in another relation stay there; --replace first removes the relations tagged AutoGroup (an earlier Auto Group) and their binds, your other relations stay.
| Option | Values | Meaning |
|---|
--preset | all wing era purist | |
--no-substitutes | switch (no value) | |
--planes | p1 p2 Game | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--replace | switch (no value) | First remove the relations tagged AutoGroup (made by an earlier Auto Group) and their binds; every other relation stays. |
--dry-run | switch (no value) | Show what Auto Group would create and change; the profile is not changed. |
--no-map | switch (no value) | |
Every value as a command line
engine relations auto-group --preset all
engine relations auto-group --preset wing
engine relations auto-group --preset era
engine relations auto-group --preset purist
engine relations auto-group --planes p1
engine relations auto-group --planes p2
engine relations auto-group --planes Game
Used by the GUI Relations: Preview · Relations: Apply
Example
engine relations auto-group --text
#engine relations from-text
writtenengine relations from-text "<request>" [--games g1|g2] [--planes p1|p2] [--llm off|auto|on] [--substitutes] [--select <relation>]... [--skip-node game:id:plane1|plane2]... [--name <name>] [--min-confidence 0..1] [--dry-run]
For beginners
Makes relations from a description in your words, for example "speed brake in and out on all jets" or "CMS forward for
all DCS jets except the A-10". Offline rules read the sentence; the optional local AI model helps with unusual
wording. Relations > Auto-build relations from all my actions... > By description: Preview runs it with
--dry-run, Create makes the ticked relations.
engine relations from-text "speed brake in and out on all jets" --dry-run --llm off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- One relation per function and direction, named after it and the aircraft ("Speed Brake Out (jets)"), with a
confidence and an explanation per aircraft.
--name <name> names it (with several relations: <name> - <function>).
--games g1|g2 and --planes p1|p2 limit the aircraft; --substitutes also takes the catalog's stand-ins.
--select <relation> (repeatable) creates only those relations; --skip-node game:id:planes (repeatable) leaves
single commands out; --min-confidence 0..1 (default 0.5) drops weaker ones.
--llm auto (default when the model is switched on, else off) asks the model only when the rules found no
function, used catalog words or left words not understood; on always asks; off never. The model only picks from
JoyPro's lists; JoyPro checks every id.
- Like Auto Group: an existing relation of that name gets the missing aircraft, a command used in another relation
stays there, switched-off commands stay off; new relations get the group
FromText.
--show-prompt [--prompt-model <model>|local] prints the model's prompt and grammar without running a model.
relations from-text --check tests DB\Functions\language.json against the catalog.
--dry-run only shows. Otherwise one profile version (one undo step).
Technical internals
- Output: JSON (proposals with their actions, confidence and explanations, understood and not understood words, the
model's part), or
--text; the result is printed before a failure. The profile is saved with --profile unless
--dry-run or --check.
- Exit code
1 with No function recognised in "...", No aircraft or game matches "...", Invalid --min-confidence value: ..., Invalid --llm value: ..., with --llm on and no usable model, or (--check) when the
vocabulary has errors.
- Reference: natural-language-grouping. Related:
engine relations auto-group, engine llm.
What it does Group by description: offline rules pick the functions and aircraft of a request, the function catalog gives the commands, each with a confidence; the optional local model may re-pick from the offline candidates. --check tests the vocabulary, --show-prompt prints the model's prompt only.
| Option | Values | Meaning |
|---|
--games | g1 g2 | Game filter values as CSV. Example: DCS,IL2Game,StarCitizen. |
--planes | p1 p2 | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--llm | off auto on | |
--substitutes | switch (no value) | |
--select | <relation> | |
--skip-node | switch (no value) | |
--name | <name> | Name value for commands that create/merge entities. Example: --name 'Merged Startup'. |
--min-confidence | 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 relations from-text --games g1
engine relations from-text --games g2
engine relations from-text --planes p1
engine relations from-text --planes p2
engine relations from-text --llm off
engine relations from-text --llm auto
engine relations from-text --llm on
Used by the GUI Relations: Preview · Relations: Create
Example
engine relations from-text "<request>" --text
#engine relations from-text
writtenengine relations from-text --check
Tests the vocabulary in DB/Functions/language.json against the catalog
For beginners
Makes relations from a description in your words, for example "speed brake in and out on all jets" or "CMS forward for
all DCS jets except the A-10". Offline rules read the sentence; the optional local AI model helps with unusual
wording. Relations > Auto-build relations from all my actions... > By description: Preview runs it with
--dry-run, Create makes the ticked relations.
engine relations from-text "speed brake in and out on all jets" --dry-run --llm off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- One relation per function and direction, named after it and the aircraft ("Speed Brake Out (jets)"), with a
confidence and an explanation per aircraft.
--name <name> names it (with several relations: <name> - <function>).
--games g1|g2 and --planes p1|p2 limit the aircraft; --substitutes also takes the catalog's stand-ins.
--select <relation> (repeatable) creates only those relations; --skip-node game:id:planes (repeatable) leaves
single commands out; --min-confidence 0..1 (default 0.5) drops weaker ones.
--llm auto (default when the model is switched on, else off) asks the model only when the rules found no
function, used catalog words or left words not understood; on always asks; off never. The model only picks from
JoyPro's lists; JoyPro checks every id.
- Like Auto Group: an existing relation of that name gets the missing aircraft, a command used in another relation
stays there, switched-off commands stay off; new relations get the group
FromText.
--show-prompt [--prompt-model <model>|local] prints the model's prompt and grammar without running a model.
relations from-text --check tests DB\Functions\language.json against the catalog.
--dry-run only shows. Otherwise one profile version (one undo step).
Technical internals
- Output: JSON (proposals with their actions, confidence and explanations, understood and not understood words, the
model's part), or
--text; the result is printed before a failure. The profile is saved with --profile unless
--dry-run or --check.
- Exit code
1 with No function recognised in "...", No aircraft or game matches "...", Invalid --min-confidence value: ..., Invalid --llm value: ..., with --llm on and no usable model, or (--check) when the
vocabulary has errors.
- Reference: natural-language-grouping. Related:
engine relations auto-group, engine llm.
What it does Group by description: offline rules pick the functions and aircraft of a request, the function catalog gives the commands, each with a confidence; the optional local model may re-pick from the offline candidates. --check tests the vocabulary, --show-prompt prints the model's prompt only.
| Option | Values | Meaning |
|---|
--check | switch (no value) | |
Example
engine relations from-text --check --text
#engine relations from-text
writtenengine relations from-text "<request>" --show-prompt [--prompt-model <model>|local]
For beginners
Makes relations from a description in your words, for example "speed brake in and out on all jets" or "CMS forward for
all DCS jets except the A-10". Offline rules read the sentence; the optional local AI model helps with unusual
wording. Relations > Auto-build relations from all my actions... > By description: Preview runs it with
--dry-run, Create makes the ticked relations.
engine relations from-text "speed brake in and out on all jets" --dry-run --llm off --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- One relation per function and direction, named after it and the aircraft ("Speed Brake Out (jets)"), with a
confidence and an explanation per aircraft.
--name <name> names it (with several relations: <name> - <function>).
--games g1|g2 and --planes p1|p2 limit the aircraft; --substitutes also takes the catalog's stand-ins.
--select <relation> (repeatable) creates only those relations; --skip-node game:id:planes (repeatable) leaves
single commands out; --min-confidence 0..1 (default 0.5) drops weaker ones.
--llm auto (default when the model is switched on, else off) asks the model only when the rules found no
function, used catalog words or left words not understood; on always asks; off never. The model only picks from
JoyPro's lists; JoyPro checks every id.
- Like Auto Group: an existing relation of that name gets the missing aircraft, a command used in another relation
stays there, switched-off commands stay off; new relations get the group
FromText.
--show-prompt [--prompt-model <model>|local] prints the model's prompt and grammar without running a model.
relations from-text --check tests DB\Functions\language.json against the catalog.
--dry-run only shows. Otherwise one profile version (one undo step).
Technical internals
- Output: JSON (proposals with their actions, confidence and explanations, understood and not understood words, the
model's part), or
--text; the result is printed before a failure. The profile is saved with --profile unless
--dry-run or --check.
- Exit code
1 with No function recognised in "...", No aircraft or game matches "...", Invalid --min-confidence value: ..., Invalid --llm value: ..., with --llm on and no usable model, or (--check) when the
vocabulary has errors.
- Reference: natural-language-grouping. Related:
engine relations auto-group, engine llm.
What it does Group by description: offline rules pick the functions and aircraft of a request, the function catalog gives the commands, each with a confidence; the optional local model may re-pick from the offline candidates. --check tests the vocabulary, --show-prompt prints the model's prompt only.
| Option | Values | Meaning |
|---|
--show-prompt | switch (no value) | |
--prompt-model | <model> | |
Example
engine relations from-text "<request>" --show-prompt --text
#engine relations auto-assign
writtenengine relations auto-assign [--grip <device|VID:PID>=<grip id>]... [--add-device <catalog id>]... [--ignore-device <device>]... [--relation <name>]... [--max-modifiers 0|1|2] [--phase-layers on|off|auto] [--overwrite [--include-missing]] [--no-style] [--explain <relation>]... [--dry-run]
For beginners
Binds your unbound relations to fitting controls of your devices: TMS on the TMS hat, gear on the gear lever, trim on
the trim hat. It works for any set of devices and runs without AI, from JoyPro's device catalog and function catalog.
Binds > Put relations on my buttons automatically...: Preview runs it with --dry-run, Explain Selected
with --explain, Apply without.
engine relations auto-assign --max-modifiers 1 --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
- Devices: connected devices are matched by VID:PID and name;
--grip "<device or VID:PID>=<grip id>" picks the grip
of a base; --add-device <catalog id> adds a device that is not connected (on a placeholder device);
--ignore-device <device> leaves one out. One device per hand: a second stick of the same hand is left out.
--relation <name> (repeatable): only these relations.
--max-modifiers 0|1|2 (default 2): shift layers at most, only when the busiest aircraft has more grip functions
than grip buttons, and only for games that read modifier binds.
--phase-layers auto|on|off (default auto): a latched switch as air-to-air / air-to-ground mode switch.
--overwrite: lays out the bound relations again (keyboard, virtual devices and unplugged devices stay);
--include-missing also moves binds of devices that are not connected.
--no-style: ignores your previous controls (default: a relation goes back on its old control first).
--explain <relation>: the best candidates with score and what occupies them.
- Bound relations keep their binds. One input serves several relations only when they share no aircraft.
- One profile version (one undo step);
--dry-run changes nothing.
Technical internals
- Output: JSON (devices as recognised,
Assignments, Unassigned, modifiers, explanations), or --text
(Assigned: <n>, relation => device input + modifier (control), Not Assigned (no fitting free input):). The
profile is saved with --profile unless --dry-run.
- Exit code
1 with --grip expects "<device or VID:PID>=<grip id>"., --max-modifiers takes 0, 1 or 2.,
--phase-layers takes on, off or auto. or No usable device: connect your devices or add them from the catalog (--add-device).
- Data:
DB\Devices\*.json, DB\Functions\slot_controls.tsv. Reference: auto-assign. Related:
engine devices kb, engine setup plan, engine arrange ask.
What it does Binds the relations to the best physical controls of your devices (device catalog, function positions); existing binds stay unless --overwrite; at most 2 modifier layers; one device per hand; --explain lists the best candidates of a relation; --dry-run previews.
| Option | Values | Meaning |
|---|
--grip | <device|VID:PID> | |
--add-device | <catalog id> | |
--ignore-device | <device> | Exclude one device per flag. Example: --ignore-device Keyboard. |
--relation | <name> | Select one relation per flag for mass operations. Example: --relation 'Trim Pitch'. |
--max-modifiers | 0 1 2 | |
--phase-layers | on off auto | |
--overwrite | switch (no value) | |
--include-missing | switch (no value) | |
--no-style | switch (no value) | |
--explain | <relation> | |
--dry-run | switch (no value) | Report what the command would do; nothing is written or changed. |
Every value as a command line
engine relations auto-assign --max-modifiers 0
engine relations auto-assign --max-modifiers 1
engine relations auto-assign --max-modifiers 2
engine relations auto-assign --phase-layers on
engine relations auto-assign --phase-layers off
engine relations auto-assign --phase-layers auto
Used by the GUI Binds: Preview · Binds: Explain Selected · Binds: Apply
Example
engine relations auto-assign --text