🔍 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 existThe 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 writtentime: Countdown duration in seconds (default if not overridden by an action)autostart: Iftrue, the countdown starts automatically on script load
⚙️ Functions
Function | Description |
|---|---|
| Initializes the mod and loads the config. Starts automatically if configured. |
| Starts the countdown (optionally with a custom time). |
| Stops the countdown and writes the last remaining time to file. |
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
Key | Value |
|---|---|
function | start |
⏱️ Start with custom time (e.g. 90 seconds)
Key | Value |
|---|---|
function | start |
time | 90 |
🛑 Stop countdown
Key | Value |
|---|---|
function | stop |
🧪 This mod is perfect for creating real-time timers visible in OBS.
What's New in Version 1.0.0
Released
No changelog available for this version.