Countdown Timer

Countdown Timer

🔍 General Description

The Countdown Timer mod creates a file-based countdown system that continuously updates a text file with the remaining time in a human-readable format.
It’s ideal for stream overlays, break timers, giveaways, or event announcements. It supports autostart, manual control, and custom durations per action.

⚠️ Requirements

• aiostool must have write access to the file path defined in the config

• A valid configuration file (countdown.json) must exist

• The output file (e.g., countdown.txt) can be used in OBS via a text source

🛠️ Configuration

Create a file named countdown.json in your mod’s config directory. Example:

{
	"path": "countdown.txt",
	"time": 180,
	"autostart": false
}

• path: Absolute path to the output file where the formatted countdown will be written

• time: Countdown duration in seconds (default if not overridden by an action)

• autostart: If true, the countdown starts automatically on script load

⚙️ Functions

The countdown will update the file every second in a dynamic format:

• ss (e.g., 9)

• mm:ss (e.g., 03:25)

• hh:mm:ss (e.g., 01:07:42)

💬 Example Commands

▶️ Start with default config time

⏱️ Start with custom time (e.g. 90 seconds)

🛑 Stop countdown

🧪 This mod is perfect for creating real-time timers visible in OBS.

View File