Created
January 29, 2025 08:59
-
-
Save gmrdad82/342df0cec3f14611cb34b4fd86c9e590 to your computer and use it in GitHub Desktop.
Sets a text source to act as a countdown timer to a specific date when the source is active.\n\nMade by Gamer Dad - YouTube.com/@gmrdad82
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
obs = obslua | |
source_name = "" | |
target_date = nil | |
prefix_text = "" | |
last_text = "" | |
activated = false | |
hotkey_id = obs.OBS_INVALID_HOTKEY_ID | |
-- Function to set the time text | |
function set_time_text() | |
local current_time = os.time() | |
local remaining_time = os.difftime(target_date, current_time) | |
if remaining_time < 0 then | |
remaining_time = 0 | |
end | |
local seconds = math.floor(remaining_time % 60) | |
local total_minutes = math.floor(remaining_time / 60) | |
local minutes = math.floor(total_minutes % 60) | |
local hours = math.floor(total_minutes / 60) | |
local text = string.format("%s %02d:%02d:%02d", prefix_text, hours, minutes, seconds) | |
if text ~= last_text then | |
local source = obs.obs_get_source_by_name(source_name) | |
if source ~= nil then | |
local settings = obs.obs_data_create() | |
obs.obs_data_set_string(settings, "text", text) | |
obs.obs_source_update(source, settings) | |
obs.obs_data_release(settings) | |
obs.obs_source_release(source) | |
end | |
end | |
last_text = text | |
end | |
function timer_callback() | |
set_time_text() | |
end | |
function activate(activating) | |
if activated == activating then | |
return | |
end | |
activated = activating | |
if activating then | |
set_time_text() | |
obs.timer_add(timer_callback, 1000) -- Update every second | |
else | |
obs.timer_remove(timer_callback) | |
end | |
end | |
-- Called when a source is activated/deactivated | |
function activate_signal(cd, activating) | |
local source = obs.calldata_source(cd, "source") | |
if source ~= nil then | |
local name = obs.obs_source_get_name(source) | |
if (name == source_name) then | |
activate(activating) | |
end | |
end | |
end | |
function source_activated(cd) | |
activate_signal(cd, true) | |
end | |
function source_deactivated(cd) | |
activate_signal(cd, false) | |
end | |
function reset(pressed) | |
if not pressed then | |
return | |
end | |
activate(false) | |
local source = obs.obs_get_source_by_name(source_name) | |
if source ~= nil then | |
local active = obs.obs_source_active(source) | |
obs.obs_source_release(source) | |
activate(active) | |
end | |
end | |
function reset_button_clicked(props, p) | |
reset(true) | |
return false | |
end | |
---------------------------------------------------------- | |
-- A function named script_properties defines the properties that the user | |
-- can change for the entire script module itself | |
function script_properties() | |
local props = obs.obs_properties_create() | |
obs.obs_properties_add_text(props, "target_date", "Target Date (YYYY-MM-DD)", obs.OBS_TEXT_DEFAULT) | |
local p = obs.obs_properties_add_list(props, "source", "Text Source", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING) | |
local sources = obs.obs_enum_sources() | |
if sources ~= nil then | |
for _, source in ipairs(sources) do | |
source_id = obs.obs_source_get_unversioned_id(source) | |
if source_id == "text_gdiplus" or source_id == "text_ft2_source" then | |
local name = obs.obs_source_get_name(source) | |
obs.obs_property_list_add_string(p, name, name) | |
end | |
end | |
end | |
obs.source_list_release(sources) | |
obs.obs_properties_add_text(props, "prefix_text", "Prefix Text", obs.OBS_TEXT_DEFAULT) | |
obs.obs_properties_add_button(props, "reset_button", "Reset Timer", reset_button_clicked) | |
return props | |
end | |
-- A function named script_description returns the description shown to | |
-- the user | |
function script_description() | |
return "Sets a text source to act as a countdown timer to a specific date when the source is active.\n\nMade by Gamer Dad - YouTube.com/@GmrDad82" | |
end | |
-- A function named script_update will be called when settings are changed | |
function script_update(settings) | |
activate(false) | |
local date_str = obs.obs_data_get_string(settings, "target_date") | |
local year, month, day = date_str:match("(%d+)-(%d+)-(%d+)") | |
target_date = os.time({year = year, month = month, day = day, hour = 0, min = 0, sec = 0}) | |
source_name = obs.obs_data_get_string(settings, "source") | |
prefix_text = obs.obs_data_get_string(settings, "prefix_text") | |
reset(true) | |
end | |
-- A function named script_defaults will be called to set the default settings | |
function script_defaults(settings) | |
obs.obs_data_set_default_string(settings, "target_date", os.date("%Y-%m-%d")) | |
obs.obs_data_set_default_string(settings, "prefix_text", "Not much left until ") | |
end | |
-- A function named script_save will be called when the script is saved | |
-- | |
-- NOTE: This function is usually used for saving extra data (such as in this | |
-- case, a hotkey's save data). Settings set via the properties are saved | |
-- automatically. | |
function script_save(settings) | |
local hotkey_save_array = obs.obs_hotkey_save(hotkey_id) | |
obs.obs_data_set_array(settings, "reset_hotkey", hotkey_save_array) | |
obs.obs_data_array_release(hotkey_save_array) | |
end | |
-- a function named script_load will be called on startup | |
function script_load(settings) | |
-- Connect hotkey and activation/deactivation signal callbacks | |
-- | |
-- NOTE: These particular script callbacks do not necessarily have to | |
-- be disconnected, as callbacks will automatically destroy themselves | |
-- if the script is unloaded. So there's no real need to manually | |
-- disconnect callbacks that are intended to last until the script is | |
-- unloaded. | |
local sh = obs.obs_get_signal_handler() | |
obs.signal_handler_connect(sh, "source_activate", source_activated) | |
obs.signal_handler_connect(sh, "source_deactivate", source_deactivated) | |
hotkey_id = obs.obs_hotkey_register_frontend("reset_timer_thingy", "Reset Timer", reset) | |
local hotkey_save_array = obs.obs_data_get_array(settings, "reset_hotkey") | |
obs.obs_hotkey_load(hotkey_id, hotkey_save_array) | |
obs.obs_data_array_release(hotkey_save_array) | |
end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment