Publishing

Nuclear's plugin store is backed by a static registry at github.com/NuclearPlayer/plugin-registry. The registry lists plugin metadata (name, repo, category). The actual plugin code lives in the developer's own GitHub repository. When a user installs a plugin, Nuclear fetches the latest GitHub release from that repo.

Publishing a plugin takes three steps: configure your package.json, create a GitHub release with a plugin.zip asset, and submit a PR to the registry.

package.json requirements

Your plugin's package.json must include these fields:

The nuclear field

The nuclear field holds Nuclear-specific config:

{
  "nuclear": {
    "displayName": "My Plugin",
    "category": "metadata",
    "icon": {
      "type": "link",
      "link": "https://example.com/icon.png"
    },
    "permissions": ["network"]
  }
}

{% hint style="info" %} Categories are convenience tags for filtering in the store. Pick the one that best describes your plugin's primary function. {% endhint %}

Full example

{
  "name": "nuclear-plugin-discogs",
  "version": "1.0.0",
  "description": "Fetch album and artist metadata from Discogs",
  "author": "nukeop",
  "license": "MIT",
  "main": "dist/index.js",
  "nuclear": {
    "displayName": "Discogs",
    "category": "metadata"
  }
}

Creating a GitHub release

1. Tag your commit with a semver version (e.g., v1.0.0).
2. Create a GitHub release from that tag.
3. Attach a file named exactly plugin.zip as a release asset.
4. Publish the release.

Nuclear looks for an asset named plugin.zip in the latest release. If it's missing, installation fails.

What goes in plugin.zip

The zip should contain your built plugin files at the root level, not nested in a subdirectory:

plugin.zip
├── index.js          # Entry point (or whatever `main` points to)
├── package.json      # Plugin metadata
└── ...               # Any other files your plugin needs

{% hint style="warning" %} Files must be at the root of the zip, not inside a subdirectory. If your zip contains my-plugin/index.js instead of index.js, the plugin won't load. {% endhint %}

Nuclear can compile TypeScript on the fly, so you can ship .ts or .tsx source files instead of pre-built JavaScript. Pre-building is recommended for faster load times.

Set up CI to build and create the release automatically. Manual zip creation is error-prone.

Submitting to the registry

1. Fork NuclearPlayer/plugin-registry.
2. Add your plugin to the plugins array in plugins.json:

{
  "id": "nuclear-plugin-discogs",
  "name": "Discogs",
  "description": "Fetch album and artist metadata from Discogs",
  "author": "nukeop",
  "repo": "NuclearPlayer/nuclear-plugin-discogs",
  "category": "metadata",
  "tags": ["discogs", "metadata"],
  "addedAt": "2026-01-25"
}

3. Open a pull request.

Registry entry fields

Updating your plugin

You don't need to update the registry to release new versions. Create a new GitHub release with an updated plugin.zip, and Nuclear will fetch it the next time someone installs your plugin.

Only submit a registry PR if you need to change the plugin's metadata (description, category, tags, etc.).

{% hint style="info" %} There is no automatic update push to users who already have your plugin installed. They need to remove and reinstall to get the latest version. {% endhint %}

Examples

You can find example plugins on Github: github.com/NuclearPlayer.