Alerts
This overlay/dock is used to display multiplatform alerts to viewers. These alerts can have custom messages, images, and sounds.
The installation and configuration of our dock are necessary for this overlay to work ; alerts events must also be enabled for every configured platform.
Overlay
https://obs.multistream.tools/v1/wrapper?url=https://obs.multistream.tools/v1/overlays/alerts/overlay
This form is intended to be integrated into OBS as a browser source and displays multiplatform alerts on your stream with custom messages, images and sounds.
The Twitch Policy currently do not allow multiplatform alerts to appear on your stream. Such a practice is however accepted in OBS as a custom browser dock.
Parameters
No specific parameters, besides the system ones common to all overlays, are available.
Variables
Specific CSS variables useful when writing a theme are as follows:
| name | value | description |
|---|---|---|
--background | Color, image, gradient (default black) | Message box background style |
--duration | Duration (0.5s by default) | Duration of the alert entry/exit animation |
Those of our CSS framework having been redefined are as follows:
| name | value |
|---|---|
--fontFamily1 | 'Nunito Sans' (from Google Fonts) |
--fontSize | 27px |
--fontWeight | 700 |
Configurator
Dock
https://obs.multistream.tools/v1/wrapper?url=https://obs.multistream.tools/v1/overlays/alerts/dock
This form is intended to be integrated into OBS as a custom browser dock and displays, for the streamer only, an admin interface to customize alerts. The entered values are saved and persisted between different restarts of OBS on a given computer.
Each alert type includes four text fields, all optional, allowing you to respectively customize the message, image, sound and volume of the alert.
The message has a default value (leaving your mouse pointer over this field also displays it) containing dynamic slots that will be automatically filled by our system for each alert. These are delimited by a pair of curly braces surrounding the name corresponding to the value to be filled, for example:
{event}for the type of event (cheer, superchat, elixir, ...){name}for the nickname of the viewer who initiated the event{amount}for the amount (month, bits, monetary, ...) depending on the event type{platform}for the platform on which the event occurred
The image and sound fields must contain URLs pointing to remote resources served over HTTPS. Some services such as Giphy and Voicemod allow you to respectively draw from a large database of animated images and sounds.
Not all online services - especially when it comes to sounds - allow their media to be included in our alerts, for reasons beyond our control.
It is important that you comply with current legislation regarding the use of content subject to copyright.
The volume field allows you to independently adjust the volume of each sound accompanying an alert. Its value represents a percentage between 0 (0%) and 1 (100%).
Each alert is enabled by default but you can choose to disable some of them using the associated Enable buttons. This can be useful when you don't want to completely filter out some events via the adapters configuration.
Don't forget to save your changes by regularly pressing the button named Apply, displayed at the bottom right of the dock.
You can also make sure that your customizations work properly using the Emulate button present for all alert types. Each time you click it, a simulated alert will be played immediately, canceling any other alerts that may still be in the queue.
Finally, the buttons named Platforms and Messages allow you to hide or display the logos of the different platforms as well as the messages for all alerts.
In fact, you can display only images or messages, play only sounds, etc.; you are free to compose your alerts as you wish!
Settings
No specific parameters, besides the system ones common to all overlays, are available.