🔓 Open Source

⏳ Countdown Timer for OBS with Sound Alert

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.

📥 How to Download the Repo for First-Time Users

• Click the link to read Instructions.

For Beginners at coding

• 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

🔄 Pull Request

• 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 and drop sounds into the OpenSource-Sounds-For-Coundown-Timer folder for others to use.
• Supported formats: .mp3 or .wav.
• Check CONTRIBUTING.md.

✨ Features

• Countdown timer display.
• Plays a sound alert at 30 seconds remaining.
• Supports .mp3 and .wav formats.

🎉 You Can Use It for Other Purposes Like:

• Timeout timer.
• Cooking timer.
• And more!
• To use it as a timer only, follow the same steps but leave out the OBS steps.

Requirements

If you dont have a pet python here is a couple below:

• YOU ONLY NEED ONLY VERSION OF PYTHON TO RUN THIS !!
• Python 3.11.6
• Python 3.11.9
• Python 3.12.1
• pygame library

Installation

1. Clone this repository:

• make sure to make a folder on Desktop then CD it in CMD.exe then do the Git Clone.

git clone https://github.com/kernferm/countdown-timer-obs.git
cd countdown-timer-obs

2. Create and activate a virtual environment (optional but recommended):

python -m venv .venv

On Windows ( copy and paste below in cmd.exe )

.venv\Scripts\activate

On macOS/Linux ( copy and paste below in terminal )

source .venv/bin/activate

3. Install the required packages:

pip install -r requirements.txt

• use this create_and_activate_venv_install_dependencies.bat
• or
• use this install_requirements.bat

Usage

1. Place your MP3 file or WAV file (example.mp3) in the same directory as the script.
2. Run the script:

python main.py

Customization

• Modify the duration parameter in the countdown_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' or example.wav with the name of your sound file.

Info

• 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 letters ebu
• URL now should say yout.com/whatever url you have at the end of yout.com

Add to OBS

Run the Countdown Timer Script:

Ensure your countdown timer script is running.

• Add Window Capture Source in OBS:

Open 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.

Add Audio Output Capture Source in OBS:

• 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.