This is an example of the TwitchWorks plugin you can use to get started. Please note that you will need to own TwitchWorks before using this project.

**TwitchWork's documentation can be found here: https://docs.google.com/document/d/1zPvmQbD9uXHutyJwnAaZmIJ-qXMp0KwpiEuOgzlcCXY/edit?usp=sharing **
Please read through this document if you are having any difficulties/would like a more in-depth explaination of the plugin.

With that out of the way, here are some instructions on how to get started using this project:
1. Download TwitchWorks for your chosen version of Unreal Engine. This can be done using the Epic Games Launcher. Please refer to the documentation for additional
   guidance.
2. Unzip the example project (if you haven't already), and open up the uproject file. This may ask you to select a version of Unreal Engine to continue, so please
   select whatever version you installed TwitchWorks for previously (4.25+).
3. Once the project opens, make sure the "VotingExample" level has been opened (this should open automatically). Now press play, to start the login procedure/to see
   an interactive voting example. Please note that you will NEED TO SELECT/CLICK THE VIEWPORT AFTER LOGGING IN for things to work properly!

** So what's in the example project? **
Currently, the example project highlights three of TwitchWorks' main features:

I. It allows you to log in using the Hosted Development Backend: a way to use your players their accounts without having them having to go to a third-party site to create & copy all kinds of authentication tokens.

II. There's an interactive voting example that listens for "yes" and "no" chat messages. It then allows each user to vote ONCE, and displays the counts on the scoreboard. This demonstrates TwitchWorks' chat message functionality

II. There's the "$$test" command (without the "s): this allows users to add a message on the end, which will then be printed to the screen as a Blueprint debug 
    message (eg. "$$test foobarbaz"). There's also the help command ("$$help" / "$$help test"), that give the available commands/a usage guide. 
    This demonstrates TwitchWorks' command system.

** Something's not working **
If something's not working, then please consult the documentation first. There are a few common issues below, but please consult the documentation if these don't work.

I. After logging in to Twitch, you must click on the viewport for everything to work. If you don't do this, you will see the blank level/TwitchWorks won't complete
   the login procedure. If you see the voting widget (the green/red widget) with your username, you should be OK!

II. The development backend is provided as a courtesy service, and may be unavailable. Please refer to the documentation for instructions on setting up your own backend
    (this is something that you'll need to do before releasing your game!)
