Quickstart

Build a plugin, load it into your own Atlas, and watch it run. It takes a few minutes and needs no approval; development plugins install straight from a folder on your disk.

1 · Create the package

A plugin is a folder with a manifest and the files it references. Start with a window plugin: a manifest, an icon, and an HTML entry.

my-plugin/
  manifest.json
  icon.svg
  index.html      // your window UI (any framework)
  overview.html   // your Plugin Center overview

2 · Write the manifest

Declare the identity, the window entry, and only the permissions you actually use.

{
  "schemaVersion": 2,
  "id": "com.you.hello",
  "name": "Hello",
  "version": "1.0.0",
  "description": "A starter window plugin.",
  "author": "You",
  "visibility": "public",
  "icon": "icon.svg",
  "kind": "window",
  "host": { "launch": "local-window" },
  "entryPoints": { "window": "index.html", "overview": "overview.html" },
  "permissions": ["items.read", "log.write"],
  "compatibility": { "app": ">=0.9.0", "pluginApi": "^1.0.0", "platforms": ["win32"], "architectures": ["x64"] }
}

3 · Load it

Open the Plugin Center's Development tab and use Import Local Project, pointing it at your folder. Atlas validates the manifest, installs the plugin into its development directory, and mounts your surfaces.

4 · Iterate

Edit your files and reload the plugin from the Development tab to pick up changes, with no app restart. When it is ready for other people, see Publishing.