This Python script creates a countdown timer overlay for OBS (Open Broadcaster Software) and can be used for various purposes like a cooking timer or timeout timer. It plays a sound of your choice when the timer reaches a specific point.
- Click the link to read Instructions.
- look at the
main.py
- you will see my notes i made
- adding the sounds to the code is
NOT
hard to do - just follow my instructions
- if you have trouble join my discord dev server Bubbles Dev Server
- Make a
pull request
for OpenSource-Sounds-For-Coundown-Timer. - Create a GitHub account (it's free!).
Fork
the repo (copy the main branch).Drag
anddrop
sounds into the OpenSource-Sounds-For-Coundown-Timer folder for others to use.- Supported formats:
.mp3
or.wav
. - Check CONTRIBUTING.md.
- Countdown timer display.
- Plays a sound alert at 30 seconds remaining.
- Supports
.mp3
and.wav
formats.
- Timeout timer.
- Cooking timer.
- And more!
- To use it as a timer only, follow the
same steps
but leave out theOBS steps
.
- YOU ONLY NEED ONLY VERSION OF PYTHON TO RUN THIS !!
- Python 3.11.6
- Python 3.11.9
- Python 3.12.1
pygame
library
- Clone this repository:
- make sure to make a folder on
Desktop
thenCD
it inCMD.exe
then do theGit Clone
.
git clone https://github.com/kernferm/countdown-timer-obs.git
cd countdown-timer-obs
- Create and activate a virtual environment (optional but recommended):
python -m venv .venv
.venv\Scripts\activate
source .venv/bin/activate
- Install the required packages:
pip install -r requirements.txt
- use this
create_and_activate_venv_install_dependencies.bat
- or
- use this
install_requirements.bat
- Place your MP3 file or WAV file (
example.mp3
) in the same directory as the script. - Run the script:
python main.py
- Modify the
duration
parameter in thecountdown_timer
function to change the length of the countdown. - Change the
sound.set_volume(0.26)
line to adjust the volume of the alert sound. - Replace
'example.mp3'
orexample.wav
with the name of your sound file.
- To get sounds if you
do not
have any on your computer. - youtube.com then find your sound you want to use as entrance theme.
- go to
URL
remove the lettersebu
URL
now should say yout.com/whatever url you have at the end of yout.com
Run the Countdown Timer Script:
Ensure your countdown timer script is running.
- Add Window Capture Source in OBS:
- In the
Sources
panel, click on the + button at the bottom. - Select
Window Capture
. - Name the new source (e.g., "Countdown Timer") and click
OK
. - In the properties window, select the countdown timer window from the
Window
dropdown menu. - Adjust the size and position of the window capture to fit your stream layout.
- Click
OK
to add the source.
- In the
Sources
panel, click on the + button at the bottom. - Select
Audio Output Capture
. - Name the new source (e.g., "System Audio") and click
OK
. - In the properties window, select the appropriate audio device (usually the default audio device or speakers).
- Click
OK
to add the source.