TextAdventureJS/textAdventureGameDatabase.schema.json at main · Dak0r/TextAdventureJS · 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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "$id": "https://dak0r.github.io/TextAdventureJS/textAdventureGameDatabase.schema.json",
  "title": "textAdventure Game Database",
  "description": "A game database for textAdventureJS",
  "definitions": {
    "action_definition": {
      "description": "Defines what happens if a verb is used (with this object / in this location)",
      "type": "object",
      "required": ["text", "commands"],
      "properties": {
        "text": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "type": "object",
  "properties": {
    "general": {
      "description": "General Information about this tbe database",
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "author": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "continue_enabled": {
          "type": "boolean"
        },
        "request": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "start": {
          "$ref": "#/definitions/action_definition"
        }
      },
      "parser_parser_ignored_words": {
        "description": "Words that will be ignored when parsing an user input. This prevent that they get interpreted as verbs or objects (Note: Thus objects and names can't have this as on of their 'words')",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "parser_error_text": {
        "type": "string"
      },
      "parser_unknown_verb_text": {
        "type": "string"
      },
      "required": [
        "title",
        "author",
        "version",
        "continue_enabled",
        "request",
        "start",
        "parser_ignored_words",
        "parser_error_text",
        "parser_unknown_verb_text"
      ]
    },
    "verbs": {
      "description": "List of verbs that are available throughout the game",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "required": ["failure", "words", "standalone_action"],
        "properties": {
          "failure": {
            "description": "Shown if the verb is used with an unknown object or the object does not define this action.",
            "type": "string"
          },
          "words": {
            "description": "Alternative words that the player may use",
            "type": "array",
            "items": { "type": "string" },
            "minItems": 1,
            "uniqueItems": true
          },
          "standalone_action": {
            "description": "Run if the verb is used without an object.",
            "$ref": "#/definitions/action_definition"
          }
        }
      }
    },
    "objects": {
      "description": "List of objects that are available throughout the game",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "required": ["words", "locationDescription", "actions"],
        "properties": {
          "words": {
            "description": "Alternative words that the player may use",
            "type": "array",
            "items": { "type": "string" },
            "minItems": 1,
            "uniqueItems": true
          },
          "locationDescription": {
            "type": "string"
          },
          "actions": {
            "description": "List of verbs that can be used with this object and what should happen",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/definitions/action_definition"
            }
          }
        }
      }
    },
    "locations": {
      "description": "List of locations that are available throughout the game",
      "type": "object",
      "additionalProperties": {
        "minProperties": 1,
        "type": "object",
        "required": ["objects"],
        "properties": {
          "objects": {
            "description": "List of objects in this location",
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        }
      }
    }
  },
  "required": ["general", "verbs", "objects", "locations"]
}