Pomodoro Timer for OBS (Lua Script)


Stay focused using the Pomodoro Technique directly in OBS!


This Lua script for OBS Studio adds a lightweight, customizable Pomodoro timer that updates a Text (GDI+) source with:

  • Live countdown
  • Session number
  • Start and break prompts

Features

  • Start/Stop and Pause/Resume controls
  • Custom input for:
    • Number of sessions
    • Work duration (in minutes)
    • Break duration (in minutes)
    • Custom “start” and “break” messages
  • Displays:
    • Current session
    • Timer countdown
    • Custom messages at session transitions
  • ⏱️ Break session only increases after the break ends
  • Start/Break messages show briefly (2 seconds)


How to Use

  1. Create a Text (GDI+) source
    • In OBS, go to Sources → + → Text (GDI+)
    • Name it something like PomodoroText
  2. Load the script in OBS
    • Go to Tools → Scripts
    • Click “+” and select pomodoro_obs.lua
  3. Configure the script:
    • Choose the Text source you created
    • Input:
      • Number of Sessions (e.g., 4)
      • Work Duration (minutes) (e.g., 25)
      • Break Duration (minutes) (e.g., 5)
      • Start Message (e.g., Focus up! )
      • Break Message (e.g., Break time! )
  4. Use the buttons to:
    • Start/Stop the Pomodoro
    • Pause/Resume anytime


Customization

Once running, the timer text can be styled fully using OBS’s GDI+ text options — fonts, colors, size, outlines, etc.
Author
Carocim
Downloads
37
Views
145
First release
Last update
Rating
0.00 star(s) 0 ratings
Top