Overseer Studio
Docs

Templates

Templates are premade GM screens. Templates are complete layouts with screens, tiles, extensions, and backgrounds that other GMs can load and start using immediately. A template might contain screens for each scene in an adventure, or a ready-to-go encounter setup with initiative trackers, maps, and character sheets already arranged. The goal is less prep time and more time playing.

Creating a template

You can create a template by creating a definition in the plugin manifest.json file.

Templates are declared under the presets key. The manifest name predates the rename and is kept for compatibility — a preset in the manifest and on disk is a template in the app.

Example:

{
  // [...]
  "presets": [
    { "$ref": "presets/my-preset/manifest.json" }
  ]
}

Template definition

Similar to an extension, a template is defined by its own manifest.json file.

Bundled assets

Images, videos, and other files that ship with the template are referenced with a { "$ref": "..." } pointing at a path relative to the template’s own manifest.json. Only referenced files are packaged, so anything you forget to reference is left out of the plugin.

There are three places a reference can appear:

  • Screen backgroundsbackgroundPath on a screen takes a ref directly.
  • Tile configuration — a ref goes on an individual config value, keyed by the config field name the extension expects. For @overseer/image that field is url:
    {
      "type": "@overseer/image",
      "config": { "url": { "$ref": "assets/mascot.webp" } }
    }
    A ref placed at the root of config ("config": { "$ref": "..." }) is not resolvable — overseer build rejects it.
  • Template assets — the optional assets array supplies the background and screenshot images used on the template’s listing, and icon may be a ref instead of a built-in icon name.

Reference

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

Export session as template

There is no way to export sessions as templates, yet. This feature is on the roadmap.
No results for “”.
Type to search the documentation.