Mods

🔍 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
Function
Description
main
Initializes the mod and loads the config. Starts automatically if configured.
start
Starts the countdown (optionally with a custom time).
stop
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
script
countdownMod
function
start


⏱️ Start with custom time (e.g. 90 seconds)
Key
Value
script
countdownMod
function
start
time
90


🛑 Stop countdown
Key
Value
script
countdownMod
function
stop

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

🔍 General Description
The WLED Control mod lets you remotely control WLED-powered LED strips using simple HTTP commands. It enables color changes (RGB & HEX), activates visual effects, and can temporarily override the current LED state before returning to the previous one.
Perfect for use in reaction systems, bot actions, alerts, or lighting-based feedback.


⚠️ Requirements
A WLED device running in your network
WLED must be accessible via HTTP (default: http://<your-ip>/win)
A local config file (wled-config.json) is required to define the WLED base URL
aiostool must be able to reach the WLED IP from the machine it's running on


🛠️ Configuration
Create a config file named wled-config.json and place it in the mod’s config folder. Example content:
{ "host": "http://192.168.2.160/win" }
This sets the default base URL for the WLED device.


⚙️ Functions
main
Loads the host URL from the config file.
setRed
Sets the color to red (R:255, G:0, B:0).
setBlue
Sets the color to blue (R:0, G:0, B:255).
setGreen
Sets the color to green (R:0, G:255, B:0).
setCustom
Applies a user-defined color and effect using direct RGB values and effect IDs. Accepts:
fx, sx, a, r, g, b, ix
setCustomHEX
Same as setCustom, but color is passed as a HEX value (#rrggbb).
setRGB
Sets a static RGB color (no effect/animation). Accepts: r, g, b.
setHEX
Same as setRGB, but using a HEX color string.
setCustomTemp
Temporarily activates an effect and color, then restores the previous WLED state after a given time. Accepts same values as setCustom + time (in ms).


💬 Example Commands
🔴 Switch to red
Key
Value
script
wledMod
function
setRed


🌈 Set custom RGB effect
Key
Value
script
wledMod
function
setCustom
fx
1
sx
200
a
255
r
255
g
100
b
50
ix
128


🎨 Use HEX color with effect
Key
Value
script
wledMod
function
setCustomHEX
fx
3
hex
#00ffff


⚠️ Temporary alert effect (5 seconds)
Key
Value
script
wledMod
function
setCustomTemp
fx
60
r
255
g
0
b
0
a
255
time
5000


💡 Set static color with HEX
Key
Value
script
wledMod
function
setHEX
hex
#ff66cc


🎯 Set static color with RGB
Key
Value
script
wledMod
function
setRGB
r
120
g
20
b
240


🧪 This mod supports real-time LED feedback and custom lighting animations – all configurable from your event system, overlay triggers, or chat commands.

🔍 General Description
The OBS Control mod allows seamless interaction with OBS Studio via the official WebSocket API. It lets you remotely control streaming, recording, scene switching, and audio sources – directly from within the aiostool environment.
This mod is ideal for automation workflows, bot triggers, or external control systems integrated into your stream setup.


⚠️ Requirements
OBS Studio with the obs-websocket plugin installed
(OBS v28+ includes it by default)
OBS WebSocket server must be running and accessible (e.g. ws://localhost:4455)
A config file named obs-config.json must be present in the mod directory
OBS must be running when commands are triggered


🛠️ Configuration
Create a file named obs-config.json in your mod’s config folder with the following structure:
{ "host": "ws://localhost:4455", "password": "YOUR_PASSWORD" }This tells the mod how to connect to your OBS WebSocket server.


⚙️ Functions
Function
Description
main
Initializes and tests the WebSocket connection to OBS.
switchScene
Switches to a specific OBS scene. Requires scene as parameter.
startRecording
Starts local recording in OBS.
stopRecording
Stops the current recording session.
startStream
Starts the live stream.
stopStream
Stops the ongoing stream.
muteSource
Mutes a specific audio input. Requires source as parameter.
unmuteSource
Unmutes a muted audio input. Requires source as parameter.
refreshBrowserSource
Refreshes a browser source. Requires source as parameter.


💬 Example Commands
🎬 Switch Scene
Key
Value
script
obsControl
function
switchScene
scene
Intro


🔇 Mute Source
Key
Value
script
obsControl
function
muteSource
source
Microphone


🌐 Refresh Browser Source
Key
Value
script
obsControl
function
refreshBrowserSource
source
OverlayBrowser