NAV Navbar
Of logo

Openframe Documentation

This project is in an early state, and is under active development — we cannot promise everything will work 100%. Feedback and contributions are welcome!

Documentation Topics

Frame Setup Guide

A step-by-step guide to installing and setting a Raspberry Pi-based frame.

Development Environment Setup

A general overview of how to setup an enviroment for Extension development or core contribution.

API Docs

Swagger-generated API docs.

JS Client

A JavaScript API client library for interacting with the Openframe REST API.

What is Openframe?

Openframe is an open source platform for artists, curators and art enthusiasts to share, discover and display digital art.

Openframe is free. Anyone can set up a frame using an HDMI display and a Raspberry Pi.

Openframe is a collaborative, on-going project. The platform consists of an API, a web app, and software for the RPi that currently supports images, video, web-based artwork, and shaders. Our goal is to create a system that is accessible and extensible, allowing artists to easily add support for new digital formats.

Go to openframe.io for more info.