Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

How to use

Nathanael Schneider edited this page Jun 19, 2022 · 10 revisions

Main Window

When you start the app, you will be presented with the overview window. Main Window

On the left side is the configuration and status of the plugins and OBS connection. The status of the plugin is color coded and you can hover over the status color to get a short message depending on the status:

  • Gray: Plugin not running
  • Red: Plugin faulted, needs to be relaunched
  • Yellow: Warning
  • Green: Plugin loaded and running

Plugin Status

On the right side is the remaining configuration options. You can set the monitor on which the overlay will be launched and show the overlay again when you close it.

Stream View

The stream view looks very similar to the OBS multiview to increase usability. But contrary to the multiview, every slot can be freely configured, including the number of slots in the grid.

4x6 Stream View 2x3 Stream View
StreamView Alternative StreamView

The live preview makes use of the virtual webcam OBS introduced to capture the live image using vlc.

Configuration

You can access the configuration for the current layout using the gear in the top left corner. Here you can configure the number of rows and columns and export or import a preset.

StreamView

Sets

You can also create sets to group common actions. Plugins in a set will only be triggered once you enter a slot with a different set than the previous one. This allows you to make live-adjustments and not have them overwritten by the Multiview. The Set-Editor is in the top left corner of the StreamView behind the box-icon.

StreamView

The neutral set is a bit different, as it does not accept any plugin configuration. Instead it behaves just like the last active set which allows it to be part of multiple groups without triggering anything. Might be a bit buggy still, as it is not yet extensively tested.

Slots

Each slot can be configured by right clicking on it. It allows to set a custom title and scene, allowing you to use the same scene in multiple slots. Here you can also assign a group to each slot. Each of the activated plugins can also be configured in the following dialog. On how to use each of the plugins see the documentation on the plugin. To clear a slot, open the configuration and click the red cross.

Slot Config

When assigning a set to a slot, the name of the set will be shown in the bottom of the slot together with the color identification. Slots that reference an unavailable OBS-Scene will have a red background with an exclamation mark.

StreamView

Clone this wiki locally