OBS Lua Comprehensive Stopwatch & Countdown Timer 5.3

TIMER PLUGIN​

Feature Overview​

• Supports Duplication: The plugin can be duplicated and used to run multiple instances simultaneously.
• Customizable Timer Format & Display: The timer format and display are completely customizable, allowing for various configurations.
• Count Up: The plugin can count time upwards.
• Count Down: The plugin can count time downwards.
• Real-Time Count Inversion: The plugin can change the counter direction in real-time.
• Countdown Components: The plugin supports counting down in days, hours, minutes, seconds, and milliseconds.
• Specific Date & Time Countdown: The plugin supports counting down to a specific date and time.
• Toggle Visibility of Split Seconds: Triggered by Hotkey or timestamp to show/hide the split seconds.
• Events when Timer Expires: Provides powerful functionality.
• Create a Stopwatch: Features to mark laps and intervals.
• Start Timer from Specific Timestamp: The plugin can be started from a specific timestamp.
• Autoload Last Saved Timestamp: The plugin can autoload the last saved timestamp on startup.
• Cycle Through Source List: The plugin can cycle through a defined source list based on a timer.
• Cycle Through Nested Sources: The plugin can cycle through sources that are placed in a defined group or nested scene based on a timer.
• Cycle Through Scene List: The plugin can cycle through a defined scene list based on a timer.
• Switch to Specific Scene when Timer Expires: The plugin can switch to a specific scene when the timer expires.
• Play a Media Source at Specified Time: The plugin can play up to two media sources at a specified time.
• Play a Media Source when Timer Expires: The plugin can play a media source when the timer expires.
• Change Timer Text Color: The plugin can change the timer text color at a specified time and allows defining two color changes.
• Enable Visibility on Another Text Source: The plugin can enable visibility on another text source at a specified time.
• Start Recording at Specified Time: The plugin can start recording at a specified time.
• Custom Message on Timer Expiry: The plugin can display a custom message when the timer expires.
• Custom Timer Prefix/Suffix: The plugin allows defining a custom prefix or suffix for the timer.
• Start Timer on Text Source Visibility: The plugin can start the timer when the Timer Text Source becomes visible.
• Start Timer on Scene Activation: The plugin can start the timer when the scene with the Timer Text Source becomes active.
• Export Script Settings: The plugin allows exporting script settings for backup or quick setup.
• Import Script Settings: The plugin allows importing previously saved script settings.
• Add/Subtract Seconds: The plugin can add or subtract seconds to/from the timer.
• Assign Minute Format: The plugin allows assigning a minute format to create a 90-minute timer or any length Minute timer.
• Debug Logging: Create a local file for debugging issues.
• Dedicated Buttons: Ability to split the 'Start' and 'Pause' button
• Hotkey Support: The plugin supports hotkeys for starting, pausing, resetting, split-time, toggling milliseconds, changing time direction, and adding/subtracting time.
• Disable Unwanted Features: Ability to completely remove unwanted features.

Spoiler: About this Script

PLUGIN DESIGN OVERVIEW:​

To ensure an optimal user experience, it's important to understand the distinction between two types of objectives some of the properties serve in the plugin UI: those that enhance the user experience and those that directly impact the core functionality and behaviour. Let's delve into these categories to help you navigate the plugin effortlessly.​

PROPERTIES FOR ENHANCING USER EXPERIENCE:​

These properties focus on providing additional customization options and improving the overall usability of the plugin. While they don't directly affect the core functionality, they play a vital role in tailoring the plugin with a specific purpose.

Here's what you need to know:

The OBS Native UI interface can sometimes become cluttered when using plugins with complex configurability. To address this issue, this plugin has been designed to display or hide certain properties based on their relevance. It's important to understand that some properties, while relevant, are intentionally hidden to prevent an overwhelming amount of information. Therefore, it is crucial to carefully examine each property to determine if it reveals any extendable settings.​

Here are some Properties that will simplify or expand available properties:
1. Timer Settings
2. Marker Settings

PROPERTIES AFFECTING CORE FUNCTIONALITY AND BEHAVIOR:​

These properties directly impact how the plugin operates and can significantly influence its core functionality. Understanding and adjusting these settings will ensure the plugin behaves precisely as you intend.

Here's what you should consider:

The Plugin provide Timer focused functionality that can be configured for various scenarios.
The Plugin provides two modes, each with some unique features and some that overlap between the two modes.​

The Plugin modes are:

• Count Up
• Count Down

The plugin initializes with the Count Up mode as the default mode and with a Basic layout which expands to an Advanced layout.

The Basic layout hide additional properties that will only become available in the Advanced layout.

Switching between the Basic and Advanced layout has no impact on the features or any defined settings of the plugin, it only shows or hide properties in the Plugin Settings UI. This serves the purpose of removing clutter when only a simple layout is required. This solution was deployed because many of the features are not used by the average user and having it all displayed in a small area can be overwhelming. The downside is that it may create a sense that the settings are obscured or unintuitive.
​