JoyPro2 Discord GitHub
Engine (CLI)

engine support

Show:

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

#engine support bundle

written
engine support bundle [--game <id>] [--days <n>] [--include-profile true|false] [--history-cap-mb <n>] [--list] --out <file.zip>

The support file: logs (at least 14 days, back to the profile's oldest history version, at most 100 MB), errors, JoyPro's settings and state, devices with vJoy/HidHide, the games' environment, backups and JoyPro's copies of their config files; with --profile and --include-profile true (the default then) also the open profile, its history, the games' current bind files and JoyPro 1's profiles (Documents\JoyPro); user folder replaced, nothing uploaded; --list only shows the contents

For beginners

Writes the support file: one zip with what is needed to find a problem. Create Report in Settings > Report a problem runs it: first with --list to show what goes in, then to write the zip. Nothing is uploaded; you send the zip yourself.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --out "C:\Users\Pilot\Desktop\JoyPro2-support.zip" support bundle --include-profile true
Advanced
  • Always in it: summary.txt (versions, system, JoyPro's folders, per game the environment, the devices, every part with its size and what was trimmed), JoyPro's logs (at least the last 14 days, back to the open profile's oldest history version, at most 100 MB, the oldest trimmed first), crash reports and the last errors, JoyPro's settings and state files, the devices with the vJoy / HidHide state, and per game the watcher's record and JoyPro's backups.
  • --include-profile true|false (default true when --profile is given): also the open profile, its history, the games' current bind files and JoyPro 1's profiles (Documents\JoyPro).
  • --days <n>: logs of at least the last n days (default 14). --history-cap-mb <n>: most megabytes of history copies (default 50, newest first; summary.txt names the ones left out). --game <id>: only that game's part.
  • --list only prints what the zip would hold; nothing is written.
  • Every text is cleaned: the user folder becomes %USERPROFILE%, user and PC names, e-mail addresses and secrets are removed. The originals are only read.
Technical internals
  • --out <file.zip> is the zip itself (required unless --list). The report of the parts goes to stdout as JSON (Zip, ListOnly, Days, LogsFrom, IncludeProfile, Profile, history counts, parts) or text with --text.
  • Exit code 0; 1 with the reason on stderr: engine support bundle needs --out <zip> (or --list to see what it would hold)., --include-profile takes true or false, not ..., --history-cap-mb takes a number of megabytes, not ... or an unknown option.
  • Related: engine games devices, engine backups list.

What it does Writes the support file (docs/logging.md "Support file"), everything a maintainer needs in one zip: summary with versions, system, the games' environment, the devices, every part with its size and what was trimmed; JoyPro's logs (GUI, engine, tray and watcher, force feedback) of at least 14 days and back to the oldest history version of the open profile, at most 100 MB, the oldest trimmed first; crash reports and the last errors with stack traces; JoyPro's settings and state files, the versions of the game lists and installed packs; devices and the vJoy / HidHide state; per game the watcher's record, the list of JoyPro's backups and the newest set, for MSFS the profiles JoyPro reads. With --profile and --include-profile true (the default when --profile is given) also the open profile, its history (the newest versions up to --history-cap-mb, default 50, plus the whole index) and the games' current bind files with JoyPro's .jp / .joypro-meta.json files. Every text is scrubbed (user folder -> %USERPROFILE%), the profile copies inside their strings; originals are only read; nothing is uploaded. --list only prints the parts and entries.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--days<n>For support bundle: logs and crash reports of at least the last N days (default 14; older ones when the open profile's history goes further back).
--include-profiletrue falseFor support bundle: true puts the open profile (--profile), its history, the games' current bind files and JoyPro 1's profiles (Documents\JoyPro\*.pr0file) in; false leaves them out. Default: true when --profile is given.
--history-cap-mb<n>For support bundle: the most megabytes of stored history copies (default 50); the newest versions go in, summary.txt names the ones left out. Example: 50.
--listswitch (no value)For support bundle: only print what the zip would hold; nothing is written.
--out<file.zip>Global option: write result output to file path instead of terminal.
Every value as a command line
engine support bundle --include-profile true
engine support bundle --include-profile false

Used by the GUI Settings: Create Report

Example

engine support bundle --list --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' --out 'C:\JoyPro\JoyPro2-support.zip' support bundle --text
engine support bundle --game MSFS2024 --include-profile false --out 'C:\JoyPro\JoyPro2-support.zip'

#engine support unpack

written
engine support unpack <file.zip> --to <folder>

Unpacks a support file someone sent: the profile to <folder>\profile, its history where profile history restore finds it with JOYPRO_DATA_DIR=<folder>\data

For beginners

A helper for maintainers: unpacks a support file that someone sent, so its profile and profile history can be looked at and restored in a separate folder. Nothing of the JoyPro on this PC is touched.

engine support unpack "C:\Users\Pilot\Desktop\JoyPro2-support.zip" --to "C:\Users\Pilot\Desktop\case1" --text
Advanced
  • <file.zip> (the support file of engine support bundle) and --to <folder> are required.
  • The whole zip goes to <folder>\support, the profile to <folder>\profile, its history to <folder>\data\ProfileHistory\<id of that path>, with the history pointed at the copy.
  • Then, with the data folder set to the copy ($env:JOYPRO_DATA_DIR = '<folder>\data'), engine profile history, engine profile history show and engine profile history restore work on the copy; the text output prints these lines.
  • Files of the same name in the target folder are overwritten. Entries that would land outside the folder stop the command.
Technical internals
  • Output: JSON (Support, Profile, DataFolder, HistoryFolder, HistoryFiles), or text with --text (Unpacked: ..., Profile: ..., History: ..., the next commands; This support file holds no profile. when it has none). Exit code 0.
  • Exit code 1 on stderr: Use: engine support unpack <support zip> --to <folder>. or Support file not found: <file>.
  • See logging ("Restoring a version from a support file").

What it does For maintainers: unpacks a support file to <folder>\support, the profile to <folder>\profile and its history to <folder>\data\ProfileHistory\<id of that path>, so engine profile history list / show / restore work on the copy with JOYPRO_DATA_DIR=<folder>\data (docs/logging.md "Restoring a version from a support file"). Nothing of this PC's JoyPro is touched.

OptionValuesMeaning
--to<folder>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.

Example

engine support unpack 'C:\Cases\JoyPro2-support-20261026-170635.zip' --to 'C:\Cases\case1' --text