Releases: zshall/program-guide
v2 Public Beta 9-25-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 9-25-2024
🔧 Hotfix to address bug surfaced in newest Chromium version (129) related to overflow.
TV screen is now overflow: hidden.
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 9-21-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 9-21-2024
- Added custom key remapping. You can now reassign keys to any button or combination of buttons supported by the browser.
- Updated Help page to read list of key commands based off of input mapping.
Here's an example of how this works:
inputMapping: # Optional. You can override the default keyboard commands here.
volumeUp: q # For any key you override, the default key will be unassigned.
volumeDown: a # The combos supported should be in lower-case; the keys supported can be found at https://github.com/madrobby/keymaster?tab=readme-ov-file#supported-keys
power: shift+p, enter # Using + will require multiple keys to be pressed at the same time. Using , will assign multiple combos to the same function.
# Important: the browser may have some reserved key combos that can't be overridden. If you're having trouble with a key combo, try another one.The commands available to override are:
0123456789channelDownchannelUphelpinfomutepowerresetPicturescaleDownXscaleDownYscaleUpXscaleUpYsetuptoggleAutoScaletoggleBezelstoggleBezelTypetoggleBlurtoggleChangeChannelNoisetoggleClosedCaptionstoggleNoisetoggleOSDtoggleRemotePairingCodetoggleScanlinestoggleShadowMasktoggleShadowMaskTypeversionvolumeDownvolumeUp
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 9-15-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 9-15-2024
- PLS playlist file support added in
backgroundAudioengine for tracks accessible via the web. An example playlist is provided in the placeholders directory. - PLS files will provide info about what's now playing to the audio info engine.
- If you're using IIS on Windows to host the files, a new MIME type was added to the
web.configfile included for this purpose.
Here's the playlist example:
- number: 53
name: Playlist Example
abbr: PLS
image: placeholders/channel-53.png
backgroundAudio: placeholders/playlist-example.pls # You can use a playlist file to play audio. This can be a local file or a remote one but the contents need to be accessible via the web. Currently only PLS files are supported.
backgroundAudioOptions:
shufflePlaylist: true # Optional. If you want to shuffle the playlist set this to true. Only has an effect if a playlist file is used.Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 9-09-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 9-9-2024
- Added custom color support for the Guide engine.
guidecan have the following new options:
guide: # Program guides read the current channel lineup to reconstruct listings based off channel numbers, title and description. https://greenhillplaza.notion.site/Program-Guides-46e80919a3754efa9769f74dd00946fe?pvs=4
primaryColor: white # The primary color of the guide; this is used for the default background color of guide cells
secondaryColor: blue # The secondary color of the guide; this is used for the text color of headers and channel numbers
textColor: black # The text color of the guide; this is used for the text color of guide cells- Refactored the color scheme library to be accessible for more purposes.
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 9-07-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 9-07-2024
- Power-off and power-on effects have been added; to disable, use
warmup: falsein the config file. - To change the length of the warmup effect, set
warmupto a number in seconds. - Fixed more teardown code.
It looks like my bug report for Vidstack is being worked on, the workaround code will be able to be removed when that's done which should improve stability.
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 8-31-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 8-29-2024
Breaking changes
- Vidstack is now the default video provider. To use the deprecated Vime video provider use
video@1instead ofvideo.
Bug fixes
- To that end, the Vidstack provider has been cleaned up and a bug involving loading incorrect URLs with YouTube and Vimeo was fixed.
Please report any bugs you encounter using Vidstack since Vime will be removed at some point.
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 8-29-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 8-29-2024
New Features
- Background Audio Interrupts are now available.
- video:
src: https://www.youtube.com/watch?v=OlfL5TWWBtg
interruptsBackgroundAudio: true # While any piece of content designated as interrupting background audio is on-screen, the background audio will be paused.Opt-In
- Experimental new video engine is available using Vidstack instead of Vime. To use it change
videocomponents tovideo@2, like so:
- video@2:
provider: youtube
src: OlfL5TWWBtg- Vidstack will replace Vime as the default engine in the future, but I haven't tested it enough yet.
- Sunsetting Vime will occur in 3 stages:
- Opt-in (currently as of 8-29-2024)
- Opt-out (switch back to
video,video@1andvideo@2will be deprecated) video@1andvideo@2aliases will be removed, Vime will be removed and Vidstack will powervideoengine.
- Dailymotion support is unavailable in Vidstack.
Bug fixes and enhancements:
- Fixed some autoScale problems from yesterday regarding state changes when
autoScaleis set to false in the config file and hasn't been manually set yet. - Added autoScale and a description of it to the
/setuppage. - Added more agressive teardown code to combat a bug that continues to evade me regarding nested content: sveltejs/svelte#5268
- Press
Vto see version information. - Custom mouse cursor
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 8-24-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 8-28-2024
A few quality of life improvements today:
- Added full-screen toggle button to the touch menu. Long-press or click and hold on the TV to toggle this menu!
- Added status messages on all picture adjustments; when pressing a picture adjustment shortcut you'll get a status update on what you changed.
- AutoScale has a manual override toggle: Alt + 7
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 8-24-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 8-24-2024
Today's update is all about improved stability 🔧
- Config examples have been updated to allow running in a subdirectory. It's finally possible!
- If you have an existing config file and want to convert it to run in a subdirectory, remove the leading slash from local content.
/placeholders/...should just beplaceholders/...for instance. - Example files have a new parameter called
baseDirectorywhich is only really useful for loading them from the/examplespage. You likely won't need this parameter in your mainconfig.tvs.ymlfile. - YouTube videos were not respecting volume controls and now mute themselves now if the volume is set to 0.
autoScalewasn't working properly as when set to false it would still resize due to how config files were loaded. Those problems are fixed now.- About page now shows the TVS logo.
Read this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg
v2 Public Beta 8-20-2024
Television Simulator '99 Public Beta
2017-2024 Zach Hall
Always up to date list of 3rd party credits / contributors:
Update Notes - 8-20-2024
- Added a Docker image for easier deployment.
- Added info button components - press
Ito open the info screen. - Currently supported audio info providers are Icecast, Azuracast and a custom one for Nightwave Plaza. Let me know in the chat room if there's any other providers you'd like to see added!
- To make use of audio info you'll need to at minimum add the following background audio options:
backgroundAudio: http://radio.plaza.one/mp3
backgroundAudioOptions:
description: Nightwave Plaza Radio # Optional. Credits will appear in the Info OSD
nowPlayingUrl: https://api.plaza.one/status # Optional. If the radio service you're using has a song history API you can link to it here.
nowPlayingProvider: plaza-one # Required if using nowPlayingUrl. Only a few providers are supported right now; see the documentation for more info. backgroundAudio: http://icecast.example.com/radio.mp3
backgroundAudioOptions:
description: Icecast example
nowPlayingUrl: http://icecast.example.com/status-json.xsl
nowPlayingProvider: icecast backgroundAudio: https://azuracast.example.com/listen/station_name/radio.mp3
backgroundAudioOptions:
description: Station Name
nowPlayingUrl: https://azuracast.example.com/api/nowplaying_static/station_name.json
nowPlayingProvider: azuracastRead this first!
Get started quickly:
- Put the files in the root directory of a web server. For now we require serving out of the root directory.
- Visit index.html and it should load the example configuration.
Basic keyboard controls:
- M toggles mute
- Up / Down control channels
- Left / Right control volume
In the browser you need to un-mute when the page loads because of autoplay restrictions.
Edit the example configuration file (config.tvs.yml) and make it your own.
Read the documentation: https://greenhillplaza.notion.site/Television-Simulator-99-c28584f069b94f58a71b5c9fe2484dcb
Join our community on Slack to ask for help or report issues: https://join.slack.com/t/greenhillplaza/shared_invite/zt-2dq8mx6sm-3YnobHETTmxUNE02TOSPRg