-
-
Notifications
You must be signed in to change notification settings - Fork 27
/
run_v1.0.0.json
425 lines (425 loc) · 16.8 KB
/
run_v1.0.0.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
{
"$id": "https://splits.io/schema/run_v1.0.0.json",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Splits.io JSON Schema",
"description": "Splits.io JSON Schema is a specification for the transmission of runs between services and programs.",
"required": ["_schemaVersion", "timer"],
"additionalProperties": false,
"definitions": {
"duration": {
"type": "object",
"title": "Duration",
"description": "Duration holds a realtime duration and a gametime duration.",
"additionalProperties": false,
"properties": {
"realtimeMS": {
"type": "number",
"title": "Realtime (Milliseconds)",
"description": "Realtime (Milliseconds) is a duration of milliseconds in real-world time.",
"examples": [123456, 36000000],
"multipleOf": 1,
"minimum": 0
},
"gametimeMS": {
"type": "number",
"title": "Gametime (Milliseconds)",
"description": "Gametime (Milliseconds) is a duration of milliseconds in game-world time.",
"examples": [123456, 36000000],
"multipleOf": 1,
"minimum": 0
}
}
},
"runTime": {
"type": "object",
"title": "Run Time",
"description": "Run Time represents a moment inside a run, and indicates the duration of the run so far at that moment. It holds a realtime run duration so far and a gametime run duration so far.",
"additionalProperties": false,
"properties": {
"realtimeMS": {
"type": "number",
"title": "Realtime (Milliseconds)",
"description": "Realtime (Milliseconds) is a duration of a run so far in milliseconds.",
"examples": [123456, 36000000],
"multipleOf": 1,
"minimum": 0
},
"gametimeMS": {
"type": "number",
"title": "Gametime (Milliseconds)",
"description": "Gametime (Milliseconds) is a duration a run so far in milliseconds.",
"examples": [123456, 36000000],
"multipleOf": 1,
"minimum": 0
}
}
}
},
"properties": {
"_schemaVersion": {
"type": "string",
"title": "Splits.io JSON Schema Version",
"description": "Schema Version specifies which version of the Splits.io JSON Schema is being used. This schema specifies only v1.0.0.",
"examples": "v1.0.0",
"const": "v1.0.0"
},
"links": {
"type": "object",
"title": "Links",
"description": "Links specifies the run's identity in other services.",
"additionalProperties": false,
"properties": {
"speedruncomID": {
"type": "string",
"title": "Speedrun.com ID",
"description": "Speedrun.com ID is the run's ID on speedrun.com. This can be used to communicate with the speedrun.com API.",
"examples": ["8y8dronz"]
},
"splitsioID": {
"type": "string",
"title": "Splits.io ID",
"description": "Splits.io ID is the run's ID on Splits.io. This can be used to communicate with the Splits.io API.",
"examples": ["oqt"]
}
}
},
"timer": {
"type": "object",
"title": "Timer",
"description": "Timer holds information about the timer used to record the run.",
"required": ["shortname", "longname", "version"],
"additionalProperties": false,
"properties": {
"shortname": {
"type": "string",
"title": "Shortname",
"description": "Shortname is a machine-readable timer name, intended for use in APIs, databases, URLs, and filenames.",
"examples": ["livesplit", "wsplit", "timesplittracker", "llanfair", "llanfair_gered"]
},
"longname": {
"type": "string",
"title": "Longname",
"description": "Longname is a human-readable timer name, intended for display to users.",
"examples": ["LiveSplit", "WSplit", "Time Split Tracker", "Llanfair", "Llanfair (Gered's Fork)"]
},
"version": {
"type": "string",
"title": "Version",
"description": "Version is the version of the timer used to record this run. Semantic Versioning is strongly recommended but not enforced.",
"examples": ["v1.0", "v3.1.4", "v2.3.4-alpha1"]
},
"website": {
"type": "string",
"title": "Website",
"description": "Website is the URL for the timer's website.",
"examples": ["http://livesplit.org"],
"format": "uri"
}
}
},
"attempts": {
"type": "object",
"title": "Attempts",
"description": "Attempts contains historical information about previous runs by this runner in this category.",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"title": "Total",
"description": "Total holds the total number of attempts for this category.",
"examples": [1, 12, 241, 1023],
"multipleOf": 1,
"minimum": 0
},
"histories": {
"type": "array",
"title": "Histories",
"description": "Histories is an array of previous attempts by this runner of this category.",
"default": [],
"items": {
"type": "object",
"title": "History",
"description": "History is a single recorded attempt of this category by this runner.",
"required": ["attemptNumber"],
"additionalProperties": false,
"properties": {
"attemptNumber": {
"type": "integer",
"title": "Attempt Number",
"description": "Attempt Number is the number of lifetime attempts the runner will have made after this one. The Attempt Number for an attempt is a label, not an index; the first attempt for a category has an Attempt Number of 1 (not 0)."
},
"duration": {"$ref": "#/definitions/duration"}
}
}
}
}
},
"imageURL": {
"type": "string",
"title": "Image URL",
"description": "Image URL is the location of an image associated with this run. Often this is a screenshot of the timer at run completion, but can be anything the runner wants displayed alongside the run.",
"examples": ["https://i.imgur.com/ebyjwLJ.jpg"],
"format": "uri"
},
"videoURL": {
"type": "string",
"title": "Video URL",
"description": "Video URL is the location of a VOD of the run.",
"examples": ["https://www.youtube.com/watch?v=0No0y9C1tmM", "https://www.twitch.tv/videos/180016373"],
"format": "uri"
},
"startedAt": {
"type": "string",
"title": "Started At",
"description": "Started At is the date and time at which the run was started, specified in RFC 3339 format.",
"examples": ["2002-10-02T10:00:00-05:00", "2002-10-02T15:00:00Z", "2002-10-02T15:00:00.05Z"],
"format": "date-time"
},
"endedAt": {
"type": "string",
"title": "Ended At",
"description": "Ended At is the date and time at which the run was ended, specified in RFC 3339 format.",
"examples": ["2002-10-02T11:00:00-05:00", "2002-10-02T16:00:00Z", "2002-10-02T16:00:00.05Z"],
"format": "date-time"
},
"pauses": {
"type": "array",
"title": "Pauses",
"description": "Pauses holds runner-caused pauses that took place during the run.",
"items": {
"type": "object",
"title": "Pause",
"description": "Pause is a single pause that took place during the run.",
"required": ["startedAt"],
"additionalProperties": false,
"properties": {
"startedAt": {
"type": "string",
"title": "Started At",
"description": "Started At is the date and time at which the pause was started, specified in RFC 3339 format.",
"examples": ["2002-10-02T10:00:00-05:00", "2002-10-02T15:00:00Z", "2002-10-02T15:00:00.05Z"],
"format": "date-time"
},
"endedAt": {
"type": "string",
"title": "Ended At",
"description": "Ended At is the date and time at which the pause was ended, specified in RFC 3339 format.",
"examples": ["2002-10-02T11:00:00-05:00", "2002-10-02T16:00:00Z", "2002-10-02T16:00:00.05Z"],
"format": "date-time"
}
}
}
},
"game": {
"type": "object",
"title": "Game",
"description": "Game specifies information about the game being run.",
"required": ["longname"],
"additionalProperties": false,
"properties": {
"longname": {
"type": "string",
"title": "Longname",
"description": "Longname is a human-readable game name, intended for display to users.",
"examples": ["Super Mario Sunshine", "The Legend of Zelda: Ocarina of Time", "Portal"]
},
"shortname": {
"type": "string",
"title": "Shortname",
"description": "Shortname is a machine-readable game name, intended for use in APIs, databases, URLs, and filenames.",
"examples": ["sms", "oot", "portal"]
},
"links": {
"type": "object",
"title": "Links",
"description": "Links specifies the game's identity in other services.",
"additionalProperties": false,
"default": {},
"properties": {
"splitsioID": {
"type": "string",
"title": "Splits.io ID",
"description": "Splits.io ID specifies the game's Splits.io ID.",
"examples": ["234"]
},
"speedruncomID": {
"type": "string",
"title": "Speedrun.com ID",
"description": "Speedrun.com ID specifies the game's speedrun.com ID.",
"examples": ["kjpdr4jq"]
}
}
}
}
},
"category": {
"type": "object",
"title": "Category",
"description": "Category specifies information about the category being run.",
"required": ["longname"],
"additionalProperties": false,
"properties": {
"longname": {
"type": "string",
"title": "Longname",
"description": "Longname is a human-readable category name, intended for display to users.",
"examples": ["Any%", "100%", "Any% Hoverless"]
},
"shortname": {
"type": "string",
"title": "Shortname",
"description": "Shortname is a machine-readable category name, intended for use in APIs, databases, URLs, and filenames.",
"examples": ["anypct", "100pct", "anypct-hoverless"]
},
"links": {
"type": "object",
"title": "Links",
"description": "Links specifies the category's identity in other services.",
"additionalProperties": false,
"default": {},
"properties": {
"splitsioID": {
"type": "string",
"title": "Splits.io ID",
"description": "Splits.io ID specifies the category's Splits.io ID.",
"examples": ["234"]
},
"speedruncomID": {
"type": "string",
"title": "Speedrun.com ID",
"description": "Speedrun.com ID specifies the category's speedrun.com ID.",
"examples": ["kjpdr4jq"]
}
}
}
}
},
"runners": {
"type": "array",
"title": "Runners",
"description": "Runners is an array of people who participated in this run. Some games and categories call for cooperative play, but otherwise this will usually be just one person.",
"default": [],
"items": {
"type": "object",
"title": "Runner",
"description": "Runner describes one participant in the recorded run.",
"required": ["shortname"],
"additionalProperties": false,
"properties": {
"longname": {
"type": "string",
"title": "Longname",
"description": "Longname is a human-readable runner name, intended for display to users.",
"examples": ["Glacials"]
},
"shortname": {
"type": "string",
"title": "Shortname",
"description": "Shortname is a machine-readable runner name, intended for use in APIs, databases, URLs, and filenames.",
"examples": ["glacials"]
},
"links": {
"type": "object",
"title": "Links",
"description": "Links specifies the runner's identity in other services.",
"additionalProperties": false,
"default": {},
"properties": {
"twitchID": {
"type": "string",
"title": "Twitch ID",
"description": "Twitch ID specifies the runner's Twitch ID.",
"examples": ["29798286"]
},
"splitsioID": {
"type": "string",
"title": "Splits.io ID",
"description": "Splits.io ID specifies the runner's Splits.io ID.",
"examples": ["234"]
},
"speedruncomID": {
"type": "string",
"title": "Speedrun.com ID",
"description": "Speedrun.com ID specifies the runner's speedrun.com ID.",
"examples": ["kjpdr4jq"]
},
"twitterID": {
"type": "string",
"title": "Twitter ID",
"description": "Twitter ID specifies the runner's Twitter ID.",
"examples": ["119476949"]
}
}
}
}
}
},
"segments": {
"type": "array",
"title": "Segments",
"description": "Segments is an array of all segments for this run, ordered from first to last.",
"items": {
"type": "object",
"title": "Segment",
"description": "Segment is one segment in this run.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name is the runner-provided name of this segment",
"examples": ["World 1-2", "Epilogue", "Bottle"]
},
"endedAt": {"$ref": "#/definitions/runTime"},
"bestDuration": {"$ref": "#/definitions/duration"},
"isSkipped": {
"type": "boolean",
"title": "Is Skipped",
"description": "Is Skipped should be true if the runner skipped over the split that ends this segment, rather than splitting. If so, this segment's Ended At is ignored.",
"default": false
},
"isReset": {
"type": "boolean",
"title": "Is Reset",
"description": "Is Reset should be true if the runner reset the run during this segment. If so, this and all future segments' Ended Ats for this run are ignored.",
"default": false
},
"histories": {
"type": "array",
"title": "Histories",
"description": "Histories is an array of previous completions of this segment by this runner.",
"default": [],
"items": {
"type": "object",
"title": "History",
"description": "History is a single recorded attempt of this segment by this runner.",
"required": ["attemptNumber"],
"additionalProperties": false,
"properties": {
"attemptNumber": {
"type": "integer",
"title": "Attempt Number",
"description": "Attempt Number is the number of lifetime attempts the runner will have made on this category after this one. Generally these attempt numbers should correspond to those in Attempts -> History, although a number given here may not be present there if the run was reset before completion."
},
"endedAt": {"$ref": "#/definitions/runTime"},
"isSkipped": {
"type": "boolean",
"title": "Is Skipped",
"description": "Is Skipped should be true if the runner skipped over the split that ends this segment, rather than splitting. If so, this segment's Ended At is ignored.",
"default": false
},
"isReset": {
"type": "boolean",
"title": "Is Reset",
"description": "Is Reset should be true if the runner reset the run during this segment. If so, this and all future segments' Ended Ats for this run are ignored.",
"default": false
}
}
}
}
}
}
}
}
}