The app and its data folder

This section covers RigReady itself rather than your rig: the one folder where it keeps its own data, its settings, how it updates itself, the command palette and the keyboard, the text size, where its log is, what leaves the PC, and how to remove it.

Nothing here touches your games. For what RigReady does to game files, see Backups, sharing and safety.

The data folder

RigReady's data folder is ~/.rigready: the folder .rigready in your Windows user folder, normally C:\Users\<you>\.rigready. The manual writes it as ~/.rigready throughout. Configure > Diagnostics and the About panel (the version number at the top right) both show the exact path.

To keep the data somewhere else, set the environment variable RIGREADY_HOME to the folder you want before starting RigReady. Everything below then goes there instead.

What is in it:

Folder or fileWhat it holds
profiles\Your setups, one YAML file each. You may edit them by hand; see setups as YAML.
settings.jsonThe settings.
displays\layouts.jsonYour saved monitor layouts.
backup\The Always back up list, the backup preferences, the snapshot index, the what changed records, and the stored file contents they share.
backups\The backup files you made, as zip files, and under backups\auto the automatic copies of every file RigReady changed.
journal.jsonlThe change journal the Safety page reads.
logs\rigready.logThe log, with up to four older files beside it (rigready.log.1 and so on); each is at most 5 MB.
secrets\The API key of each AI provider you stored one for, encrypted for your Windows account.
devices.jsonThe names you gave devices, and what you said each one is and is used for (Devices).
games\custom.jsonThe games you added on the Games page.
processes\known.jsonThe apps you chose to offer in every new setup.
overlay\settings.jsonWhether the overlay is on, where you placed it, its options, and the aircraft or car you chose for each setup.
cheat-sheets\Your own cheat sheet layouts, drawings and photos (one file per device model, under layouts\), your notes, and the trainer's records.
ai-assist\guides\The binding guides you imported or wrote, and those drafted by AI.
window.json, panels.json, state.jsonWhere the window and the pop-out panels were left, and which setup was used last.

The program itself is installed under %LOCALAPPDATA%\Programs\RigReady, and a downloaded update waits in %LOCALAPPDATA%\rigready-updater until it is installed.

Edit this page on GitHub