Twitch Extension Installation

Twitch Extensions can be installed from the Extension manager tab on the Twitch Dashboard.

  1. A Muxy account will be required to install our Extensions. If you don’t have one yet, go to https://u.muxy.io/login and log in with your Twitch credentials.
  2. Open your Twitch Dashboard.
  3. Open the new “Extension Manager” tab. This tab is divided into two sections, “Installed Extensions” and “Available Extensions”.  
  4. Muxy’s Extensions are called “Overlay” and “Leaderboard”. To install the Extensions click the “Install” button on the right side of the Extension card of the extension that you want to display. Alternatively, you can press the Install button on the Extension Details page to install an extension
  5. Installed Extensions are displayed in the “Installed Extensions” list on the left side of the “Extension Manager” tab. Once an extension has been installed it will no longer appear in list of “Available Extensions”.
  6. On extension installation success a prompt will be displayed with two options, “Continue Browsing” or “Configure”. Selecting “Continue Browsing” will leave you on your current page while selecting “Configure” will open the configuration options for that extension.

Twitch Extension Activation

Installed Twitch Extensions start off in an inactive state with default settings that can be changed on the corresponding configuration page linked from a settings/gear icon.

  1. To activate your installed Extensions click the “Activate” button next to each extension that you want to turn on.
  2. Upon activating an overlay extension, you will see a prompt asking to set the Overlay as the EXTENSION-OVERLAY 1. (Only 1 overlay extension can be active at a time for now.)
    Upon activating a panel extension, you will see a prompt asking to pick which panel slot to display the panel extension in. (You may run more than one panel extension at a time.)

Twitch Extension Configuration/Settings

Some Extensions have broadcaster-facing settings like different modes, variables, and appearances.

To change these settings start at the list of installed Extensions. Each extension will have a settings/gear icon. Selecting this icon will present the settings for corresponding extension. Once you’re there change the settings to your taste and save your changes.

Overlay General Config

In the Overlay config broadcasters can change the position of the Overlay toolbar, the apps displayed, and modify settings for apps.

The Toolbar Position file contains a left option and a right option, which refers to the side of the screen that you want your viewers to see the Overlay toolbar on. Note that the Overlay toolbar will auto-hide when the mouse is not directly over the video player on the channel page or when there is no activity for several seconds.

The Overlay contains several apps that can be toggled on or off. If an app is toggled to the ‘Off’ state then it will not appear in the Overlay toolbar. Left is off and right is on.

Clicking on the gear icon next to each app will open the app config where app specific settings can be made.

Overlay Click Map App Config

The Click Map app has no settings but the confetti and click map visualization URL can also be found here. This URL will render confetti particles and user clicks, using this URL as a browser source in your broadcasting software will allow you to share the visualization with your viewers.

Overlay Confetti App Config

The Confetti app has settings: a Color Set picker and a Confetti Multiplier.

The Color Set picker allows the broadcaster to specify different color schemes to apply to the confetti.

The Confetti and Click Map URL can also be found here. This URL will render confetti particles and user clicks, using this URL as a browser source in your broadcasting software will allow you to share the visualization with your viewers.

The Confetti Multiplier setting affects the speed with which confetti is generated. Increasing the multiplier will increase the frequency of the confetti showers. Remember to save your changes.

Overlay Feels Meter App Config

The Feels Meter app has options for 2 different types of gauges: Dial and Emote.

The Emote gauge sub-settings are where the broadcaster can pick between a number of cheermotes to represent positive and negative sentiment. Remember to save your changes!

Overlay Globe App Config

The Globe app has a Color Set picker which allows the broadcaster to specify different color schemes to apply to the globe.

Remember to save your changes.

Overlay Lupinball App Config

The Lupinball Overlay app requires that you pair it with the game itself.

Once you have Lupinball installed here’s how to connect it to the Overlay app.

  1. Open Lupinball
  2. Go to options, and scroll to the Twitch.TV option, and press Enter.
  3. A modal will display with a 4 digit alphanumeric code.
  4. Enter the code into the Lupinball Overlay app config in the Extension Manager.

Overlay Polls App Config

The Overlay Polls app configuration page contains no settings.  All broadcaster input for polls takes place on the Twitch Dashboard.

Overlay Pretzel App Config

The Overlay Pretzel app configuration page contains no settings.

Overlay Spotify App Config

The Overlay Spotify app configuration page contains no settings.

Leaderboard (Panel) Config

In the Leaderboard config broadcasters can set custom text for the leaderboard title, the default tab displayed, and a hidden name that broadcasters can use to replace inappropriate names if necessary (default is Anonymous). Remember to save your changes.

Additionally, the following fields can be set to on or off:

Show Bits – Displays the amount of bits a user has cheered on the leaderboard panel.

Show All Time – Display or hide the All Time cheer tab on the leaderboard panel.

Show Monthly – Display or hide the Monthly cheer tab on the leaderboard panel.

Show Weekly – Display or hide the Weekly cheer tab on the leaderboard panel.

Show Session – Display or hide the Session cheer tab on the leaderboard panel.

Extension Deactivation And Uninstallation

Extension Deactivation

From the Extension Manager tab on the Twitch Dashboard Extensions can be deactivated which will effectively turn the extension off but it will leave it installed.

To deactivate an installed extension:

  1. Go to the Extension Manager tab on the Twitch Dashboard.
  2. View the Installed Extensions list, find the extension that you want to deactivate in the list.
  3. Click on the activate/deactivate drop down menu and select deactivate.

 

Extension Uninstallation

Dashboard Extensions can be uninstalled from the Extension Manager tab on the Twitch. To use a previously uninstalled extension you must re-install it from the available Extensions list and activate it again.

To uninstall an installed extension:

  1. Go to the Extension Manager tab on the Twitch Dashboard.
  2. View the Installed Extensions list, find the extension that you want to uninstall in the list.
  3. Click on the corresponding uninstall button (trash can icon).
  4. Verify that you would like to Uninstall to complete.