manifest.schema.json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The display name/title of this scroll."
    },
    "id": {
      "type": "string",
      "description": "A unique identifier for the package. E.g. com.github.yourname.package-name or use another domain you own.",
      "$comment": "For now all packages are inside the scroll directory, so one could use the directory name. Maybe later there are user accounts and we can use username.scrollname"
    },
    "version": {
      "type": "string",
      "description": "A semver version number of the form `major.minor.patch`. Increment this when you update the package.",
      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
    },
    "description": {
      "type": "string",
      "description": "Short summary of what the scroll does."
    },
    "author": {
      "type": "string",
      "description": "Some information showing where this scroll came from.\nIn the easiest case this is a 'Your Name <mail@example.com>' string."
    },
    "homepage": {
      "type": "string",
      "description": "Website where more infos can be found. For scrolls in the library repo this can be left blank. It will link to the scroll folder.",
      "format": "uri"
    },
    "shelf": {
      "type": "string",
      "description": "The kind of scroll this is. See the enum values (like Custom CSS, User Script, ...). Different kinds of scrolls go on different shelves.",
      "enum": [
        "Custom CSS",
        "Stylus CSS",
        "User Script",
        "Browser Extension",
        "Template"
      ]
    },
    "config": {
      "type": "object",
      "description": "Extra data depending on the kind of scroll. Custom CSS for example can declare used tags and some demo rems."
    },
    "categories": {
      "type": "string",
      "enum": ["rem", "formatting", "layout", "theme", "page template"]
    },
    "thumb": {
      "type": "string",
      "description": "Path to a preview image.",
      "default": "thumb.png"
    },
    "install": {
      "type": "array",
      "description": "One or more methods to install the scroll.",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            // TODO: Describe copy as separate type
            "enum": ["copy", "api", "link", "download.autokey"]
          }
        },
        "required": ["method"]
      }
    },
    "remnoteVersion": {
      "type": "string",
      "description": "RemNote version this scroll is at least compatible with. Currently RemNote has no version number."
    }
  },
  "required": ["name", "id", "author", "shelf", "install"]
}