pipeline status coverage report GPLv3 license Scenic version

Overview

Scenic is a graphical user interface made with React. Together with Scenic Core and Switcher, it forms the backbone of the Scenic suite, a telepresence software stack that allows for real-time transmission of audiovisual and arbitrary data over any IP network. Telepresence systems can be used in various artistic contexts, so that two different creative spaces can communicate with each other in real-time and present a combined performance.

Scenic is designed to be used in conjunction with Scenic Core, a Node.JS server that communicates with Scenic using Socket.IO.

Scenic is currently maintained by the Société des Arts Technologiques (SAT), a non-profit artistic entity based in Montreal, Canada.

Quick Start

Scenic is freely available online here: scenic-app.com. No other installation step is necessary.

However, keep in mind that you will still need a running instance of Scenic Core on your local network in order to use Scenic. Upon opening http://scenic-app.com, you will to provide the IP address of your local server running Scenic Core.

Take note that scenic-app.com is automatically updated from the master branch of this repository.

Quick Installation

It is possible to build and run Scenic on your local machine. These instructions should get you up and running quickly.

Scenic is tested with Ubuntu 20.04 LTS (Focal Fossa) and the Chromium browser, but it has also been run successfully on Ubuntu 18.04 LTS and should be compatible with any modern browser.

STEP COMMAND
Install Shmdata Shmdata instructions
Install NDI2shmdata NDI2shmdata instructions
Install Switcher Switcher instructions
Install Node.js 10 Node.js guide
Install Docker Docker guide
Install scenic-core npm install -g scenic-core
Deploy Scenic docker run -p 8080:8080 registry.gitlab.com/sat-mtl/telepresence/scenic:master

Once everything is installed, simply follow the instructions in the Usage section to get started!

For more detailed information on how to build and install Scenic from source, consult our Installation Guide.

Usage

First, launch Scenic Core with the scenic command.

Second, open Scenic in your browser (Chromium is recommended).

For optimal support of touchscreens, consider launching Chromium with --touch-events.

Contributing

Check out our Contributing Guide to get started!

Additionally, take a look at Scenic's documentation.

Authors

See here.

License

This project is licensed under the GNU General Public License version 3 - see the LICENSE file for details.

Acknowledgments

This project was made possible by the Société des Arts Technologiques (SAT).