mirror-chatterino2/docs/plugin-info.schema.json

{
  "$schema": "http://json-schema.org/schema",
  "$id": "https://raw.githubusercontent.com/Chatterino/chatterino2/master/docs/plugin-info.schema.json",
  "title": "Plugin info",
  "description": "Describes a Chatterino2 plugin (draft)",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Plugin name shown to the user."
    },
    "description": {
      "type": "string",
      "description": "Plugin description shown to the user."
    },
    "authors": {
      "type": "string",
      "description": "A string describing authors of the Plugin. This could be a list of names, an organisation or something else, as long as it's clear who made the Plugin."
    },
    "homepage": {
      "type": "string",
      "description": "Optional URL to your Plugin's homepage. This could be your GitHub repo for example."
    },
    "tags": {
      "description": "Something that could in the future be used to find your plugin.",
      "type": "array",
      "items": {
        "type": "string",
        "examples": ["moderation", "utility", "commands"]
      },
      "uniqueItems": true
    },
    "version": {
      "type": "string",
      "description": "Semver version string, for more info see https://semver.org.",
      "examples": ["0.0.1", "1.0.0-rc.1"]
    },
    "license": {
      "type": "string",
      "description": "A small description of your license.",
      "examples": ["MIT", "GPL-2.0-or-later"]
    }
  },
  "required": ["name", "description", "authors", "version", "license"]
}