Differences

This shows you the differences between two versions of the page.

--- waffleiron [2025/01/01 03:28] – [Pages] kavoc
+++ waffleiron [2025/01/01 21:22] (current) – [Controller] kavoc
@@ Line 5: / Line 5: @@
 ===== Pages =====
-The URL scheme of the various pages is fairly simple, using a unique key that is consistent across all the URLs to let 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 advisable to use one that is difficult to guess.
+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).
@@ Line 21: / Line 21: @@
 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".
@@ Line 36: / Line 54: @@
 ===== 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.
@@ Line 44: / Line 67: @@
 ===== Timer =====
-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.  There this page should also be shown as an OBS browser source, set to "Control audio via OBS" or have OBS capture the default sound device.
+{{: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.