-
Notifications
You must be signed in to change notification settings - Fork 2
/
module.json
137 lines (137 loc) · 3.28 KB
/
module.json
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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/Swimminschrage/5e-schema/master/module.json",
"title": "5e Module definition",
"definitions": {
"participant": {
"description": "The description for a creature that is involved as a group or is unique to an encounter.",
"type": "object",
"properties": {
"creature_id": {
"description": "The 'id' of the creature that is a participant.",
"type": "string"
},
"quantity": {
"description": "The number of creatures of the type defined by the 'creature_id' in an encounter.",
"type": "integer",
"minimum": 1,
"default": 1
},
"name": {
"type": "string",
"description": "Override for the name associated with the creature from the creature_id. For example, a named NPC. Leaving blank means to use the name associated with the creature definition."
}
},
"required": [
"creature_id"
]
},
"encounter": {
"description": "A definition for a single encounter made up of a group of creatures.",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"desc": {
"type": "string"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/definitions/participant"
}
}
},
"required": [
"name",
"participants"
]
}
},
"type": "object",
"properties": {
"title": {
"title": "Module Title",
"type": "string",
"description": "The title this json definition is associated with.",
"minLength": 1
},
"desc": {
"title": "Description",
"description": "The description of the module this definition is associated with.",
"type": "string"
},
"license": {
"type": "string"
},
"author": {
"title": "Author(s)",
"description": "Authors of the adventure module this module is represents.",
"type": "string"
},
"organization": {
"type": "string"
},
"version": {
"title": "Version",
"description": "User-friendly string representation of the version of the json file.",
"type": "string"
},
"version_number": {
"title": "Version Number",
"description": "Integer representation of the version of the json file. Used when overriding a previously loaded module.",
"type": "integer"
},
"copyright": {
"type": "string"
},
"url": {
"type": "string"
},
"ogl-lines": {
"type": "array",
"items": {
"type": "string"
}
},
"creatures": {
"$ref": "https://raw.githubusercontent.com/Swimminschrage/5e-schema/master/creatures.json"
},
"spells": {
"$ref": "https://raw.githubusercontent.com/Swimminschrage/5e-schema/master/spells.json"
},
"chapters": {
"description": "A module is broken into chapters. Allows you to group encounters together.",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"title": "Chapter Title",
"type": "string"
},
"desc": {
"title": "Chapter Description",
"type": "string"
},
"encounters": {
"type": "array",
"items": {
"$ref": "#/definitions/encounter"
}
}
},
"required": [
"title"
]
}
}
},
"required": [
"title",
"license",
"version_number",
"copyright"
]
}