The installation in detail

The setup always runs through the same steps, in the same order. Part 1 describes them for someone who installs the program once. This page is for someone who installs it on twelve computers, or who has to explain it afterwards.

The steps

1. The setup asks for the language. The language of Windows is selected by default, or, for a reinstallation, the language you chose last time. The setup continues in that language, and the program uses it from then on. See languages.
2. It checks the computer. If tar.exe is missing, the setup stops and explains why. This file has been part of Windows since Windows 10 version 1803. The setup also stops if an application based on the engine is running, such as OBS Studio or Ultimate Playout itself, because the two would overwrite each other’s configuration.
3. It shows the terms of use. You must accept them to continue.
4. It offers a desktop shortcut.
5. It asks for the licence key, and uses it to find the modules of your account. The setup skips this step when it already has the key, from the command line or from the installer itself.
6. It asks which modules to install, and which of them to switch on.
7. It shows a summary of the folder, the engine and the modules.
8. It downloads the engine and installs it with the program. The setup downloads the engine (about 180 MB) and the modules of your account. It then unpacks the engine and switches off the updates of the engine, because the program does not update itself. See the pinned engine. If the correct version is already present, the setup skips the download, so a second run takes only a few seconds.
9. It copies the program files, creates the launcher and the shortcuts, and gives write access to the configuration folder.
10. It writes the chosen modules to the Modules folder, and records which modules are switched on.
11. It reports the installation to the website, but only when you entered a key. This gives you access to the pages for customers with an installation. If the report fails, the installation is still correct: the setup shows a message and continues.

Unattended

To install on several computers, use this command:

UltimatePlayout_Setup.exe /VERYSILENT /KEY=UP-XXXX-XXXX-XXXX

In silent mode, the module page is not shown, and the setup installs every module and switches it on.

If the download archive is already on the computer or on a network share, use this command:

UltimatePlayout_Setup.exe /VERYSILENT /OBSZIP="D:deployobs.zip"

The setup then skips the download, which saves a lot of time when you install on several computers. The file must be the official zip of the engine version on the summary page, and the setup refuses other versions. If the zip has its original name and is in the same folder as the setup, the setup finds it without /OBSZIP.

To set the language, use /LANG= with one of these values: english, dutch, norwegian, german or spanish. The program then starts in that language. Without /LANG=, a silent installation over an existing one does not change the language of the program.

What is stored where

C:Program FilesUltimate Playout
  UltimatePlayout.exe        <- the launcher
  Modules                   <- the chosen modules
  engineconfig             <- settings, scenes and logs (writable)

Every user of the computer can write to engineconfig, so a control-room PC with changing volunteers has one shared setup. Keep this in mind if users expect personal settings. See where the files live.

Uninstalling

Uninstalling removes the program folder completely, including engineconfig and the modules, and the uninstaller warns you first. The lists and bundles in DocumentsUltimate Playout are not removed.

Updating an existing installation

When you run a newer setup over an existing installation, the setup replaces the program, but it does not change engineconfig. Your settings, scenes and designs therefore remain.