Skip to content
sub-screen-player

Getting started

  1. Install ssp. The installer downloads the latest release for your system, checks its SHA-256 checksum and puts ssp on your PATH.

    Terminal window
    curl -fsSL https://subscreen.dev/install.sh | sh

    It installs to ~/.local/bin (change with SSP_INSTALL_DIR).

    You can also download the archive yourself or build from source.

  2. Linux only: allow access to the display. Install the udev rule, then replug the display.

    Terminal window
    curl -fsSL https://raw.githubusercontent.com/nomunomu0504/sub-screen-player/main/contrib/linux/70-sub-screen-player.rules \
      | sudo tee /etc/udev/rules.d/70-sub-screen-player.rules > /dev/null
    sudo udevadm control --reload-rules

  3. Plug in the display and start the daemon. The clock appears.

    Terminal window
    ssp serve

  4. Try a few commands in another terminal.

    Terminal window
    ssp devices                    # list displays
    ssp show photo.jpg --fit cover # show an image
    ssp clock --no-seconds         # back to the clock, without seconds
    ssp brightness 60              # backlight in percent

  5. Start it at login. Stop ssp serve with Ctrl-C, then:

    Terminal window
    ssp service install

Next steps

Section titled “Next steps”