This module was developed specifically for using OBS Browsers Sources as a spectator client for your FoundryVTT Game

It forgoes the usual stream user configuration by simply checking if its running in a browser source. Changing any of the settings related to the Browser Source will also force-refresh it in OBS, so no need to do that manually anymore.

This Module was in large parts inspired by Stream View and Stream Utils respectively.

Concept

This module is supposed to be easy, low config and out of the box. Most importantly its supposed to be as hands off on the OBS Side as possible.

Usage

Check the Wiki!

Features

• Automatically follow Tokens based on Spectator or Owner permission

• Automatically detect OBS

• Automatically remove /stream Background

• Hide all UI

• Follow single Token in Combat

• Custom Selection: Choose which tokens to follow

• Tracked Mode: Copy another users Viewport

• Birds-Eye Mode: Fit Map to Screen

• Mode Select both in and out of Combat

• Make /stream Background Transparent

• /stream Information Overlays

• Foundry Core Multilevel Support (Out of combat token visibility and floor tracking might be limited)

• OBS Remote Controls via Websocket or Browser Source

Requirements

• libWrapper

Contributing

Translation

We use weblate to translate the module!

Building

This repository uses xc for task definitions! As such only nodejs, yarn and xc are required.

Dependencies

Project	Version
nodejs.org	^18.12.1
xcfile.dev	^0.0.159
yarnpkg.com	^3.5.1

Tasks

setup

setup the environment

yarn install

build

Builds the module

Requires: setup

yarn build