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
docs: update all documentation for overlay-only Quick Setup
Files updated:
- docs/getting-started.md: Complete rewrite — reflects overlay-only
Quick Setup (ring + bar + infrastructure), removes references to
auto-created text sources, adds bar overlay step, updated diagrams
- docs/architecture.md: Section 21 description updated
- docs/automation-guide.md: Status/AFK section — no longer references
SP Status as auto-created, documents overlay-native status display
- docs/faq.md: AFK status answer updated — SP Status is manual-only,
status appears automatically in overlays and dock
All docs now accurately reflect the current codebase where:
- Quick Setup creates 8 items (2 overlays + 6 infrastructure)
- Text sources are optional, manually created, documented in
overlay-customization.md#manual-text-sources-advanced
Copy file name to clipboardExpand all lines: docs/architecture.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ The script is divided into exactly 23 sections, labeled with standard `---` comm
70
70
18.**Hotkey Callbacks**: Thin integration layer to the Controls.
71
71
19.**Frontend Events**: Hooks for stream/recording toggles.
72
72
20.**Source/Scene Enumeration**: OBS SDK dropdown population logic.
73
-
21.**Quick Setup Wizard**: Automated source-and-overlay generator that places the text sources, `SP Status`, overlay, background image/video/music sources, and alert source into the active scene.
73
+
21.**Quick Setup Wizard**: Automated overlay-and-source generator that creates the ring overlay (`SP Overlay`), bar overlay (`SP Overlay Bar`), background image/video sources (with auto-fit-to-canvas), background music, and alert sound in the active scene. Text sources (SP Timer, SP Session, etc.) are no longer auto-created — they remain functional when manually assigned via the script settings.
74
74
22.**OBS Script Interface**: Standard OBS `script_properties` and `script_update`.
Copy file name to clipboardExpand all lines: docs/automation-guide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Automation Guide
1
+
# Automation Guide
2
2
3
3
SessionPulse can automate nearly every aspect of your OBS setup based on your session state. This guide covers each automation feature with step-by-step setup.
4
4
@@ -273,18 +273,18 @@ Show a manual `BRB`, `AFK`, or custom note on stream without stopping the timer.
273
273
274
274
### Setup
275
275
276
-
1. Use Quick Setup so it creates `SP Status` and places it in your active scene
277
-
2. In the script panel:
276
+
1. In the script panel:
278
277
- Type your message into **Status Message**
279
278
- Set **Duration (minutes)** to `0` to keep it visible until cleared, or a positive number to auto-clear it
280
279
- Click **Show Status**
281
-
3. Click **Clear Status** when you want to remove it
280
+
2. Click **Clear Status** when you want to remove it
282
281
283
282
### Behavior
284
283
285
-
- The message is written into the `SP Status` text source
284
+
- The status message appears automatically in the **ring overlay**, **bar overlay**, and **control dock**
285
+
- If you've manually created an `SP Status` text source (see [Manual Text Sources](overlay-customization.md#manual-text-sources-advanced)), it will also update there
286
286
- The timer keeps running normally underneath it
287
-
- Active status state is exposed in `session_state.json`, so the dock can surface it too
287
+
- Active status state is exposed in `session_state.json`, so external tools can surface it too
Copy file name to clipboardExpand all lines: docs/faq.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,10 +125,11 @@ Quick Setup creates `SP Alert Sound` automatically, so in most cases you only ne
125
125
126
126
### How do I show an AFK / BRB / custom status message?
127
127
128
-
-Use the built-in `SP Status` text source created by Quick Setup.
128
+
-You can create an `SP Status` text source manually (see [Manual Text Sources](overlay-customization.md#manual-text-sources-advanced)), or use the overlay's built-in status display.
129
129
- In the script panel, type your message in **Status Message** and click **Show Status**.
130
130
- Set **Duration (minutes)** to `0` to keep it visible until cleared, or a positive number to auto-clear it.
131
131
- Click **Clear Status** when you return.
132
+
- The status message also appears in the dock, ring overlay, and bar overlay automatically.
- ✅ Creates a looping music source (`SP Background Music`)
58
+
- ✅ Creates an alert sound source (`SP Alert Sound`)
59
+
- ✅ Adds all sources to your currently active scene
60
+
- ✅ Auto-fits background sources to your canvas (any resolution)
61
61
62
62
Check the Script Log to confirm:
63
63
```
64
-
[SessionPulse] Quick Setup: ✓ Complete! Created 11 items. Press Start to begin!
64
+
[SessionPulse] Quick Setup: ✓ Complete! Created 8 items. Press Start to begin!
65
65
```
66
66
67
-
> **Skip to [Step 4: Set Up Hotkeys](#step-4-set-up-hotkeys)** — sources, scenes, and overlay are ready.
67
+
> **Skip to [Step 4: Set Up Hotkeys](#step-4-set-up-hotkeys)** — overlays and sources are ready.
68
68
69
69
If OBS closes during a session, reopen OBS and use **Resume Previous Session** in the script panel to continue from the exact saved timer value and progress position.
70
70
71
-
---
72
-
73
-
<details>
74
-
<summary><strong>Alternative: Manual Setup</strong> (if you prefer to create sources yourself)</summary>
75
-
76
-
### Create Text Sources
77
-
78
-
Create these in your scene before configuring the script:
79
-
80
-
| Source Name | Purpose | Required? |
81
-
|------------|---------|-----------|
82
-
|`Timer`| Shows countdown `24:59`| ✅ Yes |
83
-
|`Session`| Shows `Focus Time`, `Short Break`, etc. | Recommended |
84
-
|`Focus Count`| Shows `Done: 3/6`| Optional |
85
-
|`Progress`| Shows `████░░░░` bar | Optional |
86
-
87
-
1. In your **Scene**, click **+** (under Sources)
88
-
2. Select **Text (GDI+)** (Windows) or **Text (FreeType 2)** (Mac/Linux)
89
-
3. Name it and click **OK**
90
-
4. Repeat for each source
91
-
92
-
### Connect Sources to the Script
93
-
94
-
1. Go to **Tools** → **Scripts** → select **SessionPulse**
95
-
2. In the script settings panel, use the dropdown menus:
96
-
-**Timer Text Source** → select your timer source
97
-
-**Session Message Source** → select your session source
98
-
-**Focus Count Source** → select your count source
99
-
-**Progress Bar Source** → select your progress source
100
-
101
-
</details>
71
+
> 💡 **Need individual text sources?** Quick Setup creates overlays only (they display everything: timer, session type, progress, goals, next-up info). If you prefer separate text elements for custom positioning, see [Manual Text Sources](overlay-customization.md#manual-text-sources-advanced).
102
72
103
73
---
104
74
@@ -123,6 +93,7 @@ Optional but useful:
123
93
| Add Time |`Ctrl+F9`| Add 5 minutes to current session |
124
94
| Subtract Time |`Ctrl+F10`| Remove 5 minutes from current session |
125
95
| Reset All |`Ctrl+F11`| Clear all progress and start fresh |
96
+
| Resume Previous |`Ctrl+F12`| Restore a session interrupted by crash/close |
126
97
127
98
4. Click **Apply** → **OK**
128
99
@@ -131,8 +102,8 @@ Optional but useful:
131
102
## Step 5: Start Your First Session
132
103
133
104
1. Press your **Start/Pause** hotkey (e.g., `F9`)
134
-
2. Watch: your `Timer` source should start counting down from `25:00`
135
-
3.Your `Session` source should show `Focus Time`
105
+
2. Watch: the **ring overlay** starts counting down from `25:00`
106
+
3.The **bar overlay** at the top shows session type, timer, progress, and goal count
136
107
4. When it hits `0:00`, it will automatically switch to a **Short Break** (5 minutes)
137
108
5. After the break, it auto-starts the next Focus session
138
109
@@ -145,21 +116,22 @@ Focus (25 min) → Short Break (5 min) → Focus → Short Break → Focus → S
145
116
146
117
---
147
118
148
-
## Step 6: Add the Overlay (Optional)
119
+
## Step 6: Customize Your Overlays
149
120
150
-
The ring overlay adds a beautiful visual timer to your stream:
121
+
Both overlays are highly customizable via the **Custom CSS** field in OBS Browser Source properties.
151
122
152
-
1. In your scene, click **+** (add source) → **Browser**
153
-
2. Name it `Timer Overlay`
154
-
3. Check **✅ Local file**
155
-
4. Click **Browse** → navigate to your SessionPulse folder → select **`timer_overlay.html`**
156
-
5. Set **Width: 220**, **Height: 220**
157
-
6. Click **OK**
158
-
7. Position the overlay where you want it on your stream
123
+
### Ring Overlay
124
+
- Created by Quick Setup as `SP Overlay` (400×400)
125
+
- Scale it down in OBS to your preferred size (e.g., 150px for gaming, 280px for study streams)
126
+
- Themes: Neon, Minimal, Glassmorphism, or default
159
127
160
-
You should see a circular ring with the countdown timer. It will be green during Focus, blue during Short Break, and purple during Long Break.
128
+
### Bar Overlay
129
+
- Created by Quick Setup as `SP Overlay Bar` (1920×48)
130
+
- Sits at the top edge of your canvas
131
+
- Shows: session icon, label, timer, progress bar, goal count, next-up info
132
+
- Auto-hides when the timer is idle
161
133
162
-
> For customization (themes, colors, sizes), see the [Overlay Customization Guide](overlay-customization.md).
134
+
> For full theme presets, CSS variables, and color customization, see the [Overlay Customization Guide](overlay-customization.md).
163
135
164
136
---
165
137
@@ -179,7 +151,7 @@ The dock gives you clickable buttons inside OBS instead of using hotkeys:
179
151
180
152
3. Click **Apply**
181
153
182
-
A new dock panel appears with Start/Pause, Skip, Stop buttons, a timer display, session stats, and the live `SP Status` / AFK message when one is active.
154
+
A new dock panel appears with Start/Pause, Skip, Stop buttons, a timer display, session stats, and the live status message when one is active.
183
155
184
156
**For control buttons to work**, you need WebSocket enabled:
185
157
1. Go to **Tools** → **WebSocket Server Settings**
@@ -197,18 +169,18 @@ Your setup should now look like this:
197
169
flowchart TB
198
170
subgraph OBS["OBS Studio"]
199
171
Script["session_pulse.lua\n(engine)"]
200
-
Timer["Timer: 24:59"]
201
-
Session["Session: Focus Time"]
202
-
Overlay["Ring Overlay\n(Browser Source)"]
172
+
Ring["SP Overlay\n(Ring — 400×400)"]
173
+
Bar["SP Overlay Bar\n(Bar — 1920×48)"]
174
+
BG["SP Background\nImage / Video"]
203
175
Dock["Control Dock\n(Custom Browser Dock)"]
204
176
end
205
177
206
-
Script -->|updates| Timer
207
-
Script -->|updates| Session
208
178
Script -->|writes| State["session_state.json"]
209
-
State -->|reads| Overlay
179
+
State -->|reads| Ring
180
+
State -->|reads| Bar
210
181
State -->|reads| Dock
211
182
Dock -->|WebSocket| Script
183
+
Script -->|updates| BG
212
184
```
213
185
214
186
---
@@ -218,7 +190,8 @@ flowchart TB
218
190
| Want to... | Read... |
219
191
|-----------|---------|
220
192
| Customize overlay colors and themes |[Overlay Customization](overlay-customization.md)|
221
-
| Auto-switch scenes, duck music, control mic |[Automation Guide](automation-guide.md)|
193
+
| Auto-duck music, control mic, toggle filters|[Automation Guide](automation-guide.md)|
222
194
| Set up Nightbot or Stream Deck |[Integrations](integrations.md)|
223
195
| Control from your phone |[Mobile Remote](mobile-remote.md)|
196
+
| Use individual text sources instead of overlays |[Manual Text Sources](overlay-customization.md#manual-text-sources-advanced)|
224
197
| Something isn't working |[FAQ & Troubleshooting](faq.md)|
0 commit comments