Submitting a plugin

Publish your plugin to the official marketplace.

The official marketplace (https://github.com/Saber-AI-Research/Novelist-marketplace) is a metadata-only repository — your plugin ZIP doesn’t live there. It’s hosted as a GitHub Release asset on your own repository.

Publishing flow

  1. Cut a release on your own GitHub repo with the built <id>-<version>.zip attached as a release asset;
  2. Under Novelist-marketplace, add plugins/<id>/manifest.toml and README.md;
  3. Open a Pull Request. CI will:
    • validate the manifest.toml schema;
    • fetch the ZIP from your release and run integrity + security checks (max 5 MB, no suspicious calls, etc.);
    • on merge, registry.json is rebuilt automatically.

A few minutes after merge your plugin shows up on the marketplace index.

manifest.toml template

id = "my-plugin"
name = "My Plugin"
version = "1.0.0"
description = "One sentence about what it does."
author = "your-github-handle"
author_url = "https://github.com/your-github-handle"
repo = "https://github.com/your-github-handle/novelist-my-plugin"
category = "productivity"    # see categories.json
permissions = ["ui", "read"]
tags = ["words", "stats"]
min_novelist_version = "0.1.0"

The full field list and validation rules are in CONTRIBUTING.md.

Pre-submission checklist

  • Plugin ZIP is built and attached to a release on your repo
  • manifest.toml is complete
  • README.md covers features, screenshots, and permissions
  • An icon is attached (optional, 128×128 PNG with transparency is recommended)
  • Your repository is public
  • License is clear (MIT or Apache 2.0 recommended)

When it’s ready, fork Novelist-marketplace, drop your files in, and open a PR.