module

Jitsi WebRTC client

Endorsements
2
Installs
6.06%
Comments
1
Latest version0.6.1
Minimum Core0.7.2
Compatible Core0.8.6
Last updated1 month ago
Created1 year ago
Authors
Languages English
Español
Systems All systems
Dependencies libCaptions
Project source Project URL
Report bugs Bug tracker URL
Read-me Readme URL
Changelog Changelog URL

Jitsi WebRTC client

Replacement for the EasyRTC p2p client to use a Jitsi relay server for A/V. It has the main advantage of being able to run all communication via a relay server. A player only needs to send her/his A/V stream to a single receiver, where it is distributed to all other players. If you have more then 2 players, this is a bandwidth improvement. This feature is called SFU (Selective Forwarding Unit). Read more about Jitsi on https://jitsi.org/.

First tests with 4-5 players resulted in ~700kbit/s upload and ~ 1Mbit/s download rate for each player.

Installation

You can install this module by using the following manifest URL: https://github.com/luvolondon/fvtt-module-jitsiwebrtc/releases/latest/download/module.json

How to use

To use this client you have to enable A/V in the Game settings. The module will replace the EasyRTC client of vanilla FVTT. You can either connect via the Jitsi server by leaving the Signalling Server on "Foundry VTT". Or switch to a custom, self-hosted Jitsi server. A great documentation by @solfolango77 for installing your own server can be found here: VTTA - Installing a self-hosted Jitsi Server for Foundry VTT.

You can allow standalone Jitsi users to join your conference by enabling the module setting Allow standalone Jitsi users. When enabled, users can see the Jitsi meeting URL under the read-only module setting Standalone Jitsi URL.

Breakout Rooms

A GM can now split the party!

To start a breakout room, right-click on the player you would like to break out in the player list and select Start A/V breakout. You will join a different A/V session with that user. You can now click on other users and pull them into the breakout room, or start yet another breakout room with another user.

start breakout example

Though the GM will always join the breakout room on creation, they can leave the breakout room themselves by right-clicking on their own username and selecting Leave A/V Breakout. Users can also leave a breakout at any time by right-clicking on their own name, and the GM can end all breakout rooms by selecting End all A/V breakouts.

start breakout example

Live Captions / Subtitles

Automated live captioning is supported by this module using Jitsi's Jigasi subtitle/transcription functionality. This requires that your Jitsi server be configured to support transcription through the Jigasi service. Unfortunately, the public Jitsi Meet servers do not provide this functionality. To enable this on your own self-hosted service, see the Jigasi documentation: Using Jigasi to transcribe a Jitsi Meet conference.

animated image of foundry vtt live caption example

Debugging

By default, debug logs are disabled. If additional logs are needed for troubleshooting, Enable debug logging can be turned on under the module settings.

Changelog

See CHANGELOG

Support my work

Become a Patron Donate via Ko-Fi

License

This Foundry VTT module is licensed under a Creative Commons Attribution 4.0 International License.

Subscribe
Notify of
1 Comment
Inline Feedbacks
View all comments
Zaryk
4 months ago

An absolutely critical module that saved me when switching to Foundry VTT. I was having a lot of issues with poor A/V connections from my players (due to the default p2p) and Jitsi came to the rescue. Immediately resolved my issues using the default Jitsi server. Thank you so much for this module.

1
0
Would love your thoughts, please comment.x
()
x