sm-json-data/schema/m3-connection.schema.json at master · vg-json-data/sm-json-data · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/vg-json-data/sm-json-data/master/schema/m3-connection.schema.json",
  "type": "object",
  "title": "Super Metroid Connection Pathway Schema",
  "description": "A list of connections between rooms, comprised of two nodes each",
  "properties": {
    "$schema": {
      "type": "string",
      "title": "JSON Schema Path",
      "description": "A path to the definition of this file's JSON schema."
    },
    "connections": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "An object that describes one connection between two Super Metroid rooms",
        "required": ["connectionType", "direction", "nodes"],
        "additionalProperties": false,
        "properties": {
          "connectionType": {
            "type": "string",
            "title": "Connection Type",
            "examples": [
              "HorizontalDoor",
              "VerticalDoor",
              "HorizontalMorphTunnel",
              "VerticalSandpit",
              "Elevator"
            ],
            "enum": [
              "HorizontalDoor",
              "VerticalDoor",
              "HorizontalMorphTunnel",
              "VerticalSandpit",
              "Elevator",
              "StoryMarker"
            ],
            "pattern": "^(.*)$"
          },
          "direction": {
            "type": "string",
            "title": "Connection Direction",
            "description": "Forward means one-way, first node to second node. Bidirectional is both.",
            "examples": ["Bidirectional", "Forward"],
            "enum": ["Bidirectional", "Forward"],
            "pattern": "^(.*)$"
          },
          "description": {
            "type": "string",
            "title": "Connection description",
            "description": "A textual description of the connection",
            "default": "",
            "pattern": "^(.*)$"
          },
          "nodes": {
            "type": "array",
            "title": "Connection nodes",
            "description": "An array of 2 nodes that each represent one end of a Connection. Those nodes are most often doors",
            "minItems": 2,
            "maxItems": 2,
            "items": {
              "type": "object",
              "title": "Connection Node",
              "description": "A node that represents one end of a Connection. This is most often a door",
              "required": ["area", "subarea", "roomid", "roomName", "nodeid", "nodeName", "position"],
              "additionalProperties": false,
              "properties": {
                "area": {
                  "type": "string",
                  "title": "Area Name",
                  "default": "",
                  "examples": ["Brinstar"],
                  "pattern": "^(.*)$"
                },
                "subarea": {
                  "type": "string",
                  "title": "Area Subname",
                  "default": "",
                  "examples": ["Blue"],
                  "pattern": "^(.*)$"
                },
                "roomid": {
                  "type": "integer",
                  "title": "Room ID",
                  "description": "ID of the room in which the node exists",
                  "examples": [38]
                },
                "roomName": {
                  "type": "string",
                  "title": "Room Name",
                  "description": "Name of the room in which the node exists",
                  "examples": ["Landing Site"]
                },
                "nodeid": {
                  "type": "integer",
                  "title": "Node ID",
                  "description": "ID of the node within the room in which it exists",
                  "examples": [1]
                },
                "nodeName": {
                  "type": "string",
                  "title": "Node Name",
                  "description": "Name of the node",
                  "examples": ["Landing Site Top Left Door (to Gauntlet)"]
                },
                "position": {
                  "type": "string",
                  "title": "Node position",
                  "description": "The position of a node within a connection",
                  "examples": ["left", "right", "top", "bottom"],
                  "enum": ["left", "right", "top", "bottom"],
                  "pattern": "^(.*)$"
                },
                "note": {
                  "$ref": "m3-note.schema.json#/definitions/note"
                },
                "devNote": {
                  "$ref": "m3-note.schema.json#/definitions/devNote"
                }
              }
            }
          },
          "note": {
            "$ref": "m3-note.schema.json#/definitions/note"
          },
          "devNote": {
            "$ref": "m3-note.schema.json#/definitions/devNote"
          }
        }
      }
    }
  }
}