Differences

This shows you the differences between two versions of the page.

--- coding_projects:obs_plugin_countdown_timer:v2.x [2025/08/04 16:51] – Added details for setting text colour in version v2.1.0 admin
+++ coding_projects:obs_plugin_countdown_timer:v2.x [2026/05/10 18:49] (current) – [Display Format] for version 2.2.0 of plugin admin
@@ Line 6: / Line 6: @@
 ===== Installation =====
-To install the plugin, run the installer for your operating system. The installers are available [[https://github.com/ashmanix/obs-plugin-countdown/releases|here]]. This will install the plugin into the correct folder. Installation instructions can be found [[resource:install_obs_plugin|here]].
+To install the plugin, install the plugin folder for your system. The files are available [[https://github.com/ashmanix/obs-plugin-countdown/releases|here]]. Installation instructions can be found [[resource:install_obs_plugin|here]].
 ===== Usage Guide =====
@@ Line 83: / Line 83: @@
 ==== Display Format ====
-Choose which time units to display (days, hours, minutes, seconds) on the Text Source by checking the appropriate boxes. For example, selecting minutes and seconds only will display the time as ''mm:ss''. Additionally, you can toggle the display of leading zeros by checking or unchecking the ''Leading Zero'' option. If you wish to show a message instead of the timer count, enable ''Format Output'' and define the output format, using ''%time%'' as a placeholder for the formatted time.
+Choose which time units to display (days, hours, minutes, seconds) on the Text Source by checking the appropriate boxes. For example, selecting minutes and seconds only will display the time as ''mm:ss''. Additionally, you can toggle the display of leading zeros by checking or unchecking the ''Leading Zero'' option.
+If you wish to show a custom message instead of only the timer count, enable ''Format Output'' and define the output format using template codes.
+Available template codes:
+  * ''%time%'' - The fully formatted timer string based on the selected display options
+  * ''%days%'' - Days value
+  * ''%hours%'' - Hours value
+  * ''%minutes%'' - Minutes value
+  * ''%seconds%'' - Seconds value
+  * ''%days2%'' - Days value padded to 2 digits
+  * ''%hours2%'' - Hours value padded to 2 digits
+  * ''%minutes2%'' - Minutes value padded to 2 digits
+  * ''%seconds2%'' - Seconds value padded to 2 digits
+Examples:
+  * ''Stream starts in %minutes% minutes''
+  * ''Starting in %hours2%:%minutes2%:%seconds2%''
+  * ''Episode releases in %days% days''
+The individual values represent the displayed parts of the timer rather than total accumulated values. For example, ''%hours%'' will show the remaining hours after days have been removed.
 ==== Timer Type ====

Ashmanix Wiki

User Tools

Site Tools

Differences

Page Tools