Live show control for sound, video and the stage

Step by step

OpenQ is installed by its installer, OQup. OQup downloads the newest release of OpenQ for your system, checks it, adds the FFmpeg libraries it uses for video (an LGPL build) and installs it with a menu entry. With the lighting workspace (the default) it also installs OQVis, the 3D visualiser that Open in OQVis starts. Your shows are never touched.

Linux

1. Open a terminal, paste the command below and press Enter:

   curl --proto '=https' --tlsv1.2 -fsSL https://github.com/iagonunez/OQup/releases/latest/download/install.sh | sh

2. The first step downloads OQup, checks it against the published checksum and puts it in ~/.local/bin. Then it starts.
3. If system libraries OpenQ needs are missing (ALSA, PipeWire, udev), OQup lists them and asks before installing them with your distribution's package manager. Answer yes; the package manager asks for your password.
4. Leave the terminal open until it says that OpenQ is installed.
5. Open OpenQ from your applications menu (search for "OpenQ"), or type openq in a terminal.

If the terminal says openq: command not found, ~/.local/bin is not in your PATH yet. Add it once, then open a new terminal:

fish_add_path ~/.local/bin                                 # fish
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc   # bash (zsh: ~/.zshrc)

macOS

1. Open Terminal (press ⌘ Space and type "Terminal").
2. Paste the command below and press Enter:

   curl --proto '=https' --tlsv1.2 -fsSL https://github.com/iagonunez/OQup/releases/latest/download/install.sh | sh

3. The app is placed at ~/Applications/OpenQ.app, the Applications folder in your home folder, with FFmpeg inside it. Open it from the Finder (Go → Home → Applications) or with Spotlight.

Windows

1. Open PowerShell: press the Start key, type PowerShell and press Enter.
2. Paste the command below and press Enter:

   powershell -ExecutionPolicy Bypass -c "irm https://github.com/iagonunez/OQup/releases/latest/download/install.ps1 | iex"

3. When it is done, OpenQ is in the Start menu and listed under Settings → Apps → Installed apps.

Building on your own computer

oqup install --build-source compiles OpenQ (and OQVis) from the source code on your computer instead of downloading the release. OQup installs what the build needs first: a private copy of Rust if there is none, a C compiler and libclang, and FFmpeg (on Linux from your distribution's packages, after asking; on macOS Apple's Command Line Tools, then FFmpeg compiled from its source; on Windows Microsoft's C++ Build Tools, whose installer opens for you to accept). It needs several gigabytes of free space and the first build takes a long time; later ones are quicker.

If something goes wrong

• oqup doctor shows what is installed and what an install still needs.
• If the install stops, read the last lines it printed, fix the cause (usually a missing package or a cancelled installer) and run the command again.

Updating and removing

To get a newer version, run oqup update: it installs OpenQ again when a new version is released, the same way as last time. oqup versions lists the versions you can install, and oqup install --ref v0.4.0 installs one of them. To remove OpenQ, run oqup uninstall; it asks first. Add --purge to remove OQup's downloads, Rust, dependencies and build cache as well. On Windows you can also remove OpenQ from Settings → Apps → Installed apps. Your shows are never touched.

If you only need cues, oqup install --no-lighting installs OpenQ without the lighting workspace (no Lighting view, Light cues, fixture downloads or OQVis). Shows with a lighting design still open, keep it and play their Light cues. oqup install --lighting adds it back; --no-oqvis keeps the lighting but leaves OQVis out.