Dock
Our dock, as described previously, is distributed in the form of an HTML page present at the following address:
https://obs.multistream.tools/v1/dock
The dock receives, processes, displays and transmits events emitted by the configured adapters. It is therefore necessary to add our dock as a custom browser dock in your OBS installation otherwise none of our tools will be able to work.
Settings tab
The first thing to do after adding our dock to OBS is to configure it. This takes place in the tab named Settings. It will then simply be a matter of adding as many adapters as you want - one per platform - by clicking as many times as necessary on the Add button in the Adapters section then by entering the associated URLs in each form field on the screen. Then don't forget to save your configuration by clicking on the Save/Reload button!
It can sometimes be difficult to know which platform an adapter refers to just by looking at its URL; you can then add for example #twitch at the end of it as a label.
This button, as its name suggests, also allows you to reload each adapter in case of any problem. You will also find a button named Reload overlays allowing you to reload each overlay in the same way.
Activity Feed tab
Once the dock is configured correctly, the tab named Activity Feed will undoubtedly become the one on which you spend the most time as a streamer. Indeed, its goal is to list alert category events, taking care to identify the platforms on which they took place. The most recent events are added to the top of the list and only those occurring during a stream session are displayed. It therefore makes it extremely easy to thank the people behind these various alerts.
The Activity Feed tab also includes three buttons named Mute, Pause and Skip communicating directly with the overlays in order to respectively mute the alerts, pause them or ignore certain ones if necessary. These buttons are only activated when you have previously configured at least one adapter and it has been loaded correctly.
The Mute and Pause buttons actually behave like switches, so a first click will put them in the "on" position and a second will switch them back to the "off" position. The state of these buttons is preserved between different restarts of OBS on a given computer.
Parameters
| name | value | optional |
|---|---|---|
lang | User interface language (detected by default) | yes |
theme | Local, remote, or data URL | yes |
fonts | Google Fonts query, without ?family=, or false | yes |
zoom | Percentage (1, meaning 100%, by default) | yes |
The optional parameter named lang allows you to modify the dock user interface language. It is automatically detected to match the setting of your OBS installation but you can use this parameter to force the language of your choice. The currently supported values are en (English) and fr (French).
https://obs.multistream.tools/v1/dock?lang=en
The optional parameter named theme allows you to apply the theme of your choice in order to modify the visual appearance of the default interface. Customizing the colors and/or the size of the texts can help better reading or simply better integrate into a setup where particular attention is paid to the look.
https://obs.multistream.tools/v1/dock?theme=./themes/streamelements/dock.css
If you just want to customize the dock font, writing a theme is not necessary, just use the optional parameter named fonts to load one via the Google Fonts API.
https://obs.multistream.tools/v1/dock?fonts=Tangerine
The value of the Google Fonts API family parameter must always come first and the value of the display parameter is swap by default.
In case you want to pass several parameters to the Google Fonts API, it is important to encode (%2526) each & character separating them; we will therefore write:
https://obs.multistream.tools/v1/dock?fonts=Tangerine%2526display=auto
Instead of:
https://obs.multistream.tools/v1/dock?fonts=Tangerine&display=auto
If you judge that the dock display should be adjusted, there is also no need to create a theme, you can simply use the optional parameter named zoom dedicated to this purpose.
https://obs.multistream.tools/v1/dock?zoom=1.5
You will find more details regarding the themes on the dedicated page.