/Kiosk-Client

A free, simple, easy to use, app that displays important information on the screen. Designed to be used in a kiosk setting, Kiosk Client can render multiple images or webpages in a predefined sequence or in a random order. Kiosk Client can pull its content from publicly accessible sites. The instructions that drive Kiosk Client can also be hosted f

Primary LanguageC#MIT LicenseMIT

Kiosk Client CodeQL Build Status

A free, simple, easy to use, app that displays important information on the screen. Designed to be used in a kiosk setting, Kiosk Client can render multiple images or webpages in a predefined sequence or in a random order. Kiosk Client can pull its content from publicly accessible sites. The instructions that drive Kiosk Client can also be hosted from any static web hosting source.

Features

  • Remotely control the app using a web-based static file or a local file.
    • Displays images
      • Supports most common formats such as .png and .jpg.
    • Displays websites
      • Customizable, automatic website scrolling.
  • Set timing between actions to allow for a dynamic experience.
  • Designed for use with Windows 10 machines running in Kiosk Mode.
    • Automatically starts previously loaded Orchestration when the app starts.
  • Minimum permission requirement reduces elevation attack surface.

Getting Started

Prerequisites

Known Issues

Due to the way we render web pages, you can't press the Escape key to return to the settings. Instead, there is a button with a low opacity that exists in the bottom right-hand corner of the screen for the first 5 seconds the webpage is rendered. Clicking on that button will return you to the Settings menu.

Contributing

We encourage anyone to contribute features or bug fixes. Simply raise an issue, then use that thread to let people know what you're working on. This coordinates work so two people aren't working on the same problem at the same time.

Please base your changes off of the develop branch. This branch functions as our staging area until we can get a tighter CI pipeline working.

Note: PR builds will fail the pipeline check if you're contributing from a fork. This due to a security restriction in Azure Pipelines. A repository owner will verify your commit builds and passes tests once it has been merged with the develop branch.

Windows Store

You can download the latest released version from the Windows Store.

English badge

Future Work

Some ideas for future work include:

  • A UI to help design the Orchestration Settings Files
  • Support for more actions, such as movies, PowerPoints, etc.
  • Support for embedded data, such as images. This would enable clients to function offline.
  • Multiple client coordination, allowing groups of clients on a network to coordinate the information they display.