Telemetry recording, docs/telemetry-recording.md: the games, what JoyPro listens to, ACMI possible
For beginners
Lists the games whose telemetry JoyPro can record (like a flight recorder for each round, mission or flight), what
JoyPro listens to for each one, whether a recording can become a Tacview file, and whether the game is recorded now.
engine telemetry games --text
Advanced
Ten games: DCS World, IL-2 Great Battles, IL-2 Series: Korea, War Thunder, X-Plane 12, X-Plane 11, Microsoft Flight
Simulator 2024 and 2020, Falcon BMS and Elite Dangerous.
Per game: the way JoyPro reads it (for example UDP 41992 (JoyPro's DCS hook), HTTP 127.0.0.1:8111 (the game's local web server), SimConnect through your own SimConnect.dll, BMS's shared memory, Elite's Status.json and
journal), the game's processes, ACMI yes or no (IL-2 and Elite send no position, so no Tacview export), and what has
to be set up once (DCS: JoyPro's hook; IL-2: JoyPro's address in startup.cfg, both on the Force Feedback page,
engine ffb telemetry setup).
"Recorded" is true when recording is switched on and the game is not switched off for it
(engine telemetry config set).
Read-only; no option except the global --text (and --folder, which changes nothing here).
Technical internals
Output: JSON (Enabled, Games with Id, Title, Transport, ProcessNames, Acmi, Setup, Recorded), or
with --text "Telemetry recording is on|off. Games with telemetry: " and two lines per game ([recorded] behind
the recorded ones).
Exit code 0; 1 with Unknown telemetry games argument(s): ....
Settings read from %LOCALAPPDATA%\JoyPro2\Telemetry\telemetry-recording.json (with JOYPRO_DATA_DIR:
<data>\Telemetry\); a file that cannot be read means the defaults (recording off).
Shows the telemetry recording settings: whether recording is on, where the sessions go, how much space they may take,
how long they are kept, the values per second and the per-game switches. It is what Settings > Telemetry recording
in the GUI edits.
engine telemetry config show --text
Advanced
The values, with their defaults: enabled false, folder "" (= <data>\Telemetry\Recordings), maxTotalMb
4096 (0 = no size cap), keepDays 0 (= keep), sampleHz 20 (0 = every frame the game sends), keepRaw true,
sessionTimeoutSeconds 60, and games with enabled per game (a game without an entry is recorded when the
global switch is on).
Values out of range are shown clamped (for example the session timeout to 5..3600 s), as the recorder uses them.
Read-only. engine telemetry config without show or set shows too.
Technical internals
Output: JSON (ConfigPath, Folder = the recordings folder in use, Config, Warnings), or with --text the
settings as indented JSON.
Exit code 0; 1 with Unknown telemetry config argument(s): .... A settings file that cannot be read gives the
warning The telemetry recording settings could not be read (...); the defaults apply.
File: %LOCALAPPDATA%\JoyPro2\Telemetry\telemetry-recording.json (<data> = JOYPRO_DATA_DIR when set).
engine telemetry config set [--game <game>] --param enabled|folder|max-total-mb|keep-days|sample-hz|keep-raw|session-timeout=<value>...
For beginners
Changes the telemetry recording settings, for example switches recording on. Recording is off until you do this (or
switch it on in Settings > Telemetry recording); while it is off nothing is recorded or polled.
--param key=value, as often as needed (_ in a key counts as -):
Key
Value
enabled
true or false: the global switch
folder
the recordings folder, any drive; empty (folder=) = the default <data>\Telemetry\Recordings
max-total-mb
space for recordings in MB, 0 = no cap (at most 10000000)
keep-days
delete sessions older than this, 0 = keep (at most 100000)
sample-hz
frames per second written, 0 = every frame the game sends (at most 1000); events are always kept
keep-raw
true or false: also keep what the game sent unprocessed
session-timeout
seconds without telemetry that end a session (5..3600; a longer pause starts a new one)
--game <game> switches one game: then only --param enabled=true|false is allowed. The game is a recording game
id or a short name (il2, korea, wt, xp12, xp11, msfs, bms, elite; see engine telemetry games).
Numbers are clamped to their range; the file is written once at the end, only when every parameter was valid.
Safety: only the settings file changes; no recording is deleted here (the new space and age limits apply at the
next session start, or now with engine telemetry prune, engine telemetry recover). A running recorder of the GUI
reads the file again when the GUI tells it to.
Technical internals
Output: JSON (ConfigPath, Changes, Warnings, Config), or with --text "Telemetry recording settings:
" and one line per change.
Exit code 0; 1 (nothing written) with telemetry config set needs --param key=value (...), --param needs key=value: ..., <key> must be true or false., <key> must be a number >= 0., Unknown telemetry setting '<key>' (...), With --game only enabled=true|false can be set., JoyPro records no telemetry of '<game>'. See: engine telemetry games. or Unknown telemetry config argument(s): ....
File: %LOCALAPPDATA%\JoyPro2\Telemetry\telemetry-recording.json (<data> = JOYPRO_DATA_DIR when set),
written through a temporary file.
What it does Sets telemetry recording settings: enabled, folder, max-total-mb, keep-days, sample-hz, keep-raw, session-timeout; with --game the game's own enabled switch.
Lists the recorded sessions, newest first: date, game, aircraft, duration and size. The number in front of each one
can be used as <session> in the other telemetry commands.
engine telemetry sessions --game DCS --text
Advanced
--game <game> shows the sessions of one game (a recording game id or short name, see engine telemetry games).
--folder <folder> lists another folder than the one of the settings (for example recordings copied from another
PC).
A session still being written is marked [recording], one cut off by a crash [unfinished]
(engine telemetry recover finishes it).
Read-only. engine telemetry alone, and engine telemetry list, do the same.
Technical internals
Output: JSON (Folder, TotalBytes, Sessions with Path, FileName, Game, GameTitle, Created,
CreatedLocal, DurationSeconds, Duration, SizeBytes, Size, Aircraft, Maps, Frames, Events,
RawPackets, Channels, Complete, Recording, EndReason, Acmi; then Problems, Warnings), or with
--text "Recorded sessions in : ()" and one numbered line per session.
Exit code 0 (a file that cannot be read is listed as a problem); 1 with Unknown telemetry sessions argument(s): .... A --game JoyPro does not record lists nothing.
Files: *.jptel in the folder, named like 2026-10-18_14-03-22_DCS.jptel (local start time and game).
engine telemetry show <session> [--folder <folder>]
<session> = path, file name, latest or a number of the list
For beginners
Shows one recorded session: game, aircraft, map, start, duration, size, what it holds (frames, events, raw data),
why it ended, whether a Tacview export is possible, and its channels by category.
engine telemetry show latest --text
Advanced
<session>: a path to a .jptel file, a file name in the recordings folder (with or without .jptel), latest,
or a number of engine telemetry sessions (1 = newest).
--folder <folder> looks in another folder than the one of the settings.
The whole file is read once to count the events by kind. Read-only.
Technical internals
Output: JSON (Session as in the sessions list, Header, Summary, Nav = where the game's position and
attitude are, Channels with Key, Title, Unit, Category, Min, Max, and Events = count per kind), or
with --text a few lines ("ACMI export: yes" or "no (no position in this game's telemetry)", the channels grouped
by category with their units, the event kinds by count).
Exit code 0; 1 with Which session? A path, a file name, "latest" or a number from: engine telemetry sessions --text, No recorded session '<x>' in <folder>. or Unknown telemetry show argument(s): ....
Turns a recorded session into a file for Tacview (ACMI 2.2) or into CSV tables for a spreadsheet. The GUI's Export
for Tacview (ACMI) and Export CSV in Settings > Telemetry recording do the same.
<session>: path, file name, latest or a number of engine telemetry sessions; --folder <folder> looks in
another folder.
--format (default acmi-zip):
acmi-zip: a .zip.acmi (a zip with one .txt.acmi); zip and zip.acmi mean the same.
acmi: a plain .txt.acmi; txt.acmi and text mean the same.
csv: a folder with <session>.csv (time and every channel, one row per frame), <session>-events.csv,
<session>-channels.csv (key, title, unit, category, range) and, unless --no-per-channel, one file per channel
in <session>-channels\ with time and value at every change.
--to <file or folder>: where it goes (a file for ACMI, a folder for CSV). Default: Exports\ beside the session,
<session>.zip.acmi, <session>.txt.acmi or <session>-csv\. An existing file of that name is replaced.
--max-hz <n>: at most this many frames a second (ACMI default 20; CSV default every frame, and it thins only the
main table, not the per-channel files). A value that is not a number means the default.
ACMI needs a position: sessions of IL-2 and Elite Dangerous (and any session without a frame with a position) can
only go to CSV. War Thunder has no map coordinates, so it is placed on a flat world around 0/0.
Safety: the session itself is never changed; the ACMI file is written to a temporary file first.
Technical internals
Output: JSON (Session, Format, Output, Files, Frames, Rows, Objects, Warnings), or with --text
"Exported as : ( rows, other objects)" and the warnings.
Exit code 0; 1 with --format acmi|acmi-zip|csv, This recording has no position (<game> does not send one): ACMI needs one. Export CSV instead., This recording has no frame with a position ..., a session that cannot be
found (as for engine telemetry show) or Unknown telemetry export argument(s): ....
The global --out is the engine's output file as with every command; the export target is --to.
What it does Writes the profile's binds for this game. Only the flight actions JoyPro manages are changed, the game must be closed, and the game's files are backed up first (engine backups). Without a command list yet it first builds the list from the game.
Option
Values
Meaning
--format
acmiacmi-zipcsv
Format selector. Example values: dcs/il2 for binds unbind, rl/json for relations mass export.
--to
<file or 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.
Reads a few channels of a recorded session reduced to a short series each, for a small timeline. Without a choice it
takes altitude, speed and G (or pitch, roll, throttle, angle of attack), as the timeline in Settings > Telemetry
recording does.
<session>: path, file name, latest or a number of engine telemetry sessions; --folder <folder> looks in
another folder.
--channel <key> (repeatable): the channels to read, by the keys engine telemetry show lists. A key the session
does not have is left out without a message. Without --channel: the first three channels with values among
altitude, speed, G, pitch, roll, throttle and angle of attack, else the first channels of the session.
--points <n> (default 200, 4..5000; not a number = 200): about this many points per channel. Each time bucket
keeps its minimum and maximum, so peaks stay visible.
Read-only.
Technical internals
Output: JSON (Session, Series with Key, Title, Unit, Min, Max, Times in seconds from the session
start, Values), or with --text one line per channel: " (, ): points, .. ".
Exit code 0; 1 for a session that cannot be found (as for engine telemetry show) or Unknown telemetry preview argument(s): ....
Deletes recorded sessions. The GUI's Delete in Settings > Telemetry recording does the same after asking; the
command does not ask.
engine telemetry delete 3 4 --text
Advanced
One or more <session> values: path, file name, latest or a number of engine telemetry sessions (the numbers
refer to the list before anything is deleted). --folder <folder> looks in another folder. remove is the same
command.
Every session is looked up first: when one cannot be found nothing is deleted.
Safety: a session being recorded right now is never deleted (it is listed as not deleted). Deleted files are gone,
not in the recycle bin.
Technical internals
Output: JSON (Deleted, Problems), or with --text "Deleted session(s)." with the files and a "not deleted:"
line per problem (for example <file> is being recorded right now.).
Exit code 0; 1 when a session could not be deleted (the problems also go to the error output), without a
session (telemetry delete <session>... (a path, a file name, "latest" or a number)), or when a session cannot be
found (No recorded session '<x>' in <folder>.).
Finish sessions cut off by a crash | apply the retention settings; exit code 1 when a session could not be read, finished or deleted
For beginners
Finishes sessions that were cut off by a crash or a killed process, so they can be shown and exported again
(engine telemetry recover). engine telemetry prune applies the retention settings now: it deletes the sessions
that are too old or do not fit into the space for recordings.
engine telemetry recover --text
Advanced
recover: every .jptel in the folder without a summary that is not being written: the damaged tail is cut and
the summary is written from the data. Complete sessions are left alone. The recorder does the same itself when it
starts.
prune: first the sessions older than keep-days (0 = no age limit), then the oldest until the folder is at most
max-total-mb (0 = no size limit). The recorder does the same before and after every session.
--folder <folder> works on another folder than the one of the settings (prune still uses the limits of the
settings).
Output of recover: JSON (Folder, Recovered, Problems), or with --text "Finished session(s) that were
cut off." with the files and "problem:" lines.
Output of prune: JSON (Folder, Deleted, Problems), or with --text "Deleted session(s) (size cap
, keep days )." with the files and "problem:" lines.
Exit code 0; 1 when a session could not be read, finished or deleted (the others are done; the problems are
listed), or with Unknown telemetry recover argument(s): ... or Unknown telemetry prune argument(s): ....
What it does Finishes sessions cut off by a crash (telemetry recover) or applies the retention settings now (telemetry prune); exit code 1 when a session could not be read, finished or deleted.
Records now; it ends after --seconds, with Ctrl+C or when the game exits; --no-game-check: the game process is not watched
For beginners
Records the telemetry of one game now, in this window, also when recording is switched off in the settings. Start the
game (or start this first and then the game); Ctrl+C ends the recording, and it also ends when the game
exits.
engine telemetry record --game DCS --seconds 600 --text
--seconds <n>: stops after that time; without it, it runs until Ctrl+C.
--folder <folder>: writes the session there instead of the folder of the settings.
--sample-hz <n>: frames per second written (0 = every frame the game sends), instead of the setting.
--no-raw: does not keep what the game sent unprocessed.
--no-game-check: listens without the game's process. Without it, it waits for the game ("waiting for DCS.exe /
DCS_mt.exe") and stops when the game exits.
It runs JoyPro's force feedback process (JoyPro.Ffb.exe record --force), which also does the GUI's automatic
recordings. Only one process can listen on a game's telemetry port: do not run it while the GUI records or runs
force feedback for the same game.
Safety: only listens locally and writes the session file; nothing is sent anywhere and the game is not changed.
Technical internals
Output: a status line "Recording telemetry (Ctrl+C ends it): JoyPro.Ffb record ..." and then the recorder's
state lines (waiting, listening, recording with the session file and its frames, and the reason it ended); the
exit code is the recorder's.
Exit code 1 without a known --game (the usage line lists the ids), with Unknown telemetry record argument(s): ..., or with JoyPro.Ffb.exe not found (<path>); it reads the games' telemetry. Set JOYPRO_FFB_EXE to its path.
(it is looked for in ffb\ beside the engine's folder, or at JOYPRO_FFB_EXE).
The session goes to <folder>\<date>_<time>_<game>.jptel; afterwards engine telemetry sessions lists it.