JoyPro2 Discord GitHub
Engine (CLI)

engine usage

Show:

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

#engine usage harvest

written
engine usage harvest [--game <game>]... [--full] [--dry-run] [--no-steam]

Usage statistics, docs/usage-statistics.md: read what the games logged since the last time into <data>\Usage

For beginners

Reads what your games logged since the last time (logs, journals, logbooks, replays, Steam's playtime) into JoyPro's usage store. JoyPro does this at start and after a game closed; Read the games' logs now in Settings > Usage statistics runs it at once.

engine usage harvest --game DCS --text
Advanced
  • --game <id> (repeatable) reads only those games.
  • --full reads every file again, also the known ones; a session read again replaces its record, never counts twice.
  • --dry-run reads and reports, writes nothing.
  • --no-steam leaves Steam's playtime out.
  • Every game file is opened read-only with sharing, so a running game is not disturbed. Nothing leaves the PC (usage-statistics).
Technical internals

What it does Reads what the games logged since the last time into the usage store (<data>\Usage); --full reads everything again, --dry-run reports only.

OptionValuesMeaning
--game<game>Game filter value. Example: DCS or IL2Game.
--fullswitch (no value)
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.
--no-steamswitch (no value)

Used by the GUI Settings: Read the games' logs now

Example

engine usage harvest --text

#engine usage sources

written
engine usage sources [--game <game>]...

Where JoyPro reads usage per game, and the logs the watcher follows live

For beginners

Lists where JoyPro reads how much you play each game: logs, logbooks, journals and Steam's playtime, whether each place exists, and which logs the watcher follows live while a game runs. The GUI asks for it at start to follow those logs.

engine usage sources --game DCS --text
Advanced
  • --game <id> (repeatable) limits the list to those games; without it every game.
  • Per source: the game (or "any game"), the kind, folder and file pattern, (not there) when the folder is missing, [followed live] for logs the watcher copies while the game runs, and a note.
  • Read-only: it lists the places; engine usage harvest reads them. Everything stays on this PC.
Technical internals
  • Output: JSON (Folder (the usage store), LiveFolder, Sources with Game, Kind, Title, Directory, Pattern, Recursive, LiveTail, Exists, Note; Tail with the folder, filter and process names the watcher follows; Steam with Steam's config files), or text with --text (Usage sources (store: <folder>), one line per source, Steam playtime: <file>).
  • Exit code 0; 1 with Unknown usage sources argument(s): ....
  • Related: engine usage harvest, engine usage ranking; usage-statistics.

What it does Where JoyPro reads usage per game, and the logs the watcher follows live.

OptionValuesMeaning
--game<game>Game filter value. Example: DCS or IL2Game.

Example

engine usage sources --text

#engine usage ranking

written
engine usage ranking [--game <game>] [--top <n>]

Most used games and aircraft / ships / vehicles; with --profile: binds as the weak fallback

For beginners

Lists your most used games and your most used aircraft, ships and vehicles, from the usage store. Settings > Usage statistics shows it (top 15); Auto Assign, Auto Group, the Setup wizard and Lay out with AI use it as their style reference.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" usage ranking --top 10 --text
Advanced
  • --game <id> keeps only that game; --top <n> the number of rows (default 25).
  • Order of the units: pinned first, then units with logged time, then units the profile only binds (with --profile, by bind count), excluded ones last. Games: the higher of logged time and Steam's or the game's own totals.
  • Pins and exclusions come from Settings (Pin, Exclude). Read-only.
Technical internals
  • Output: JSON (Folder, Games, Units, References (the model per class), Pinned, Excluded), or text with --text. Exit code 0; 1 on an unknown option.
  • Related: engine usage harvest, engine usage stats.

What it does The most used games and aircraft / ships / vehicles; with --profile the profile's binds are the weak fallback.

OptionValuesMeaning
--game<game>Game filter value. Example: DCS or IL2Game.
--top<n>

Used by the GUI Settings: Read the games' logs now · Settings: ToggleUsagePinCommand · Settings: ToggleUsageExcludeCommand

Example

engine usage ranking --text

#engine usage stats

written
engine usage stats [--top <n>]

Everything for the Statistics page; with --profile: binds per device, growth, oldest unused bind

For beginners

Everything the Statistics page shows: hours per game and per aircraft, ship or vehicle, streaks, when you play, your longest session, exports per game and, with a profile, your binds per device. engine usage without an action is the same command.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" usage stats --text
Advanced
  • --top <n>: how many aircraft, ships and vehicles (default 50). Games are always all.
  • Excluded games and units (engine usage) are left out; units the profile only binds (no logged time) are not counted.
  • With --profile: binds per device, how the profile grew (from its history; the counts are cached in the usage store's Cache folder) and the oldest bind whose aircraft or games have no recorded play.
  • It reads the usage store that engine usage harvest fills and changes neither the store's data nor the profile.
Technical internals
  • Output: JSON (Generated, HasData, Totals (hours, sessions, games, units, first and last play, active days, streaks), Games, Units, Counters, Weekdays, HoursOfDay, Months, LongestSession, Exports, Profile, Devices, OldestUnusedBind, Growth, Facts, Sources), or text with --text.
  • Exit code 0; 1 with Unknown usage stats argument(s): ....
  • Store: %LOCALAPPDATA%\JoyPro2\Usage. Related: engine usage ranking, engine usage sources; usage-statistics.

What it does Everything for the Statistics page; with --profile also binds per device, growth and the oldest unused bind.

OptionValuesMeaning
--top<n>

Example

engine usage stats --text

#engine usage

written
engine usage pin|unpin|exclude|include <game> [<aircraft/ship>]

Your choices on the ranking; pinned = the model for new aircraft of its class; the game must be known and the aircraft / ship in the ranking, or already pinned / excluded

For beginners

Your choices on the usage ranking: pin an aircraft, ship or vehicle, so it is the model for new aircraft of its class (Auto Assign, Auto Group, the Setup wizard), or exclude one, so it ranks last and is left out of the statistics. The Pin and Exclude buttons of Settings > Usage statistics run it.

engine usage pin DCS F-16C_50 --text
Advanced
  • pin <game> [<unit>]: pinned units rank first; pinning removes an exclusion.
  • unpin <game> [<unit>]: removes the pin.
  • exclude <game> [<unit>]: the unit ranks last and is not a model; excluding removes a pin.
  • include <game> [<unit>]: removes the exclusion.
  • Without <unit> the choice is about the whole game (a pinned game ranks first, an excluded one is left out of the statistics).
  • The game is a game id or name (DCS, il2, ...) and must be a game JoyPro knows. The unit is the id the ranking shows (the part after | of Id in engine usage ranking, any case) and must be in the ranking (logged usage, or with --profile the profile's binds); a pin or exclusion already stored can always be taken back.
  • Changes only overrides.json of the usage store (backed up once a day, engine usage backups).
Technical internals
  • Output: JSON (Action, Id (<game>|<unit>), Pinned, Excluded), or with --text Pinned <id>, Unpinned <id>, Excluded <id> or Included <id>. Exit code 0.
  • Exit code 1 with usage <action> <game> [<unit>] when the game is missing or there are more words, Unknown game: <game> ..., No usage of '<unit>' in <game> is known ..., or Unknown usage action: ....
  • Related: engine usage ranking, engine usage stats; usage-statistics.

What it does Your choices on the ranking: pinned = the model for new aircraft of its class, excluded = never counts. The game must be known and the aircraft / ship in the ranking (or already pinned / excluded).

Example

engine usage pin DCS F-16C_50 --text
engine usage exclude StarCitizen RSI_Polaris --text

#engine usage backups

written
engine usage backups | engine usage restore <day>

The usage store's daily backups; restore takes a day engine usage backups lists

For beginners

Lists the daily backups of the usage store, or puts one back with engine usage restore <day>. Use it when the statistics look wrong after a change.

engine usage backups --text
Advanced
  • backups: the days with a backup, newest first. A backup is made before the first change of a day (harvest, pin, exclude); the newest 7 days are kept.
  • restore <day>: the day as listed (yyyy-MM-dd); anything else (a path, ..) is refused. Before it writes, the current files go into today's backup when there is none yet, so a restore can be undone with today's backup. Files the backup does not have stay as they are.
  • Only the usage store changes (sessions, totals, files read, exports, pins and exclusions); profiles and games do not.
Technical internals
  • Output: JSON (Folder, Days; restore: Restored, Sessions), or text with --text (Usage store backups (newest first): and one day per line; Restored the usage store of <day>.). Exit code 0.
  • Exit code 1 with usage restore <day> (engine usage backups lists them) or No usage backup of <day> (engine usage backups lists the days).
  • Backups: %LOCALAPPDATA%\JoyPro2\Usage\Backups\<day>\. Related: engine usage harvest, engine usage; usage-statistics.

What it does Lists the usage store's daily backups (usage backups) or puts one day back (usage restore <day>, a day the list shows).

Example

engine usage backups --text
engine usage restore 2026-10-31 --text