m3-weapons.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "https://raw.githubusercontent.com/miketrethewey/sm-json-data/master/schema/m3-weapons.schema.json",
  "type": "object",
  "title": "Super Metroid Weapon Schema",
  "properties": {
    "weapons": {
      "type": "array",
      "items": {
        "$id": "#/properties/weapons/items",
        "type": "object",
        "title": "Weapon Object",
        "description": "An object that describes a Super Metroid weapon. Each beam combo variation (including charged and chargeless variations) counts as one weapon.",
        "required": [
          "id",
          "name",
          "damage",
          "cooldownFrames",
          "useRequires",
          "situational",
          "hitsGroup",
          "categories"
        ],
        "properties": {
          "id": {
            "$id": "#/properties/weapons/items/properties/id",
            "type": "integer",
            "title": "Weapon ID",
            "description": "Numerical identifier for this weapon, unique across the entire game",
            "default": 0,
            "examples": [
              1
            ]
          },
          "name": {
            "$id": "#/properties/weapons/items/properties/name",
            "type": "string",
            "title": "Weapon Name",
            "description": "A name for the weapon, intended to be used as a recognizable ID. This is often the same as an associated item, but doesn't have to be.",
            "default": "",
            "examples": [
              "Missile"
            ],
            "pattern": "^(.*)$"
          },
          "damage": {
            "$id": "#/properties/weapons/items/properties/damage",
            "type": "integer",
            "title": "Base Weapon Damage",
            "description": "Amount of damage the weapon inflicts on an enemy with no weakness or resistance to it",
            "default": 0,
            "examples": [
              50
            ]
          },
          "cooldownFrames": {
            "$id": "#/properties/weapons/items/properties/cooldownFrames",
            "type": "integer",
            "title": "Cooldown Frames",
            "description": "Number of frames Samus has to wait before the weapon can be used again",
            "default": 0,
            "examples": [
              60
            ]
          },
          "useRequires": {
            "$ref" : "m3-requirements.schema.json#/definitions/logicalRequirements",
            "$id": "#/properties/weapons/items/properties/useRequires",
            "title": "Weapon Use Requirements",
            "description": "Equipment, tech, and flag requirements that are needed to be able to use this weapon"
          },
          "shotRequires": {
            "$ref" : "m3-requirements.schema.json#/definitions/logicalRequirements",
            "$id": "#/properties/weapons/items/properties/shotRequires",
            "title": "Weapon Shot Requirements",
            "description": "Additional Equipment, tech, and flag requirements that are needed, on top of the use requirements, for every shot fired with this weapon."
          },
          "situational": {
            "$id": "#/properties/weapons/items/properties/situational",
            "type": "boolean",
            "title": "Situational",
            "description": "If true, this weapon's usability depends on situational things, such as room layout. If false, this weapon is always usable when its requirements are met.",
            "default": false
          },
          "hitsGroup": {
            "$id": "#/properties/weapons/items/properties/hitsGroup",
            "type": "boolean",
            "title": "Hits Group",
            "description": "If true, this weapon hits an entire group of enemies with every shot. Only likely to be relevant for weapons with ammo costs.",
            "default": false
          },
          "categories": {
            "$id": "#/properties/weapons/items/properties/categories",
            "type": [
              "array"
            ],
            "title": "Weapon Categories",
            "description": "An array of categories that apply to this weapon. Useful for grouping weapons together in an enemy's weaknesses or invulnerabilities",
            "items": {
              "$id": "#/properties/weapons/items/properties/categories/items",
              "type": "string",
              "enum": [
                "All",
                "Beam",
                "ChargedBeam",
                "UnchargedBeam",
                "UnchargedSpazerBeam",
                "UnchargedIceBeam",
                "BeamNoPlasma",
                "UnchargedBeamNoPlasma",
                "PowerBombBlast",
                "SpecialBeamAttack"
              ],
              "title": "Weapon Category"
            }
          },
          "note": {
            "$ref" : "m3-note.schema.json#/definitions/note",
            "$id": "#/properties/weapons/items/properties/note"
          }
        }
      }
    }
  }
}