RGLtv Streaming Tools

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Waffle Iron ======
Waffle Iron is a raffle system designed to select an active chatter at random in order to award them in some way.  The most recent incarnation is web based, and consists of up to 4 separate but connected web pages.

It is important to note that the data is not stored on the server, that the controller expects all used pages to be open before operation, and that refreshing any of these pages can result in desync or loss of data (especially the controller), though efforts have been made to sync data at important points.  As such, any pages used in OBS browser sources should disable both "Shutdown source when not visible" and "Refresh browser when scene becomes active".

===== Pages =====
The URL scheme of the various pages is fairly simple, using a unique key that is consistent across all the URLs to instruct the server pass information to the proper pages.  The [unique key] shown in each URL below should be exactly the same.  Keep in mind that this unique key does not prevent multiple copies of the pages, so be sure to use a value that is unlikely to be used by others, and it is advisable to use one that is difficult to guess.

The Controller page will also generate buttons to copy the corresponding URLs, however these buttons are hidden if the window size is too small (such as mobile devices).

  * [[waffleiron#Controller|Controller]] - <code>https://www.rgltv.com/raffle/[unique_key]</code>
  * [[waffleiron#Output|Output]] - <code>https://www.rgltv.com/raffle/[unique_key]/output</code>
  * [[waffleiron#Game name|Game name]] - <code>https://www.rgltv.com/raffle/[unique_key]/gametext</code>
  * [[waffleiron#Timer|Timer]] - <code>https://www.rgltv.com/raffle/[unique_key]/timer</code>



===== Controller =====
{{::waffleironcontroller.png?400|}}

The controller is what operates the raffles and handles data.  If this page is refreshed, all data will be reset to it's initial state; clearing bans, silent bans, past winners, alarm settings, etc. 

==== Past Winners ====
This box shows a list of previous winners that occurred during this raffle session.  As with all of these boxes, it will not persist through a reload of the web page.  Names are automatically added to this list when the "Reset" button is pressed.

Past winners cannot win again, and will be prevented from being put into the entries whatsoever.  Clicking the "x" next to their name will remove them from this list and allow entry again.

==== Raffle Entries ====
This box shows a list of all current entrants to the raffle, as well as showing the total number of entries in the label above.  Clicking the "x" next to a name here will remove them from entries, as well as adding them to the "Bans" list, preventing future entries.  This list will not persist through reload.

==== Bans ====
The Bans list displays the usernames that are currently banned from entering the raffle.  Clicking the "x" by a name will remove it from bans.  This list will not persist through reload.

==== Silent Bans ====
A list of the usernames that are currently silent banned, as well as a text entry for adding to the list.  Names in this area are allowed to enter the raffle and be displayed on the output scroll, but will never be allowed to win.  Clicking the "x" next to a name will remove it from the list and allow a user to win again.  This list does not persist through reload.

==== Winner Text Chat ====
This box shows chat messages from the current winner of the raffle, to make it easier to see their responses.  The winner's name and status as a subscriber will be displayed in the label above.  Highlighting text in this section will propagate that text to the "Game name" box, clearing anything previously entered into that input.

==== Basic Operation ====
The basic flow of a raffle goes as follows:
  - Click "Accept entries" to start accepting entries.  This will also change the display text of the output page to reflect that entries are open, and that sending a chat message will enter them into the raffle.  The "Accept entries" button will now display "Spin".
  - As chatters enter the raffle, their names will appear in the "Raffle entries" box.  Clicking the "x" next to their name in this box will remove them from entries and put them into the "Ban" box.  Additionally, the total number of entries will be shown above the "Raffle entries" box.
  - After waiting an arbitrary amount of time, click the button that is now labelled "Spin".  The winner will immediately show next to the "Winner chat messages" box, but be aware that the output page will take longer to display this information, via an animation of spinning through the names to choose said winner.  If you clicked "Spin" as a mistake, you can click the "Undo" button that has appeared.  This will return the output page to it's slow scroll state with all entries retained.
  - As soon as a winner is chosen, all chat messages from the winner will appear in the "Winner chat messages" box.  This will make it easier to see their response.
  - Highlighting text within the "Winner chat messages" box will populate the "Game name" text input.  This text input can also be manually entered/adjusted.  Clicking the "Post game name" button will push this text to the "Game name" page for display via OBS browser source.
  - If the winner is a subscriber, it will be displayed next to their name on the "Winner chat messages" box.  The subscriber status will also properly alter the "Set timer" button.  Clicking this button will start the appropriate countdown on the timer page.
  - Clicking the button that is now labelled "Reset" will clear raffle entries and winner chat, as well as returning the raffles to the closed state.  The button will go back to displaying "Accepting entries".
  - Repeat from the top as needed

Timer alarm sound can also be set via this page.  The default is a random sound, but you can set a specific sound via the dropdown.  Additionally, clicking the play icon next to a chosen sound in the dropdown will preview that sound.

Lastly, all links to the corresponding pages involved with this specific raffle controller id can be copied via their respective "Copy link" buttons, for easy pasting into OBS.  These copy buttons are hidden on mobile/small browser windows.

===== Output =====
{{:waffleironoutput.png?200|}}

The output page is intended to be shown as an OBS browser source, directly to the audience.  It should be loaded before attempting to operate the raffle via the controller.  It is recommended to set the browser source to "Control audio via OBS" or make sure that the default audio device is being captured by OBS.

The minimum width and height set in the browser source properties should be 1643 width and 617 height. To avoid desync, both "Shutdown source when not visible" and "Refresh browser when scene becomes active" should be disabled.
===== Game name =====
{{:waffleirongamename.png?200|}}

The game name page is initially blank, but will display text pushed via the "Post game name" button, from the "Game name" text input.  You can populate this text field by highlighting text in the "Winner chat messages" box, or by directly typing.

This is intended to be shown as an OBS browser source.  The text will center and wrap automatically.  Be sure to set the width and height in the browser source properties in order to define this centering and wrapping to fit your layout.  No audio is played by this page.

===== Timer =====
{{:waffleirontimer.png?200|}}

The timer page will count down from 15 or 20 minutes, depending on the subscription status of the winner.  The timer will start when you click the "Set timer" button.  If you have an alarm sound set, it will play when the timer reaches 00:00.  Therefore this page should also be shown as an OBS browser source and set to "Control audio via OBS" or have OBS capture the default sound device.

Width and height can be set fairly conservatively, 80x40 should be plenty of room.  If you are scaling up to fit your layout, scale filtering of "Point" will be more crisp than other options, but you can play with it to see what you like best.