Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 2.95 KB

REVIEW_GUIDE.md

File metadata and controls

25 lines (13 loc) · 2.95 KB

Changes

The extension may not work on Android (or iOS) yet, this is filed as twitchdev/issues#455. As the issue describes this is because the app is not providing a token to access the Twitch API, which is not an issue with the code of the extension, but the container it is loaded by.

Guide

The extension shows all subscriber, bits tier reward, follower, cheer, BTTV and FFZ emotes available on a channel. My channel (freaktechnik) is configured by the backend to show the emotes (and cheermotes) of a different channel (itmeJP) while in review. The extension has code to treat my channel as partner/affiliate when not in production, so subscription links also show up, even though the extension knows you can't subscribe to my channel. The subscription links it shows are not intended to be working, since they point to the product pages my channel would have, were it an affiliate/partnered channel. That channel name is overridable in the config, so I could set it to something valid.

All the sections are hideable in the config and their default collapsed state can be controlled, too. For BTTV there's a special setting to show animated emotes, similarly there's a setting to chose between animated and static cheermotes. I've chosen to hide animated BTTV emotes by default to keep the panel area calmer. The title of every section can be chosen.

All sections can be collapsed and expanded by the user. Subscription emote sections also get a button to subscribe to that tier (if the user isn't already subscribed at that tier or higher). Follower emotes should get a button to follow the channel (hard to test that currently...)

If the user authorizes the extension to access their information it reacts to their subscription status, else it just assumes they're subscribed and not subscribed at the same time.

If a user is not subscribed, or their tier is not high enough, emotes they'd get access to by subscribing show a lock icon, and when clicked on, the user is offered a subscribe button to subscribe to the tier that unlocks the emote.

When the user is subscribed, they don't see the subscription button in the header of the section for the tier and tiers below the one they're subscribed to. They also don't get any lock icons (anonymous users also don't get those) and they get a button to copy the emote code when they click on the emote.

Clicking on the emote brings up an overlay, that shows the emote without any overlays or underlays (lock, "drop shadow"/spotlight), a toggle to view the emote against light and dark backgrounds, the emote code and an optional description by the broadcaster. The description is set in the configuration by clicking on the emote in the configuration.

Lastly, the overlay shows the buttons with the appropriate actions for the user.

There are global settings to toggle the shadows/spotlights, a toggle to show the emote codes in the basic panel view and the option to disable the popout version having all sections expanded.