Setups
This section covers setups: what one holds, how it is captured from the rig, the editor, every kind of check and fix, launch targets and steps, scripts, path variables, the YAML file, and cloning, copying and deleting. A setup is one "ready state": one aircraft or car, with everything the rig needs before you launch it. The Play screen checks a setup, Make ready fixes what it can, and Launch starts what the setup says. You make one per aircraft or car, because a Hornet and an iRacing evening want different gear, helper apps, monitors and files. A session can also start from a desktop shortcut per setup.
What a setup holds
- A name, the game it is for (a game RigReady knows, "other" with a name of your own, or no particular game), notes, and for a game installed more than once the install it uses.
- Checks, grouped as the Play screen shows them: devices connected, apps and services, monitors, audio, config files, other. Each is required or optional, can be switched off, and may carry a fix. Checks and fixes lists every kind.
- What Launch starts: a program with arguments, a Steam app id, or nothing. See Launch targets and steps.
- Steps Before launch, After launch and At Stand down (Stand down says what runs at the end of a session).
- The files and folders the Backups page keeps for this setup (Tracked files), and other data features keep with it.
Where setups live
Each setup is one YAML file: ~/.rigready/profiles/<id>.yaml, where ~ is your user folder (C:\Users\<you>) and the id is made from the name ("DCS F/A-18C" becomes dcs-f-a-18c). Set the RIGREADY_HOME environment variable to keep RigReady's data somewhere else (The app and its data folder). Which setup is in use is kept in state.json next to the folder.
The file is yours to read and edit; RigReady notices a change within about two seconds. See Hand-editing the YAML.
The Setups page
Configure > Setups lists every setup with its game, how many checks it has, what it launches and when it was last used; the one on the Play screen is marked. Each has Play (makes it the setup in use and goes to the Play screen), Edit (The setup editor), Clone and a menu with Open the YAML file, Show in Explorer and Delete… (Clone, copy and delete). Play and Clone move you on only once RigReady has done them; if you went on to another page in the meantime, you stay there. The same goes for saving a new setup. Files that cannot be read are listed with the reason (A setup file cannot be read), and files left by RigReady 1 are listed apart under From RigReady 1, where RigReady brings a setup over when it can (Files from RigReady 1).
New setup from this rig is how a setup is made: RigReady reads the rig as it is and proposes the checks. See Creating a setup from the rig.
In this section
- Creating a setup from the rig
- The setup editor
- Checks and fixes
- Launch targets and steps
- Scripts
- Path variables
- Hand-editing the YAML
- Clone, copy and delete
- Creating a setup from the rigNew setup from this rig reads the rig as it is and proposes the checks: what is proposed, what is kept by default, and what optional means.
- The setup editorEvery part of Configure > Setups > Edit: name and game, what Launch starts, the shortcut, the checklist, the steps, and Stand down when the game closes.
- Checks and fixesEvery kind of check a setup can hold, by group: what it looks at, its fields, and the fix Make ready can run for it. Also the fix types on their own.
- Launch targets and stepsWhat Launch starts: a program or a Steam app id. The steps before and after launch and at Stand down, pausing a launch, and what runs with what rights.
- ScriptsRunning scripts and programs as a check, as a fix or as a launch step: how they run, hidden or shown, timeouts, exit codes, confirmation and examples.
- Path variablesThe complete list of {USER}, {SAVED_GAMES}, {DCS_USER} and the other variables a setup can use in a path, what each one means, and the rules for using them.
- Hand-editing the YAMLA setup file, annotated: every field and what it does, what happens when you edit it while RigReady runs, comments, a broken file, and files from RigReady 1.
- Clone, copy and deleteCloning a setup, copying checks from one setup into another, deleting a setup together with its desktop shortcut, and bringing both back from the Safety page.