Addon manifest reference

Every addon needs a manifest.json at its package root. This is the full field reference, current schema version 2.

Example

{
  "schemaVersion": 2,
  "name": "My Addon",
  "slug": "my-addon",
  "version": "1.0.0",
  "author": "Your Name",
  "description": "One-line summary shown in the Extensions screen.",
  "priority": 50,
  "sdk": ">=1.0.0",
  "platforms": ["wordpress", "opencart", "prestashop", "shopware"],
  "surfaces": ["designer", "admin", "server"],
  "entrypoints": {
    "designer": "dist/my-addon.bundle.js",
    "admin": "admin-js/my-addon-admin.js",
    "server": "bootstrap.php"
  },
  "platformEntrypoints": {
    "wordpress": { "server": "bootstrap.php" }
  },
  "dependencies": [],
  "capabilities": ["designer.item-type"],
  "requiresServices": ["settings", "database", "assets"]
}

Field reference

FieldTypeDescription
schemaVersionnumberManifest schema version. Use 2 for new addons.
namestringHuman-readable name shown in the Extensions screen.
slugstringUnique identifier. Must match the addon's folder name exactly — mismatches block install.
versionstringSemantic version of the addon package, shown to admins and used for update checks.
authorstringAuthor or vendor name, shown in the Extensions screen.
descriptionstringShort description shown alongside the addon in the admin.
prioritynumberLoad order — lower loads earlier. Addons providing low-level primitives (e.g. preflight checks) should use a low number; addons that build on other addons should load later.
sdkstringMinimum addon SDK version (VeyopAddon::SDK_VERSION), e.g. >=1.0.0. Prefer this over requires: each platform package releases independently, but all of them share one SDK.
requiresstringMinimum compatible core version, e.g. >=1.1.0. An addon that doesn't satisfy this stays installed but is blocked from loading until the core is updated. If your bundle includes core code tied to the running host (designer stores and composables, core/veyopRuntime, or core/extensionRegistry), set this to the core version you built against.
platformsstring[]Hosts the addon supports: wordpress, opencart, prestashop, shopware. Unlisted hosts show the addon as unavailable.
surfacesstring[]Where the addon runs: any of designer, admin, storefront, server.
entrypointsobjectExact file per declared surface. A missing entrypoint file for a declared surface blocks activation.
platformEntrypointsobjectPer-platform server entry, e.g. platformEntrypoints.wordpress.server. Lets one addon package target multiple platforms with different bootstrap files.
dependenciesstring[]Slugs of other addons that must also be installed and enabled. Example: dynamic-pricing depends on printing-pricing.
capabilitiesstring[]Auditable feature flags describing what the addon does (e.g. registering a new design-item type) — used for admin visibility, not enforcement.
requiresServicesstring[]Declared platform services the addon needs: settings, database, routes, auth, products, commerce, media, http, scheduler, sanitizer, translator, assets, cache, storefront.

Package structure

plugins/my-addon/
  manifest.json
  bootstrap.php              — PHP entry point (platformEntrypoints.wordpress.server)
  dist/my-addon.bundle.js    — preferred over loose, unbundled JS files
  dist/my-addon.bundle.css
  src/                        — Vue/TS source
  hooks/                      — PHP hook registration files
  admin-js/, admin/css/       — admin-only assets

Install & enable

  • Manual: drop the folder into plugins/{slug}/, then enable it from Extensions.
  • ZIP upload: admins upload one ZIP from Extensions; the manifest can be at the ZIP root or one folder down.
  • Enabled/disabled state is stored per-site; a fresh install expands to "all discovered addons" until an admin explicitly changes it.
  • Uploads and state changes require admin capability and pass through CSRF protection.
  • Updates stage a rollback backup and revalidate the package before committing the new version.
Signing: official packages contain veyop-package.json: signing key ID, Ed25519 signature, and SHA-256 for every file. Manual admin uploads are verified but not blocked: a verified package installs as official, and anything else (no signature, an edited official ZIP, an unknown key, or a server without Sodium) installs disabled as a custom build. To make uploads strict, define VEYOP_REQUIRE_SIGNED_ADDONS as true in the site's config file: a package that fails verification is then refused, and an unsigned one needs the allow_unsigned_custom opt-in. Team distribution should add its public key through veyop_addon_trusted_signing_keys so its packages verify.
Origin and restore: custom addons install disabled and receive a Custom build badge. They do not receive official update prompts. To return to vendor code, download the signed ZIP from the Polar customer portal and choose Restore official ZIP; Veyo confirms overwrite, package slug, signature, and paid entitlement before replacing files.