|Last updated||3 weeks ago|
|Created||1 year ago|
|Project source||Project URL|
|Report bugs||Bug tracker URL|
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.
You can install this module by using the following manifest URL: https://github.com/bekriebel/fvtt-module-avclient-livekit/releases/latest/download/module.json
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>
LiveKit AVClient provides a number of features beyond the A/V option built into Foundry:
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.
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.
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.
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.
To install this package, open your Foundry Setup screen and navigate to your Module tab and click the Install Module button.
From there, you can either search for the package unique name: avclient-livekit or copy its manifest URL:
And paste it to the input box at the bottom of your window.
You can install this package directly to your Forge account.
Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Advertisement cookies are used to deliver visitors with customized advertisements based on the pages they visited before and analyze the effectiveness of the ad campaign.