The installation in detail

You are reading the documentation for version 1.0.2. Go to the current version (1.1.6)

New in version 1.0.2.

What happens when you run the setup, in order. Part 1 covers the same ground for the person installing it once; this page is for whoever has to do it on twelve machines or explain it afterwards.

In order

  1. Checks the machine. Is another application built on the same engine running? Then it stops — otherwise that one writes its configuration over this one. Is Windows older than 10 version 1803? It stops too, with an explanation.
  2. Fetches the engine. The pinned version is downloaded and unpacked into its own folder. Already there in the right version? This step is skipped, and a second run takes seconds.
  3. Pins it. The engine is renamed, its own updater is removed, and automatic updates are switched off. It cannot update itself — see the pinned engine.
  4. Installs the program beside it, with the marker files that tell it to take over the interface.
  5. Asks for the licence key, and with it, which modules belong to this account.
  6. Asks which modules to install, and which to switch on straight away.
  7. Creates the launcher and the shortcuts, and grants write access to the configuration folder.
  8. Reports the installation to the website, which is what unlocks the pages reserved for installed customers. If that fails, the installation is still fine — you get a message and the setup does not fall over.

Unattended

For several machines:

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

In silent mode the module page is not shown and its defaults apply: everything installed, everything switched on.

If the engine archive is already on the machine or on a share:

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

That skips the download, which on twelve machines is the difference between an afternoon and a coffee.

What ends up where

C:Program FilesUltimate Playout
  UltimatePlayout.exe        <- the launcher
  Modules                   <- the chosen modules
  engine
    bin obs-plugins data  <- the pinned engine and the program
    config                  <- settings, scenes and logs (writable)

engineconfig is writable by everyone who logs in on the machine, so a

control-room PC with changing volunteers shares one setup. Where personal settings are expected, that is the thing to know about — see where the files live.

Uninstalling

Removes the program folder completely, engine included. Rundowns, songs and exports are in the user’s Documents folder and stay.

Updating an existing installation

Running a newer setup over an existing installation replaces everything under

engine except config, so no files from two engine versions can end up

mixed — and the settings, scenes and designs survive.