Skip to content

Extensions Manifest

Daniel Di Sarli edited this page Jun 18, 2015 · 4 revisions

Extensions Manifest

The manifest is a special file, called nqq-manifest.json and located within the main directory of your extension, that describes the extension. For example:

{
  "name": "GUID Generator",
  "unique_name": "com.notepadqq.guid-generator",
  "author": "notepadqq",
  "version": "1.0.0",
  "description": "A simple GUID generator",
  "runtime": "nodejs",
  "main": "main.js"
}
  • name the user readable name of the extension.
  • unique_name a unique name for the extension. This field should never change for all the lifetime of the extension, even if name or author get changed. Use a reverse domain name notation, for example "com.yourname.extname". Allowed characters are -, _, 0..9, a..z, all lower case.
  • author is the author of the extension.
  • version is the version of the extension.
  • description is a description of the extension.
  • runtime is used to let Notepadqq know how to handle the extension. Currently, the only supported runtime is nodejs.
  • main is a file name that represents the entry point of the extension.