Schema.json

{
  "definitions": {
    "semver": {
      "type": "string",
      "examples": [
        "0.0.0"
      ],
      "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-]+)*))?$"
    },
    "verrange": {
      "type": "string",
      "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-]+)*))?(?:-(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-]+)*))?)?"
    },
    "url": {
      "type": "string",
      "pattern": "https?:\/\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,}(\/[-a-zA-Z0-9@:%_\\+.~#?&//=]*)?"
    },
    "typename": {
      "type": "string",
      "pattern": "^(?:((?!\\d)\\w+(?:\\.(?!\\d)\\w+)*)\\.)?((?!\\d)\\w+)$"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "object",
  "required": [
    "name",
    "id",
    "version",
    "gameVersion",
    "description",
    "author"
  ],
  "properties": {
    "name": {
      "$id": "#/properties/name",
      "type": "string",
      "description": "plugin name",
      "examples": [
        "Beat Saber IPA"
      ],
      "pattern": "^(.*)$"
    },
    "id": {
      "$id": "#/properties/id",
      "type": ["string","null"],
      "description": "modsaber id",
      "examples": [
        "beatsaber-ipa-reloaded"
      ],
      "pattern": "^([^\\s]*)$"
    },
    "version": {
      "$id": "#/properties/version",
      "$ref": "#/definitions/semver",
      "description": "plugin version"
    },
    "gameVersion": {
      "$id": "#/properties/gameVersion",
      "$ref": "#/definitions/semver",
      "description": "compatible game version"
    },
    "description": {
      "$id": "#/properties/description",
      "type": ["string", "array"],
      "description": "plugin description",
      "examples": [
        "A build of IPA designed for Beat Saber"
      ],
      "items": {
        "type": "string"
      }
    },
    "author": {
      "$id": "#/properties/author",
      "type": "string",
      "description": "plugin author",
      "examples": [
        "DaNike",
        "xyonico"
      ]
    },
    "dependsOn": {
      "$id": "#/properties/dependsOn",
      "type": "object",
      "description": "dependencies",
      "patternProperties": {
        "^([^\\s]*)$": {
          "$ref": "#/definitions/verrange",
          "description": "a dependency"
        }
      }
    },
    "conflictsWith": {
      "$id": "#/properties/conflictsWith",
      "type": "object",
      "description": "incompatibilities",
      "patternProperties": {
        "^([^\\s]*)$": {
          "$ref": "#/definitions/verrange",
          "description": "an incompatible mod item"
        }
      }
    },
    "loadAfter": {
      "$id": "#/properties/loadAfter",
      "type": "array",
      "description": "plugins to load before this one",
      "items": {
        "type": "string",
        "description": "the plugin id to load first"
      }
    },
    "loadBefore": {
      "$id": "#/properties/loadBefore",
      "type": "array",
      "description": "plugins to load after this one",
      "items": {
        "type": "string",
        "description": "the plugin id to load after"
      }
    },
    "features": {
      "$id": "#/properties/features",
      "type": "object",
      "description": "features to enable for plugin",
      "patternProperties": {
        "^([^\\s]*)$": {
          "type": "object",
          "description": "a descriptor object for the feature"
        }
      }
    },
    "icon": {
      "$id": "#/properties/icon",
      "type": "string",
      "description": "the icon to represent the plugin, as a PNG",
      "pattern": ".*\\.png"
    },
    "files": {
      "$id": "#/properties/files",
      "type": "array",
      "description": "A list of files that are associated with this mod. If this is a bare manifest, must include *all* files distributed with the mod. Otherwise, it may exclude the assembly it is embedded in.",
      "uniqueItems": true,
      "items": {
        "type": "string",
        "description": "the path to a file distributed with the mod, relative to the installation directory",
        "examples": [
          "Plugins/StreamCore.dll",
          "Libs/INIFileLoader.dll"
        ]
      }
    },
    "links": {
      "$id": "#/properties/links",
      "type": "object",
      "description": "various links associated with the mod",
      "properties": {
        "project-home": {
          "$id": "#/properties/links/properties/project-home",
          "$ref": "#/definitions/url",
          "description": "a link to the project home page. if not specified, same as project-source"
        },
        "project-source": {
          "$id": "#/properties/links/properties/project-source",
          "$ref": "#/definitions/url",
          "description": "a link to the project source. if not specified, same as project-home."
        },
        "donate": {
          "$id": "#/properties/links/properties/donate",
          "$ref": "#/definitions/url",
          "description": "a link to a donations page"
        }
      }
    },
    "misc": {
      "$id": "#/properties/misc",
      "type": "object",
      "description": "miscellaneous properties",
      "properties": {
        "plugin-hint": {
          "$id": "#/properties/mist/properties/plugin-hint",
          "$ref": "#/definitions/typename",
          "description": "a hint for the loader for where to find the plugin type"
        }
      }
    }
  }
}