breadweb
[Documentation] Clarify help text for start time's timezone behavior
I'm looking at using this as the embedded widget on my stream page this year.
On https://breadweb.net/extralife-helper/general, there's no way to specify the timezone for the start time, and the description says "The local timezone of the computer or device running the Helper will be used." That's fine when using the widget within OBS for the stream, since the OBS computer will be in the timezone of the people streaming. However, it doesn't sound like it will work properly as a website embed. I'm starting my stream this Sunday at 9am MDT, and I'll have some viewers in the CDT timezone, so their computers will need to treat the time as 10am for the timer to be correct. If their web browsers load the widget and use their local timezone, then the timer will be an hour off.
I'd be happy to clone the repo and host it myself if I can accomplish this by modifying the code, but I'm not seeing a way to specify a timezone from a quick glance through the code.
Actually, I see that the start time is passed in the widget URL as a UNIX timestamp, which is absolute... I'll test to see if that means the time is actually absolute already. This may be a situation where the help text was just confusing.
Ok, it appears this works correctly (the timer displays properly regardless of time zone). The help text for the Start Time option could be clarified.
I did go to try and make a PR to clarify that help text, but I don't see the source code for the configuration panel at https://breadweb.net/extralife-helper/general in this repo/org.
The text is currently this:
This is the time your Extra Life event will begin. The local timezone of the computer or device running the Helper will be used.
I'd suggest clarifying the behavior by being a little more specific and making the second sentence less passive:
This is the time your Extra Life event will begin in your local timezone. Other computers or devices will convert this to their local timezones.
Hey there! Thanks for the message. Timezones are handled differently based on what version of the Helper that is being used and for the remote versions made with the link generator, I believe it also matters what the timezone is of the computer being used to generate the link. I have a task to update other parts of the documentation and can review this at that time.
