Application Setup

Soothsayer is a tool that generates overlays for casting one of the supported games.

App Setup

Download and run the most recent installer from the Releases page. It is strongly recommended that you install the app in a folder other than Program Files on Windows. This will allow Soothsayer to write additional text files for use in OBS. After installing, run the application. On Windows systems, you may need to let the app through the Windows Firewall (see below).

Soothsayer keeps the core overlay files contained within a directory in its install location. There's a button titled Open Overlay Location in the Settings > Config tab.

• On Windows, this is at [install dir]/resources/app/src/obs_src
• On MacOS, this is inside the app package itself. Right click the app and choose the "Show Package Contents" option, and navigate to the resources/app/src/obs_src/ folder.

See Overlay Usage for a list of available templates.

These core files are typically used with themes (if you load them up with the default theme, you'll soon see why). In order to use themes, you'll need to set aside a separate themes folder for Soothsayer. The theme folder should be kept on the same hard disk partition as Soothsayer's install files. Make a folder for the themes, then under the Config tab, select that location. For more information on how to use themes, see Using Themes.

Why do I need to let the app through the firewall?

Soothsayer operates by setting up a socket.io server on port 3005 of your machine. It uses this so that overlays set up in OBS can communicate with the application and retrieve data from the main app. This communication layer needs to be unblocked to run properly. Note that this socket will be accessible to anyone on your local network, however if they try to access it they'll only get Soothsayer data back.