Skip to content

Commit 76b26ea

Browse files
docs: misc chat doc cleanup
1 parent 5c23563 commit 76b26ea

File tree

1 file changed

+82
-80
lines changed
  • streamerbot/2.guide/23.extra-features

1 file changed

+82
-80
lines changed

streamerbot/2.guide/23.extra-features/chat.md

Lines changed: 82 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For example, you can type `/action` to reveal a menu with all actions in your St
5252

5353
Some commands support **Multi-Platform** execution, such as `/title` which can set the title of both Twitch and YouTube broadcasts simultaneously.
5454

55-
![Slash Commands Menu](assets/chat-slash-commands.png){width="500" caption-alt}
55+
![Slash Commands Menu](assets/chat-slash-commands.png){width="500"}
5656

5757

5858
#### Streamer.bot Commands
@@ -68,7 +68,7 @@ When selecting a command, :kbd{value=Enter} will submit the command immediately
6868

6969
If you wish to add input for a command, use :kbd{value=Tab} to select the command and continue typing.
7070

71-
![Streamer.bot Commands Menu](assets/chat-commands.png){width="500" caption-alt}
71+
![Streamer.bot Commands Menu](assets/chat-commands.png){width="500"}
7272

7373
#### Emote Autocomplete
7474
::note
@@ -85,7 +85,7 @@ Emote autocomplete can be triggered at any time and contains emotes from the fol
8585

8686
To select an emote and continue typing, you can use either :kbd{value="Enter"} or :kbd{value="Tab"}
8787

88-
![Emotes Menu](assets/chat-emotes.png){width="500" caption-alt}
88+
![Emotes Menu](assets/chat-emotes.png){width="500"}
8989

9090
### Quick Actions
9191
In settings, you can configure **Quick Actions** for 3 different sources.
@@ -95,80 +95,77 @@ Quick Actions allow you to immediately execute any of your Streamer.bot actions
9595
#### Global
9696
Global Quick Actions are displayed in the bottom-left of the chat window and can be executed at any time.
9797

98-
![Global Quick Actions](assets/chat-quick-actions-global.png){caption-alt width="400"}
98+
![Global Quick Actions](assets/chat-quick-actions-global.png){width="400"}
9999

100100
#### User
101101
User Quick Actions are displayed in the `View User` popup windows that display when you click on a username in chat.
102102

103103
Additional arguments are populated with the usual user args for the respective platform.
104104

105-
![User Quick Actions](assets/chat-quick-actions-user.png){caption-alt width="400"}
105+
![User Quick Actions](assets/chat-quick-actions-user.png){width="400"}
106106

107107
#### Message
108108
Per-message quick actions appear when you hover over a specific chat message.
109109

110110
Additional arguments are populated with the usual message args for the respective platform.
111111

112-
![Message Quick Actions](assets/chat-quick-actions-message.png){caption-alt width="400"}
112+
![Message Quick Actions](assets/chat-quick-actions-message.png){width="400"}
113113

114114
#### Event
115115
Event quick actions appear when you hover any event message
116116

117117
### Highlights
118118
Message and event highlights can be customized for a variety of events.
119119

120-
![Chat Highlight Settings](assets/chat-highlights.png){caption-alt width="500"}
120+
![Chat Highlight Settings](assets/chat-highlights.png){width="500"}
121121

122-
![Chat Highlights](assets/chat-highlights-preview.png){caption-alt width="500"}
122+
![Chat Highlights](assets/chat-highlights-preview.png){width="500"}
123123

124124
## OBS Browser Dock
125125

126126
You can dock the Streamer.bot chat in your OBS studio instance.
127127

128-
::tip
129-
Streamer.bot v0.2.5 or later is required to be able to **send messages** from docked chat
130-
<br><span class="ml-6">Earlier versions will be limited to **read-only** mode</span>
131-
::
132-
133128
### Setup
134129

135130
::steps{level=4}
131+
136132
#### Enable WebSocket Server
137133

138-
::navigate
139-
In Streamer.bot, navigate to **Servers / Clients > WebSocket Server**
140-
::
134+
::navigate
135+
In Streamer.bot, navigate to **Servers / Clients > WebSocket Server**
136+
::
141137

142-
- Enable `Auto-Start` to automatically start the server when Streamer.bot starts up
143-
- Enable `Authentication` and set a `Password` to allow **sending** messages
144-
- Start the server if it is not already started
138+
- Enable `Auto-Start` to automatically start the server when Streamer.bot starts up
139+
- Enable `Authentication` and set a `Password` to allow **sending** messages
140+
- Start the server if it is not already started
145141

146142
#### Configure OBS Studio
147143

148-
::navigate
149-
In OBS Studio, navigate to **Docks > Custom Browser Docks** from the menu bar
150-
::
144+
::navigate
145+
In OBS Studio, navigate to **Docks > Custom Browser Docks** from the menu bar
146+
::
151147

152-
You can add any of the following URLs:
148+
You can add any of the following URLs:
153149

154-
| Name | URL |
155-
| ---- | --- |
156-
| Streamer.bot Chat | `https://chat.streamer.bot/feed/chat` |
157-
| Streamer.bot Event Feed | `https://chat.streamer.bot/feed/events` |
150+
| Name | URL |
151+
| ---- | --- |
152+
| Streamer.bot Chat | `https://chat.streamer.bot/feed/chat` |
153+
| Streamer.bot Event Feed | `https://chat.streamer.bot/feed/events` |
158154

159-
![OBS Browser Docks Dialog](assets/chat-obs-browser-docks.png)
155+
![OBS Browser Docks Dialog](assets/chat-obs-browser-docks.png)
160156

161157
#### Configure Connection Details
162158

163-
- Enter your Streamer.bot WebSocket Server details in the dialog:
159+
- Enter your Streamer.bot WebSocket Server details in the dialog:
164160

165-
![Streamer.bot Chat WebSocket Config](assets/chat-obs-connection.png)
161+
![Streamer.bot Chat WebSocket Config](assets/chat-obs-connection.png)
166162

167163
#### Done!
168164

169-
::success
170-
You've got **Streamer.bot Chat** fully functioning as a browser dock in OBS Studio!
171-
::
165+
::success
166+
You've got **Streamer.bot Chat** fully functioning as a browser dock in OBS Studio!
167+
::
168+
172169
::
173170

174171
### Settings
@@ -203,37 +200,40 @@ Docked chat is limited in some ways due to requiring the WebSocket Server to fun
203200

204201
![Chat Overlay Preview](./assets/chat-overlay.gif)
205202

203+
Chat overlay mode allows you to easily add chat as a browser source in OBS Studio or other streaming software.
204+
206205
### Setup
207206

208207
::steps{level=4}
209208
#### Enable WebSocket Server
210209

211-
::navigate
212-
In Streamer.bot, navigate to **Servers / Clients > WebSocket Server**
213-
::
210+
::navigate
211+
In Streamer.bot, navigate to **Servers / Clients > WebSocket Server**
212+
::
214213

215-
- Enable `Auto-Start` to automatically start the server when Streamer.bot starts up
216-
- Start the server if it is not already started
214+
- Enable `Auto-Start` to automatically start the server when Streamer.bot starts up
215+
- Start the server if it is not already started
217216

218217
#### Configure Chat Overlay
219218

220-
::navigate
221-
Navigate to **Settings > Overlay** in the Streamer.bot Chat window
222-
::
219+
::navigate
220+
Navigate to **Settings > Overlay** in the Streamer.bot Chat window
221+
::
223222

224-
- Modify any overlay settings, which will then be persisted in the URL
225-
- Make sure that the `WebSocket Server Configuration` matches your Streamer.bot WebSocket Server settings
223+
- Modify any overlay settings, which will then be persisted in the URL
224+
- Make sure that the `WebSocket Server Configuration` matches your Streamer.bot WebSocket Server settings
226225

227226
#### Add to OBS Studio
228227

229-
- Click `Save & Copy Overlay URL` to save your settings and copy the URL to your clipboard
230-
- Add a new browser source in OBS Studio and paste the copied URL
228+
- Click `Save & Copy Overlay URL` to save your settings and copy the URL to your clipboard
229+
- Add a new browser source in OBS Studio and paste the copied URL
231230

232231
#### Done!
233232

234-
::success
235-
You now have a Streamer.bot chat overlay source in OBS Studio!
236-
::
233+
::success
234+
You now have a Streamer.bot chat overlay source in OBS Studio!
235+
::
236+
237237
::
238238

239239
## Custom Styles
@@ -250,23 +250,23 @@ Some `data-attributes` have been added to the DOM for easier targeting of specif
250250
These attributes are available specifically on chat message rows.
251251

252252
::field-group
253-
::field{name="data-platform" type="string"}
254-
The platform name for a given chat message row.
255-
:br
256-
Values: `twitch`, `youtube`, `kick`, `trovo`
257-
::
258-
259-
::field{name="data-user-id" type="string"}
260-
The ID of the user who sent the chat message.
261-
::
262-
263-
::field{name="data-username" type="string"}
264-
The canonical login name of the user who sent the chat message.
265-
::
266-
267-
::field{name="data-display-name" type="string"}
268-
The display name of the user who sent the chat message.
269-
::
253+
::field{name="data-platform" type="string"}
254+
The platform name for a given chat message row.
255+
:br
256+
Values: `twitch`, `youtube`, `kick`, `trovo`
257+
::
258+
259+
::field{name="data-user-id" type="string"}
260+
The ID of the user who sent the chat message.
261+
::
262+
263+
::field{name="data-username" type="string"}
264+
The canonical login name of the user who sent the chat message.
265+
::
266+
267+
::field{name="data-display-name" type="string"}
268+
The display name of the user who sent the chat message.
269+
::
270270
::
271271

272272
### Events
@@ -275,24 +275,24 @@ These attributes are available specifically on chat message rows.
275275
You can use these event attributes to apply custom styles for any specific events, such as follows or subscriptions.
276276
::
277277

278-
::read-more{to=/api/websocket/events}
279-
For a full list of possible event source and types, refer to the **WebSocket Events** documentation.
280-
::
281-
282278
These attributes are available on **all** rows visible in chat, *including chat messages*.
283279

284280
::field-group
285-
::field{name="data-event-source" type="string"}
286-
The source of the event.
287-
:br
288-
Values: `Twitch`, `YouTube`, `Trovo`, etc...
289-
::
290-
291-
::field{name="data-event-type" type="string"}
292-
The type of event.
293-
:br
294-
Values: `ChatMessage`, `Follow`, `Subscription`, etc...
295-
::
281+
::field{name="data-event-source" type="string"}
282+
The source of the event.
283+
:br
284+
Values: `Twitch`, `YouTube`, `Trovo`, etc...
285+
::
286+
287+
::field{name="data-event-type" type="string"}
288+
The type of event.
289+
:br
290+
Values: `ChatMessage`, `Follow`, `Subscription`, etc...
291+
::
292+
::
293+
294+
::read-more{to=/api/websocket/events}
295+
For a full list of possible event source and types, refer to the **WebSocket Events** documentation.
296296
::
297297

298298
### Examples
@@ -301,6 +301,8 @@ These attributes are available on **all** rows visible in chat, *including chat
301301
If you are using the chat overlay in OBS Studio, you can add custom CSS directly in your browser source settings!
302302
::
303303

304+
Below are some example snippets showing how to target these attributes in your CSS:
305+
304306
```css [style.css]
305307
/* Hide all rows originating from Twitch */
306308
[data-platform="twitch"] {

0 commit comments

Comments
 (0)