Getting Started

Modular A/V needs Foundry VTT v14 or later. Chrome, Edge and other Chromium browsers run everything; Firefox and Safari aren't tested yet.

There are two ways in: the starter set, which installs a ready setup, or your own pick of modules.

The starter set

The starter set holds no code: it brings in the modules most tables start with.

Module	In the set
modular-av	Required: the core every module builds on
modular-av-dock	Required: the camera dock and the voice panel
modular-av-livekit	Required: calls through a LiveKit server
modular-av-mic-denoise	Required: noise cancellation for your microphone
modular-av-cam-background	Offered: blur or replace your background

1. In Foundry's Setup screen, open Add-on Modules, Install Module, paste this manifest URL and install:

   https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-starter-set/module.json
   

   Foundry installs the required modules with it and offers the camera background.

2. Launch your world and enable Modular A/V: Starter set in Manage Modules. Foundry turns the required modules on with it; the camera background is ticked but yours to leave out.

3. LiveKit needs a server: set it up as on the LiveKit page.

Every module in the set is a module of its own: turn any of them off later, or add others, as with any Foundry module.

Your own pick

You need the core, one service and, for the Discord-like dock, the dock. Effects, the audio mixer and themes are optional. The Module map shows what needs what, and Choosing a service helps with the service.

1. In Foundry's Setup screen, Add-on Modules, Install Module, paste a module's manifest URL and install. Foundry offers what it needs with it: installing the dock brings the core.
2. Launch your world and enable the modules. With one service enabled, the world uses it; with more than one, choose in Modular A/V's settings under Voice and video service.
3. Set the service up: P2P needs nothing, LiveKit and Jitsi need your server's details.

Once the core is in a world, a GM can open Plan your modules in its settings: it shows every module, which ones the world runs, and gives the links for the rest.

Manifest URLs

Module	Manifest URL
modular-av	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av/module.json
modular-av-p2p	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-p2p/module.json
modular-av-livekit	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-livekit/module.json
modular-av-jitsi	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-jitsi/module.json
modular-av-dock	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-dock/module.json
modular-av-dock-vines	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-dock-vines/module.json
modular-av-mic-denoise	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-mic-denoise/module.json
modular-av-livekit-krisp	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-livekit-krisp/module.json
modular-av-audio-mixer	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-audio-mixer/module.json
modular-av-audio-reverb	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-audio-reverb/module.json
modular-av-audio-echo	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-audio-echo/module.json
modular-av-audio-eq	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-audio-eq/module.json
modular-av-audio-radio	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-audio-radio/module.json
modular-av-audio-boost	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-audio-boost/module.json
modular-av-cam-background	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-cam-background/module.json
modular-av-starter-set	https://raw.githubusercontent.com/Affid/modular-av/manifests/modular-av-starter-set/module.json

On a hosted Foundry server, use your host's install page with the same links.

Foundry's own settings still apply

Foundry's Audio/Video settings (conference mode, devices, push to talk, relay server) are still where you set those. Modular A/V replaces the client underneath, so it can't run alongside another A/V client module such as LiveKit AVClient: enable only one.

Your settings follow you

What you set up as a player is kept with your Foundry user, on the server, so it follows you to another browser, another computer, or the same game at another address: the voice effects you turn on and how they run, their values, the audio mixer's preset, your camera background's strength and image, and your volume for each other player.

What belongs to the machine stays with that browser: your microphone's sensitivity, the voice gate's fallback, your camera's resolution, the mic boost's level, the camera effects you turn on, blur and Krisp quality, and your devices.

If you used Modular A/V before version 0.12, what this browser kept moves to your user once, the first time you load a game, unless your user already has its own.