|
|
@@ -34,10 +34,16 @@
|
|
|
<li><u>Redeems</u> are standard stream point rewards. They get added to the queue for the streamer to fulfill.</li>
|
|
|
<li><u>Specials</u> are redeems, but they run system commands and scripts. This enables you to integrate a lot of other fun things, such as letting your viewers control lighting, activate devices, trigger webhooks, etc. Specials do not go into the queue, because they happen automagically.</li>
|
|
|
<ul>
|
|
|
- <li>Be careful with this one. It does require some more advanced scripting/command line knowledge. Make sure you test your specials before letting viewers use them.</li>
|
|
|
+ <li>Be careful with this one. It does require some more advanced scripting/command line knowledge, and it can be dangerous. Make sure you test your specials thoroughly before letting viewers use them.</li>
|
|
|
</ul>
|
|
|
<li><u>Votes</u> are just that, votes. Your viewers can vote on them.</li>
|
|
|
+ <ul>
|
|
|
+ <li>See the "Overlays" section of the readme, for instructions on using the votes overlay in your stream.</li>
|
|
|
+ </ul>
|
|
|
<li><u>Goals</u> are rewards that everyone in chat can contribute to. The streamer fulfills the reward when the goal is reached.</li>
|
|
|
+ <ul>
|
|
|
+ <li>See the "Overlays" section of the readme, for instructions on using the goals overlay in your stream.</li>
|
|
|
+ </ul>
|
|
|
<li>Add rewards to categories to enable and disable groups of rewards.</li>
|
|
|
<li>Rewards with no categories are inactive.</li>
|
|
|
</ul>
|
|
|
@@ -274,16 +280,16 @@
|
|
|
</thead>
|
|
|
<tr>
|
|
|
<td> <label for="announce_enable">Enable:</label> </td>
|
|
|
- {% if settings_info[9] %}
|
|
|
- <td> <input type="checkbox" name="announce_enable" value="{{ settings_info[9] }}" checked> </td>
|
|
|
+ {% if settings_info[8] %}
|
|
|
+ <td> <input type="checkbox" name="announce_enable" value="{{ settings_info[8] }}" checked> </td>
|
|
|
{% else %}
|
|
|
- <td> <input type="checkbox" name="announce_enable" value="{{ settings_info[9] }}"> </td>
|
|
|
+ <td> <input type="checkbox" name="announce_enable" value="{{ settings_info[8] }}"> </td>
|
|
|
{% endif %}
|
|
|
<td>Enable periodic announcements</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td> <label for="announce_interval">Interval:</label> </td>
|
|
|
- <td> <input type="number" name="announce_interval" value="{{ settings_info[10] }}" size="2" required> minutes</td>
|
|
|
+ <td> <input type="number" name="announce_interval" value="{{ settings_info[9] }}" size="2" required> minutes</td>
|
|
|
<td>How long between each announcement?</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
@@ -323,19 +329,16 @@
|
|
|
<td>How many points do you want to award them?</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
- <td> <label for="gunicorn_logging">Gunicorn Logging:</label> </td>
|
|
|
- {% if settings_info[3] %}
|
|
|
- <td> <input type="checkbox" name="gunicorn_logging" value="{{ settings_info[3] }}" checked> </td>
|
|
|
- {% else %}
|
|
|
- <td> <input type="checkbox" name="gunicorn_logging" value="{{ settings_info[3] }}"> </td>
|
|
|
- {% endif %}
|
|
|
- <td>Enable Gunicorn logging integration.</td>
|
|
|
+ <td> <label for="prefix">Chat Command Prefix:</label> </td>
|
|
|
+ <td> <input type="text" name="prefix" maxlength="1" size="1" value="{{ settings_info[3] }}" required> </td>
|
|
|
+ <td>Character that preceeds chat commands, so OwnchatBot knows what to look for.<br>Example: "{{ settings_info[3] }}points"</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
- <td> <label for="prefix">Chat Command Prefix:</label> </td>
|
|
|
- <td> <input type="text" name="prefix" maxlength="1" size="1" value="{{ settings_info[4] }}" required> </td>
|
|
|
- <td>Character that preceeds chat commands, so OwnchatBot knows what to look for.<br>Example: "{{ settings_info[4] }}points"</td>
|
|
|
+ <td> <label for=ocb_url>External URL:</label> </td>
|
|
|
+ <td> <input type="text" name="ocb_url" size="40" value="{{ settings_info[10] }}" required> </td>
|
|
|
+ <td>What is the external URL of your OwnchatBot?</td>
|
|
|
</tr>
|
|
|
+
|
|
|
</table>
|
|
|
|
|
|
<h3>Owncast Integration</h3>
|
|
|
@@ -354,12 +357,12 @@
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td> <label for="access_token">Access Token:</label> </td>
|
|
|
- <td style="padding: 5px;"> <input type="password" name="access_token" value="{{ settings_info[5] }}" size="40"> </td>
|
|
|
+ <td style="padding: 5px;"> <input type="password" name="access_token" value="{{ settings_info[4] }}" size="40"> </td>
|
|
|
<td>The token you created above.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td> <label for="owncast_url">Your Owncast URL:</label> </td>
|
|
|
- <td> <input type="text" name="owncast_url" value="{{ settings_info[6] }}" size="40"> </td>
|
|
|
+ <td> <input type="text" name="owncast_url" value="{{ settings_info[5] }}" size="40"> </td>
|
|
|
<td>The external URL of your Owncast instance, with "http://" or "https://".</td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
@@ -375,17 +378,17 @@
|
|
|
</thead>
|
|
|
<tr>
|
|
|
<td> <label for="kofi_integration">Enable:</label> </td>
|
|
|
- {% if settings_info[8] %}
|
|
|
- <td> <input type="checkbox" name="kofi_integration" value="{{ settings_info[8] }}" checked> </td>
|
|
|
+ {% if settings_info[7] %}
|
|
|
+ <td> <input type="checkbox" name="kofi_integration" value="{{ settings_info[7] }}" checked> </td>
|
|
|
<td>Enable Ko-fi integration.</td>
|
|
|
{% else %}
|
|
|
- <td> <input type="checkbox" name="kofi_integration" value="{{ settings_info[8] }}"> </td>
|
|
|
+ <td> <input type="checkbox" name="kofi_integration" value="{{ settings_info[7] }}"> </td>
|
|
|
<td>Enable Ko-fi integration. ("Kofi Settings" button will appear in the navigation bar when enabled.)</td>
|
|
|
{% endif %}
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td> <label for="kofi_token">Verification Token:</label> </td>
|
|
|
- <td style="padding: 5px;"> <input type="password" name="kofi_token" value="{{ settings_info[7] }}" size="40"> </td>
|
|
|
+ <td style="padding: 5px;"> <input type="password" name="kofi_token" value="{{ settings_info[6] }}" size="40"> </td>
|
|
|
<td>Get from Kofi -> More -> API -> Webhooks -> Advanced -> Verification Token.</td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
@@ -489,6 +492,33 @@
|
|
|
<form action="/mgmt/clearlist" method="get" style="display: inline;">
|
|
|
<button class="button button2" type="submit" class="button">Clear List</button>
|
|
|
</form>
|
|
|
+ <hr>
|
|
|
+ <h3>Stream Overlay</h3>
|
|
|
+ To place the to-do list overlay in your stream, create a browser source in your streaming software<br>using the following URL: {{ settings_info[10] }}/todo<br>
|
|
|
+  Recommended width: 420<br>
|
|
|
+  Recommended height: 500<br>
|
|
|
+  In OBS, check "Refresh browser source when scene becomes active"
|
|
|
+ <br><br>
|
|
|
+ You can spruce up your list with fonts and colors by inserting custom CSS into the browser source.<br>
|
|
|
+ <h5>Example CSS:</h5>
|
|
|
+  h4 {<br>
|
|
|
+   font-size: 32px;<br>
|
|
|
+   text-decoration: underline;<br>
|
|
|
+   text-align: center;<br>
|
|
|
+   margin-bottom: 0;<br>
|
|
|
+   padding-bottom: 0;<br>
|
|
|
+  }<br><br>
|
|
|
+
|
|
|
+  ul {<br>
|
|
|
+   margin-top: 0;<br>
|
|
|
+   padding-top: 0;<br>
|
|
|
+  }<br><br>
|
|
|
+
|
|
|
+  li {<br>
|
|
|
+   font-size: 30px;<br>
|
|
|
+  }<br><br>
|
|
|
+ If you want to use a custom font, place the font file in your "instance/assets/" folder, and reference the following location in your CSS:<br>
|
|
|
+   /assets/yourfont.ttf
|
|
|
<br><br>
|
|
|
</div>
|
|
|
|
|
|
@@ -502,7 +532,7 @@
|
|
|
<th style="width: 20%;">Image</th>
|
|
|
<th></th>
|
|
|
<th style="width: 15%;"></th>
|
|
|
- <th style="width: 25%;">Browser Source</th>
|
|
|
+ <th style="width: 45%;">URL</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tr>
|
|
|
@@ -522,7 +552,7 @@
|
|
|
<td><button id="nf_upload" class="button button2" type="submit">Upload</button>
|
|
|
</form> 
|
|
|
<a href="{{ url_for('web_panels.del_alert', alert_type='FOLLOWER_ALERT') }}"><button class="button button2" onclick="openTab(event, 'alerts')"><span style="color: red;">Clear</span></button></a></td>
|
|
|
- <td>/alert/follower</td>
|
|
|
+ <td>{{ settings_info[10] }}/alert/follower</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<form id="nms_upload" action="/mgmt/alertupload/MILESTONE_ALERT" method="post" enctype="multipart/form-data">
|
|
|
@@ -540,7 +570,7 @@
|
|
|
<td><input type="file" name="MILESTONE_ALERT" accept=".gif, .jpg, .jpeg, .png, .webm" required></td>
|
|
|
<td><button id="nms_upload" class="button button2" type="submit">Upload</button></form> 
|
|
|
<a href="{{ url_for('web_panels.del_alert', alert_type='MILESTONE_ALERT') }}"><button class="button button2" onclick="openTab(event, 'alerts')"><span style="color: red;">Clear</span></button></a></td>
|
|
|
- <td>/alert/milestone</td>
|
|
|
+ <td>{{ settings_info[10] }}/alert/milestone</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<form id="ng_upload" action="/mgmt/alertupload/GOAL_ALERT" method="post" enctype="multipart/form-data">
|
|
|
@@ -558,10 +588,26 @@
|
|
|
<td><input type="file" name="GOAL_ALERT" accept=".gif, .jpg, .jpeg, .png, .webm" required></td>
|
|
|
<td><button id="ng_upload" class="button button2" type="submit">Upload</button></form> 
|
|
|
<a href="{{ url_for('web_panels.del_alert', alert_type='GOAL_ALERT') }}"><button class="button button2" onclick="openTab(event, 'alerts')"><span style="color: red;">Clear</span></button></a></td>
|
|
|
- <td>/alert/goal</td>
|
|
|
+ <td>{{ settings_info[10] }}/alert/goal</td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
+ <h3>Stream Overlays</h3>
|
|
|
+ To use these alerts, create a browser source in your streaming software, using the URLs specified above.<br>
|
|
|
+  Recommended width: 200<br>
|
|
|
+  Recommended height: 200<br>
|
|
|
+  In OBS, check "Refresh browser source when scene becomes active"
|
|
|
+ <br><br>
|
|
|
+ Each alert will display the name of the viewer that triggered the alert. You can customize the position of the name, as well as fonts and colors by inserting custom CSS into the browser source.<br>
|
|
|
+ <h5>Example CSS:</h5>
|
|
|
+  #nameBox {<br>
|
|
|
+   top: 50%; /* Vertical position */<br>
|
|
|
+   left: 50%; /* Horizontal position */<br>
|
|
|
+   font-size: 20px; /* Adjust as needed */<br>
|
|
|
+   font-weight: bold; /* Adjust as needed */<br>
|
|
|
+  }<br><br>
|
|
|
+ If you want to use a custom font, place the font file in your "instance/assets/" folder, and reference the following location in your CSS:<br>
|
|
|
+   /assets/yourfont.ttf
|
|
|
</body>
|
|
|
+ <br><br>
|
|
|
</div>
|
|
|
- <br><br>
|
|
|
</html>
|