RigReady

Install RigReady

RigReady runs on Windows 10 and 11, 64-bit. Nothing else needs to be installed.

The installer

The download page has the current installer, RigReady-Setup-<version>.exe, with its size and release date; every version is also on GitHub Releases. Until the first 2.x release is published, the page says so and shows how to run from source instead (below).

Run the installer by double-clicking it.

  • It installs for your account only, under %LOCALAPPDATA%\Programs\RigReady unless you choose another folder. It never asks for administrator rights and never offers to install for all users.
  • It makes a Start menu entry and a desktop shortcut, and offers to start RigReady when it finishes.
  • The installer is not code signed, so Windows SmartScreen warns the first time it runs ("Windows protected your PC"). Choose More info, then Run anyway. Signing needs a certificate and is a separate decision; until then the warning is expected. See Windows SmartScreen warns about the installer.

Updates

RigReady checks for a newer version when it starts and once a day, downloads it in the background, and installs it when you press Restart to install or when you quit, never while a game is running. The channel, the switch for automatic checks and Check now are under Configure > Settings > Updates. See Updates.

Where things are

  • The app: %LOCALAPPDATA%\Programs\RigReady.
  • Your data: ~/.rigready, the folder .rigready in your Windows user folder (C:\Users\<you>\.rigready): the setups, the settings, the monitor layouts, the backups, the automatic copies made before each change, the change journal and the log. The app and its data folder lists what is in it and how to move it with RIGREADY_HOME.
  • Uninstalling, from Windows Settings > Apps, asks whether to remove that data too and keeps it by default. An update never touches it.

If you used RigReady 1: version 2 is a rebuild and does not read its setups as they are. The old files are left where they are and listed apart on the Setups page under From RigReady 1, where RigReady can bring a setup over or say why it cannot, and where they can be deleted; see Files from RigReady 1.

Run from source

Until the first release, and whenever you want the development version: Windows 10 or 11 and Node.js 22.12 or newer.

git clone https://github.com/MCheli/rigready.git
cd rigready
npm ci
npm run dev:scenario -- flying-all-good

The last command runs the app on a recorded rig in a temporary folder; it changes nothing on your PC. To run it on your own rig, run npm run setup:python once (the small Python runtime the controller reader needs), then npm run dev. The repository's README lists the commands, and the contributing guide has the rest.

Edit this page on GitHub