Skip to content
Television Simulator

Program Guide

The program guide engine displays a non-interactive program guide for channels in your configuration file. It will scroll automatically through a configurable range of channels and display program information for each one.

There are multiple themes available for the program guide engine, and you can also customize the colors used in the display among other things.

Themes

Section titled “Themes”

The guide engine supports multiple themes; currently there are two available: the default theme (modeled after the Prevue Guide) and the 1989 theme (modeled after the EPG Jr.).

Default program guide in action

Both themes can be customized with different colors and other options.

1989 theme with custom colors

Splitting the Screen

Section titled “Splitting the Screen”

Technically the program guide engine is just the guide itself, but it can be combined with other engines to create split-screen experience you remember from TV. The v-split and h-split layouts are perfect for this and were created originally to achieve this effect.

1989 theme with split and crawl

- number: 165
  name: Program Guide 1989 Split
  abbr: GUIDE
  info:
    title: Prevue Guide
  v-split:
    - video:
        src: /placeholders/tvs-loop.mp4
        aspectRatioBehavior: cover
    - guide:
        theme: "1989"
        themeOptions:
          ticker: # Optional messages to scroll across the bottom of the screen
          - "Hypercom cable - connecting you to the future"
          - "Pay-Per-View Movies - Ch 1 - Straight from Hollywood to your home, anytime!"
          - "Sponsored by Oak Ridge - Visit our new factory outlet store"
          - "Sponsored by Greenhill Plaza Grand Hotel - New casino members get $15 in free play - Join today and play for free!"

Properties

Section titled “Properties”

timeslots

Section titled “timeslots”

Type: ITimeslotOptions

Description: Controls how many time columns are visible in the guide and how much time each column represents.

number sub-property required

Section titled “number ”

Type: number

Description: Number of timeslots to show in the guide at once.

minutes sub-property required

Section titled “minutes ”

Type: number

Description: Number of minutes represented by each timeslot.

guide:
  timeslots:
    number: 4
    minutes: 30
guide:
  timeslots:
    number: 6
    minutes: 15

theme

Section titled “theme”

Type: default | 1989

Description: Theme preset used to render the guide.

alerts

Section titled “alerts”

Type: IAlert[]

Description: Alert messages to display at specific channel positions.

position sub-property required

Section titled “position ”

Type: ConfigChannelNumber (string | number)

Description: Channel number where this alert should be shown.

text sub-property required

Section titled “text ”

Type: string

Description: Alert text to display.

guide:
  alerts:
    - position: 2
      text: "Weather bulletin at 8:00 PM"
guide:
  alerts:
    - position: "12.5"
      text: "Now showing: Classic movie night"
    - position: 45
      text: "Local news starts at the top of the hour"
Section titled “logo”

Type: string

Description: URL path of a logo image shown at the top of the guide.

primaryColor

Section titled “primaryColor”

Type: CSS Color

Description: Primary theme color used by the guide.

secondaryColor

Section titled “secondaryColor”

Type: CSS Color

Description: Secondary theme color used by the guide.

textColor

Section titled “textColor”

Type: CSS Color

Description: Text color used by the guide theme.

cellColor

Section titled “cellColor”

Type: CSS Color

Description: Text color used in guide cells.

themeOptions

Section titled “themeOptions”

Type: object

Description: Additional options for the selected theme. Available properties depend on the theme you choose.

default theme options

Section titled “default theme options”

There are no additional options for the default theme at this time.

1989 theme options

Section titled “1989 theme options”
  • title: The text to display at the top of the guide in the 1989 theme.
  • ticker: An array of strings to scroll across the bottom of the screen in the 1989 theme.
guide:
  theme: "1989"
  themeOptions:
    title: "Hypercom Cable Guide"
    ticker:
      - "Pay-Per-View Movies - Ch 1 - Straight from Hollywood to your home, anytime!"
      - "Sponsored by Oak Ridge - Visit our new factory outlet store"

Both of these options are optional.

channelRange

Section titled “channelRange”

Type: ChannelRange

Description: Limits which channels are shown in the guide.

min sub-property

Section titled “min ”

Type: ConfigChannelNumber (string | number)

Description: Minimum channel number to include (inclusive).

max sub-property

Section titled “max ”

Type: ConfigChannelNumber (string | number)

Description: Maximum channel number to include (inclusive).

guide:
  channelRange:
    min: 2
    max: 45
guide:
  channelRange:
    min: "10.1"
    max: "10.5"