Skip to content

Commit 9ec7292

Browse files
steveseguinactions-user
authored andcommitted
docs(chatbot-basics): document bot overlay clearing and auto-hide controls
[auto-enhanced]
1 parent 61f5edd commit 9ec7292

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

docs/chatbot-basics-guide.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,10 +163,38 @@ <h2>5. Choose Where Replies Go</h2>
163163
</tbody>
164164
</table>
165165
<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>
167166
<p>Standalone app users who want a separate Twitch identity can follow the <a href="twitch-bot-account-chatbot.html">Twitch Bot Account guide</a>.</p>
168167
</div>
169168

169+
<div class="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>
172+
<table class="guide-table guide-table-stack">
173+
<thead>
174+
<tr><th>Option</th><th>Meaning</th><th>Example</th></tr>
175+
</thead>
176+
<tbody>
177+
<tr><td data-label="Option"><code>showtime</code></td><td data-label="Meaning">Uses one fixed display time in milliseconds.</td><td data-label="Example"><code>&amp;showtime=10000</code> hides after 10 seconds.</td></tr>
178+
<tr><td data-label="Option"><code>autohide</code></td><td data-label="Meaning">Estimates display time from the reply's word count. <code>autotime</code> is also accepted.</td><td data-label="Example"><code>&amp;autohide</code></td></tr>
179+
<tr><td data-label="Option"><code>mintime</code> / <code>maxtime</code></td><td data-label="Meaning">Sets the minimum and maximum length-based display time. Defaults are 4,000 and 30,000 milliseconds.</td><td data-label="Example"><code>&amp;autohide&amp;mintime=5000&amp;maxtime=20000</code></td></tr>
180+
<tr><td data-label="Option"><code>hideaftertts</code></td><td data-label="Meaning">Keeps the reply visible until TTS playback finishes, then hides it. If playback never starts, a length-based fallback is used.</td><td data-label="Example"><code>&amp;hideaftertts</code></td></tr>
181+
<tr><td data-label="Option"><code>hidedelay</code></td><td data-label="Meaning">Adds a delay after TTS finishes. The default is 500 milliseconds.</td><td data-label="Example"><code>&amp;hideaftertts&amp;hidedelay=1000</code></td></tr>
182+
<tr><td data-label="Option"><code>ttstimeout</code></td><td data-label="Meaning">Safety timeout if TTS remains active indefinitely. The default is 120,000 milliseconds.</td><td data-label="Example"><code>&amp;hideaftertts&amp;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+
<ul class="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+
<div class="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+
170198
<div class="guide-card">
171199
<h2>Troubleshoot by the Last Thing That Worked</h2>
172200
<table class="guide-table guide-table-stack">

0 commit comments

Comments
 (0)