Walkthrough Guide

The following Walkthrough Guide is to be used for extension submission on https://dev.twitch.tv. Make sure to include the relevant changelog from CHANGELOG.md.

## Walkthrough Guide

This extension provides functionality for streamers playing Hearthstone to enhance their stream with hover areas and a deck list using the downloadable Hearthstone Deck Tracker tool. Viewers may hover over various parts of the board and the deck list to see the full card art, and may also copy the deck for usage inside the game. A reduced version of the deck list widget is available for mobile viewers. Card names are localized to a viewer's language if it is a language in which Hearthstone is available.

The setup prompts the user to download Hearthstone Deck Tracker and follow a setup procedure to connect the downloaded app with the Extension Backend Service (EBS). Furthermore they may configure the on-stream overlay.

Once a game is running, the extension listens for PubSub messages from the EBS. These are then used to render the aforementioned overlay and decklist over the stream. The deck list can be unpinned by clicking the circle in the top right. It will then automatically hide whenever the mouse leaves the stream or is held still. Viewers may also manually drag and drop the deck list. When hovering a card, a statistics panel powered by HSReplay.net appears as a tooltip in the corner of the stream.

The demo data will periodically switch to the Battlegrounds mode, in which the deck list is replaced with a popup at the top of the screen showing the odds of the currently running (simulated) game. The viewer can modify it's behaviour on the left hand side, although that requires EBS interaction that is not modeled during review.

The extension's source code is available at https://github.com/HearthSim/twitch-hdt-frontend.