Manifest
Every package.json field and the rules for feature and theme plugins
Put package.json at the ZIP root, with a notyra object alongside normal npm metadata. Unknown notyra fields are ignored. Missing fields, wrong types and invalid values produce errors containing the field and value.
| Field | Type | Required | Applies to / rules |
|---|---|---|---|
name | string | Yes | Both. Unscoped npm name, lowercase alphanumeric first character, at most 214 characters. Keep the ID stable after installation |
version | string | Yes | Both. Semver without a v prefix or surrounding whitespace |
description | string | No | Both. Plugin description |
author | string or object | No | Both. An object contains name: string and optional email: string, url: string |
notyra.displayName | string | Yes | Both. Nonempty display name |
notyra.type | feature or theme | Yes | Plugin kind |
notyra.notyraVersion | string | Yes | Both. node-semver compatibility range, evaluated with prereleases included |
notyra.main | string | Feature only | Required ESM .js / .mjs path; forbidden for themes |
notyra.permissions | array | Feature only | Required array of { name, purpose? }. Empty is valid; duplicates are forbidden. Forbidden for themes |
notyra.networkDestinations | string[] | Conditional | Feature. At least one destination is required with network; see networking |
notyra.settings | array | No | Feature. Setting declarations below |
notyra.theme | string | Theme only | Required theme .json path |
notyra.themeCss | string | No | Theme. Extra .css applied only when selected |
File paths are relative to the plugin folder. Absolute paths, .., backslashes and colons/drive prefixes are rejected.
Feature example
{
"name": "my-plugin",
"version": "0.1.0",
"description": "Character-count panel",
"author": { "name": "Developer", "url": "https://example.com" },
"notyra": {
"displayName": "My Plugin",
"type": "feature",
"notyraVersion": "^3.1.7",
"main": "dist/index.js",
"permissions": [],
"settings": [{ "key": "prefix", "title": "Label", "type": "string", "default": "Characters" }]
}
}The template contains a complete runnable implementation.
Settings
Every declaration has a unique key, a display title, a type, a matching default, and optionally a description. A select also requires options: { value: string, label: string }[]; its default must be one of those values.
| Type | Accepted values | Notes |
|---|---|---|
string | Strings | Empty strings are valid |
number | Finite numbers | Numeric input strings are converted. Empty input, NaN and Infinity are rejected |
boolean | true / false | The string "true" is invalid |
select | Declared option values | Undeclared values are rejected |
Missing or incorrectly typed stored values fall back to defaults. Plugin-provided names, authors, setting labels and permission purposes are displayed literally, without treating them as translation keys.
Theme example
{
"name": "notyra-theme-blue",
"version": "1.0.0",
"notyra": {
"displayName": "Blue Theme",
"type": "theme",
"notyraVersion": "^3.1.7",
"theme": "theme.json",
"themeCss": "theme.css"
}
}See the theme format for theme.json. IDs must not duplicate builtin themes, custom themes or earlier plugin themes. Theme plugins execute no JavaScript. A complete package is available in official theme plugins.