You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/chatbot-basics-guide.html
+29-1Lines changed: 29 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -163,10 +163,38 @@ <h2>5. Choose Where Replies Go</h2>
163
163
</tbody>
164
164
</table>
165
165
<p>The custom bot name is a message prefix; it does not create a new platform account. Unless standalone-app account-role routing is configured, replies are posted through the account used by the captured source.</p>
166
-
<p>The bot overlay can clear replies automatically: use <code>showtime=10000</code> for a fixed 10-second display, <code>autohide</code> for a message-length estimate, or <code>hideaftertts</code> to hide after speech finishes. Length-based timing defaults to 4–30 seconds and can be adjusted with <code>mintime</code> and <code>maxtime</code>. The remote API action <code>clearBotOverlay</code> clears it manually without stopping active speech.</p>
167
166
<p>Standalone app users who want a separate Twitch identity can follow the <ahref="twitch-bot-account-chatbot.html">Twitch Bot Account guide</a>.</p>
168
167
</div>
169
168
169
+
<divclass="guide-card">
170
+
<h2>6. Clear and Auto-Hide Bot Replies</h2>
171
+
<p>These controls affect the Primary Chat Bot page, <code>bot.html</code>. They do not clear the main featured-message overlay.</p>
<tr><tddata-label="Option"><code>showtime</code></td><tddata-label="Meaning">Uses one fixed display time in milliseconds.</td><tddata-label="Example"><code>&showtime=10000</code> hides after 10 seconds.</td></tr>
178
+
<tr><tddata-label="Option"><code>autohide</code></td><tddata-label="Meaning">Estimates display time from the reply's word count. <code>autotime</code> is also accepted.</td><tddata-label="Example"><code>&autohide</code></td></tr>
179
+
<tr><tddata-label="Option"><code>mintime</code> / <code>maxtime</code></td><tddata-label="Meaning">Sets the minimum and maximum length-based display time. Defaults are 4,000 and 30,000 milliseconds.</td><tddata-label="Example"><code>&autohide&mintime=5000&maxtime=20000</code></td></tr>
180
+
<tr><tddata-label="Option"><code>hideaftertts</code></td><tddata-label="Meaning">Keeps the reply visible until TTS playback finishes, then hides it. If playback never starts, a length-based fallback is used.</td><tddata-label="Example"><code>&hideaftertts</code></td></tr>
181
+
<tr><tddata-label="Option"><code>hidedelay</code></td><tddata-label="Meaning">Adds a delay after TTS finishes. The default is 500 milliseconds.</td><tddata-label="Example"><code>&hideaftertts&hidedelay=1000</code></td></tr>
182
+
<tr><tddata-label="Option"><code>ttstimeout</code></td><tddata-label="Meaning">Safety timeout if TTS remains active indefinitely. The default is 120,000 milliseconds.</td><tddata-label="Example"><code>&hideaftertts&ttstimeout=60000</code></td></tr>
183
+
</tbody>
184
+
</table>
185
+
<p>If multiple modes are enabled, <code>hideaftertts</code> takes priority, followed by <code>autohide</code>, then <code>showtime</code>. The generated bot-overlay settings provide the common options.</p>
186
+
<h3>Clear It Manually</h3>
187
+
<ulclass="guide-list">
188
+
<li>In Social Stream settings, select <strong>Clear bot overlay now</strong>.</li>
189
+
<li>With Remote API Control enabled, open <code>https://io.socialstream.ninja/SESSION_ID/clearBotOverlay</code>.</li>
190
+
<li>Over the API WebSocket, send <code>{"action":"clearBotOverlay"}</code>.</li>
191
+
</ul>
192
+
<p>Manual clearing removes the visible reply and pending bot-overlay display queue, but it does not stop speech already playing.</p>
193
+
<divclass="guide-note">
194
+
<p><strong>Custom styling:</strong> custom CSS used with the normal generated <code>bot.html</code> link keeps these features. A copied or modified local <code>bot.html</code> file must be updated to receive later page fixes.</p>
195
+
</div>
196
+
</div>
197
+
170
198
<divclass="guide-card">
171
199
<h2>Troubleshoot by the Last Thing That Worked</h2>
0 commit comments