OBS

OBS is a popular Free And Open Source streaming software, with advanced capacities for your live streams. In the current page, you will find some advices to handle your live chats using OBS.

OBS Overlay

You can easily include the chat in your video stream.

$Screenshot of a Peertube live, replay, with the chat included at the\nbottom of the video\nstream.$ $Screenshot of a Peertube live, replay, with the chat included at the\nbottom of the video\nstream.$

You can use the “Compartilhar link do chat” feature to generate an URL to your chat. This button should be near the chat if you are the video owner (unless it was desactivated by your server admins).

Check the “Somente leitura” checkbox in the modal.

$Screenshot of the “Compartilhar link do chat” dialog, where\nthe “Somente leitura” option is\nchecked.$ $Screenshot of the “Compartilhar link do chat” dialog, where\nthe “Somente leitura” option is\nchecked.$

Then use this link as a “web browser source” in OBS.

$Screenshot of the OBS software, where the chat was added as web browser\nsource.$ $Screenshot of the OBS software, where the chat was added as web browser\nsource.$

You can use the “Transparent background (for stream integration, with OBS for example)” option to have a transparent background in OBS. If you want to customize the background transparency, you can add this CSS in your OBS browser source’s settings:

:root {
  --livechat-transparent: rgba(255 255 255 / 90%) !important;
}

In the previous CSS snippet, you can of course change the color or the transparency, by adapting the color values.

Note: you can entirely customize chat colors. This is undocumented yet, but you can try this: in the modal, check «use curent theme colors», then you can try to manually change color values in the URL. You must use valid CSS color values, and they must be properly URL encoded.

OBS Dock

Info

This feature comes with the livechat plugin version 10.1.0.

Warning

This feature can be disabled by the instance’s adminitrators.

You can use OBS “Custom browser docks” to integrate the chat in your OBS while you are streaming. The livechat plugin offers a way to create long term token that can identify you automatically to join the chat, so you don’t have to enter your password in OBS.

To do so, just use the “Compartilhar link do chat” feature, and open the “Dock” tab. From there, you can create a new token using the “+” button.

$Screenshot of the “Compartilhar link do chat” dialog, on the\n“Dock tab. A token was generated, and is\nselectionable.”$ $Screenshot of the “Compartilhar link do chat” dialog, on the\n“Dock tab. A token was generated, and is\nselectionable.”$

Then, copy the url, and use the “Docks / Custom browser docks” menu from your OBS to add a dock with this URL.

$Screenshot of the OBS Dock menu, with a “Custom Browser Docks”\nentry.$ $Screenshot of the OBS Dock menu, with a “Custom Browser Docks”\nentry.$

$Screenshot of the OBS Custom Browser Docks dialog, with a new dock called\n“My\nchat”.$ $Screenshot of the OBS Custom Browser Docks dialog, with a new dock called\n“My\nchat”.$

Once you have done, you will have a new dock connected to the chat with your account.

$Screenshot of OBS with a new dock including the chat. The user is logged\nin with their Peertube account, and can chat directly from\nOBS.$ $Screenshot of OBS with a new dock including the chat. The user is logged\nin with their Peertube account, and can chat directly from\nOBS.$

Tip

Tokens are valid to join any chat room. You don’t have to generate separate tokens for each of your rooms. You can also customize the nickame that will be used by changing the n parameter in the url.

Don’t share these links to anyone, as it would allow them to connect as yourself.

If a token is compromised, or no more needed, you can revoke them.

Info

These tokens can be used for other purposes, as connecting to your account with XMPP bots or clients. This feature is not documented yet, and not officially supported. So use with care.

Mixing multiple chats in your live stream

You can use the social_stream browser extension to mix multiple chat source (from Peertube, Twitch, Youtube, Facebook, …) and include their contents in your live stream. The compatibility with this plugin was added in recent versions.