Nook
Submit a plugin Get Nook

Publish a plugin

A plugin is a folder, so a public GitHub repository is all it takes to share one. The marketplace lists it once it's reviewed.

Prepare the repository

  • Put plugin.toml at the root of the repository, or in a folder you link directly (…/tree/main/my-plugin).
  • Add a README that says which runtime your plugin needs (Python 3.8+, Node 18+, …). For zero setup, use PowerShell or ship a compiled binary.
  • Keep your plugin's data in NOOK_DATA_DIR, so updating the plugin folder never deletes it.
  • If your plugin calls the internet, say in the README what it sends and where.
  • Add a license so people know how they may use it.

Submit it

Go to Submit a plugin and paste the repository link. The site reads your plugin.toml straight from GitHub and checks it with the same rules Nook uses: a valid id, a name, a run command, and a known size and mode. Then pick an icon from the list, a category and a short description.

Your listing appears after a review. Reviews look at what the plugin runs and what it sends where. If something needs a fix and you left a contact, you'll hear back.

How people install it

Each listing has an Install in Nook button. It opens a nook:// link: Nook comes up with your plugin's name, source and the exact command it runs, and adds the tile when the person clicks Install. Nothing restarts.

Nook downloads the commit your listing was made from, so later pushes don't reach people until the listing is updated. Under the button there's also a PowerShell command for installing by hand:

powershell
git clone https://github.com/you/nook-weather.git "$env:APPDATA\Nook\plugins\weather"
Plugins are programs. A plugin runs with the same rights as Nook, like any app you install. Only install plugins whose code you've read or whose author you trust. Apart from downloading a plugin from GitHub when you install it, Nook makes no network calls itself; if a plugin needs the internet, the plugin makes those calls.

Ideas

Weather and rain radar · CI status that turns red when the build breaks · a stock or crypto ticker with a sparkline · GitHub notifications with a pulse in the pill · Spotify, Home Assistant or Hue controls · ping to your servers · a next-meeting countdown from an .ics feed · translate the clipboard · a habit tracker on a canvas · Docker containers · Snake or 2048 on a large tile · a local LLM prompt box · drop images to compress them · world clocks for your team.