Getting started

Prerequisites

You will need Node.js and NPM installed on your system to create plugins for Overseer Studio.

CLI tool

The Overseer CLI tool is the easiest way to create and manage plugins.

npx @overseer-studio/sdk

Your first plugin

Development instructions can vary based on your OS, use whatever workflow is comfortable for you.

Create a plugin in less than 5-minutes. Before starting, locate your plugins directory.

# The below commands assume a Windows environment
# The instructions are similar for macOS and Linux

# Navigate to your plugins directory
cd %APPDATA%\Overseer Studio\Plugins

# Create a folder for your plugins
mkdir @my-name
cd @my-name

# Create a folder for your first plugin
mkdir my-first-plugin
cd my-first-plugin

# Initialize the project
npm init -y

# Initialize Overseer SDK
npx @overseer-studio/sdk init

The init command will ask you a handful of questions to customize your plugin. Choose “Extension” when prompted.

You now have a working extension that can be created as a tile in Overseer! Reload Overseer Studio to see you new extension when creating tiles.

Extending your extension

Extensions are a simple collection of HTML, JS, and CSS files and can be written to use any modern web technology. Since each extension is an iframe injected with the Overseer SDK, you are able to create sophisticated web apps that feel native to Overseer or the system you’re building for.

Using the project above, open the index.html file located in your extensions\ directory to start customizing your extension.