Register

LiveKit AVClient

An Add-on Module for Foundry Virtual Tabletop

Author: bekit Project Source: Project URL Versions 9.238+ (Verified 12) Last Updated 1 week, 3 days ago

LiveKit AVClient

Join our Discord Become a Patron Donate via Ko-Fi
Latest Version Build Status Download Count

About

A replacement for the native SimplePeer / EasyRTC A/V client in FoundryVTT. The module uses LiveKit platform to provide Audio & Video communication between players.

Note: At the moment there are no public LiveKit servers. You must configure a custom signalling server under Audio/Video communication or use one of the following options:

At the Tavern is providing access to a multi-region LiveKit server cluster that we maintain to anyone who subscribes to our Patreon at at least a $5 USD per month level. The fee is used to cover the cost of the server cluster and contribute toward further development of this module.

Forge users can make use of the Forge's LiveKit servers with no additional configuration required.

Installation

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

Configuration

Install & enable the module then configure for your LiveKit instance under Audio/Video Configuration:

LiveKit Server: Select an available option or Custom for your own server
LiveKit Server Address: rtc.example.com <Your LiveKit server address>
LiveKit API Key: ABCDEFGHIJ12345 <Your LiveKit API Key>
LiveKit Secret Key: **************** <Your LiveKit Secret Key>

Features

LiveKit AVClient provides a number of features beyond the A/V option built into Foundry:

How to use

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 right-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

Running your own LiveKit server

There are several examples available for launching your own livekit server:

Though newer versions may work, the current recommended LiveKit server version is v0.15.6. This has had the most extensive testing done with the module and matches the current client SDK version that the module is using.

⚠️ Duck DNS and Ad blockers: Several ad blockers seem to block websocket connections to Duck DNS URLs. If you are using Duck DNS for your LiveKit Server domain name, you and your users may need to whitelist the domain name in ad blocking extensions.

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. For even more logging of the LiveKit connection, LiveKit trace logging can be enabled after debugging logging is turned on by setting Enable LiveKit trace logging under module settings.

Changelog

See CHANGELOG

Categories

Available Versions

  1. Version 0.5.30

    1 week, 3 days ago
    Foundry Version 9.238+ (Verified 12) Manifest URL Read Notes
  2. Version 0.5.20

    1 year, 1 month ago
    Foundry Version 9.238+ (Verified 11) Manifest URL Read Notes
  3. Version 0.5.19

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  4. Version 0.5.18

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  5. Version 0.5.17

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  6. Version 0.5.14

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  7. Version 0.5.13

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  8. Version 0.5.12

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  9. Version 0.5.11

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  10. Version 0.5.3

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  11. Version 0.5.2

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  12. Version 0.5.0

    Foundry Version 9.238+ (Verified 10) Manifest URL Read Notes
  13. Version 0.4.0

    Foundry Version 0.7.2+ (Verified 10) Manifest URL Read Notes
  14. Version 0.3.5

    Foundry Version 0.7.2+ (Verified 9) Manifest URL Read Notes
  15. Version 0.3.4

    Foundry Version 0.7.2+ (Verified 9) Manifest URL Read Notes
  16. Version 0.3.3

    Foundry Version 0.7.2+ (Verified 9) Manifest URL Read Notes
  17. Version 0.3.2

    Foundry Version 0.7.2+ (Verified 9) Manifest URL Read Notes
  18. Version 0.3.1

    Foundry Version 0.7.2+ (Verified 9.231) Manifest URL Read Notes
  19. Version 0.3.0

    Foundry Version 0.7.2+ (Verified 9.231) Manifest URL Read Notes
  20. Version 0.2.5

    Foundry Version 0.7.2+ (Verified 9.224) Manifest URL Read Notes
  21. Version 0.2.4

    Foundry Version 0.7.2+ (Verified 9.224) Manifest URL Read Notes
  22. Version 0.2.3

    Foundry Version 0.7.2+ (Verified 9.224) Manifest URL Read Notes
  23. Version 0.2.2

    Foundry Version 0.7.2+ (Verified 9.224) Manifest URL Read Notes
  24. Version 0.2.1

    Foundry Version 0.7.2+ (Verified 9.224) Manifest URL Read Notes
  25. Version 0.2.0

    Foundry Version 0.8.8+ (Verified 0.8.9) Manifest URL Read Notes
  26. Version 0.1.0

    Foundry Version 0.8.8+ (Verified 0.8.9) Manifest URL Read Notes