Switching modules on and off

You are reading the documentation for version 1.2.0. Go to the current version (1.2.1)

You switch modules on and off in one place, and the change takes effect at once. This page explains where the switches are, when a change takes effect, and what happens to lists that use a module that you switch off.

Six modules switched on, each with a line of its own in the Modules menu
Six modules switched on, each with a line of its own in the Modules menu

Where

Choose Modules → Manage modules… in the menu bar. The page lists every installed module with an Enable box, grouped by category, with its version.

A module that is on gets a line of its own in the Modules menu, above Manage modules…. That line opens a window with the settings of the module only.

You chose the modules during the installation, when the setup asked which modules to install and which of them to switch on. A module that you installed but did not switch on is on disk, and you can switch it on here later.

When it takes effect

Tick or clear Enable and press Apply or OK. The module starts or stops at once; you do not need to restart the program.

What happens to your lists

Switching a module off does not change your lists. The cues stay in place, with their titles and settings.

What the module showed disappears. A song cue without the song module is a line that shows nothing. When you switch the module on again, the cue works again.

Switching modules therefore never damages a list. A show can still go wrong if you switch a module off and then run a list that needs it.

Before a service

Check this screen when a computer has been reinstalled or updated, and compare it with what your list needs. It takes two minutes, and it prevents a problem that you would otherwise find during the broadcast.

Do not update modules during a service, because the modules stop for a moment during the download. See Info.

When the modules do not start

Modules run in a separate process, upmod-runner.exe. If that process cannot start, a window with the title Modules could not start shows the cause. None of these causes stops the base program:

The message begins withUsual cause
Windows refused to start upmod-runner.exeAntivirus software, or a file that was blocked after it was copied
upmod-runner.exe is missingThe installation is incomplete
upmod-runner.exe started but did not respondAntivirus software is scanning the program
upmod-runner.exe did not start in timeAntivirus software is holding the file. The program continued without modules
The installation is incompleteThe program and the modules are from different versions

If antivirus software is the cause, the message names the folder to add to its exclusions. In the other two cases, reinstall the program, so that everything comes from the same version.

Where the modules are on disk

The modules are in C:Program FilesUltimate PlayoutModules, together with a small file that records which modules are on. You do not need to edit anything there: this screen writes the file.