Customizing plugins

Plugins can extend Overseer Studio in the following ways and can contain zero or more of the following systems:

1. Datasets - Provide data from a static or dynamic source such as an API to other extensions
2. Extensions - Custom tiles a user can create and interact with
3. Locales - Add new languages to Overseer Studio
4. Presets - Premade GM screens a user can create
5. Themes - Add new themes to Overseer Studio

The easiest way to create a plugin is via the Overseer CLI.

npx @overseer-studio/sdk init

Directory structure

Plugins typically follow the following directory structure. You are by no means required to follow this pattern; however, it is definitely recommended to stay organized while developing your plugins. The pattern below is how we typically build first-party plugins.

my-plugin/
├─ datasets/            # Datasets (if any)
│  ├─ my-dataset/
│  |  ├─ manifest.json
├─ extensions/          # Extensions (if any)
│  ├─ my-extension/
│  |  ├─ assets/
│  |  ├─ src/
│  |  ├─ manifest.json
├─ locales/             # Translations (if any)
│  ├─ my-locale/
│  |  ├─ main.ftl
├─ presets/             # Premade GM screens (if any)
│  ├─ my-preset/
│  |  ├─ assets/
│  |  ├─ src/
│  |  ├─ manifest.json
├─ themes/              # Themes (if any)
│  ├─ my-theme/
│  |  ├─ theme.css
├─ package.json         # Node.js dependencies and scripts
├─ manifest.json        # Overseer plugin definition
├─ README.md            # Description and relevant information about the plugin

Plugin definition

A plugin is defined by a manifest.json file.

Reference

Please reference https://overseer.studio/schemas/plugin/manifest.json for a complete definition of the file.

Data directory

The default data directory varies based on your operating system and settings in Overseer Studio. To locate your current data directory, open Overseer and navigate to Settings > Data and storage. The Data directory path is shown at the top.

Default locations:

Plugins are loaded from the Plugins/ folder of the directory above. Learn how to create a plugin in under 5-minutes.